org.xwiki.rendering.macro.wikibridge
Interface WikiMacroInitializer

@ComponentRole
public interface WikiMacroInitializer

Responsible for registering wiki macros against the ComponentManager at XE startup.

Since:

2.0M2

Version:

$Id$

Method Summary

void	installOrUpgradeWikiMacroClasses() Installs or upgrades xwiki classes required for defining wiki macros.
void	registerExistingWikiMacros() Searches for all the wiki macro definitions on the system and registers them against the macro manager.
void	registerExistingWikiMacros(java.lang.String wiki) Searches for all the wiki macro definitions in the specified wiki and registers them against the macro manager.

Method Detail

installOrUpgradeWikiMacroClasses

void installOrUpgradeWikiMacroClasses()
                                      throws java.lang.Exception

Installs or upgrades xwiki classes required for defining wiki macros.

Throws:

java.lang.Exception - if an error occurs while installing / upgrading classes.

registerExistingWikiMacros

void registerExistingWikiMacros()
                                throws java.lang.Exception

Searches for all the wiki macro definitions on the system and registers them against the macro manager.

Throws:

java.lang.Exception - if xwiki classes required for defining wiki macros are missing or if an error occurs while searching for existing wiki macros.

registerExistingWikiMacros

void registerExistingWikiMacros(java.lang.String wiki)
                                throws java.lang.Exception

Searches for all the wiki macro definitions in the specified wiki and registers them against the macro manager.

Parameters:

wiki - the name of the wiki to register wiki macros for

Throws:

java.lang.Exception - if xwiki classes required for defining wiki macros are missing or if an error occurs while searching for existing wiki macros.