Interface WikiMacroInitializer


  • @Role
    public interface WikiMacroInitializer
    Responsible for registering wiki macros against the ComponentManager at XE startup.
    Since:
    2.0M2
    Version:
    $Id: b85cd41c1ffb9454074d1084ac022a914c213c81 $
    • Method Detail

      • installOrUpgradeWikiMacroClasses

        void installOrUpgradeWikiMacroClasses()
                                       throws Exception
        Installs or upgrades xwiki classes required for defining wiki macros.
        Throws:
        Exception - if an error occurs while installing / upgrading classes.
      • registerExistingWikiMacros

        void registerExistingWikiMacros()
                                 throws Exception
        Searches for all the wiki macro definitions on the system and registers them against the macro manager.
        Throws:
        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​(String wiki)
                                 throws 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:
        Exception - if xwiki classes required for defining wiki macros are missing or if an error occurs while searching for existing wiki macros.