com.atlassian.confluence.macro.xhtml

Class DefaultMacroMigrationManager

java.lang.Object

com.atlassian.confluence.macro.xhtml.DefaultMacroMigrationManager

All Implemented Interfaces:

MacroMigrationManager

public class DefaultMacroMigrationManager
extends Object
implements MacroMigrationManager

Listens for plugin events and registers / unregisters the macro migration tasks with itself.

The migration tasks are wrapped in a LazyReference in order to only instantiate them upon first usage.

This MacroMigrationManager uses a white list of macro names that may be migrated. The default set of names is supplied on construction and additional names are read as comma separated values from the System property "confluence.macro.migration.white.list".

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
DefaultMacroMigrationManager(MacroMigration richTextMacroMigration, MacroMigration plainTextMacroMigration, MacroMigration v2MacroToUnmigratedWikiMarkupMacroMigration, MacroManager xhtmlOnlyMacroManager, MacroManager v2CompatibileMacroManager, MacroManager v2MacroManager, Set<String> whitelistedNames) Sets the macro manager and the migration tasks for the rich text and plain text migrations.

Method Summary

Modifier and Type	Method and Description
MacroMigration	getMacroMigration(String macroName) Returns the MacroMigration for the given macro.
void	pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)
void	pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)
void	setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMacroMigrationManager

public DefaultMacroMigrationManager(MacroMigration richTextMacroMigration,
                                    MacroMigration plainTextMacroMigration,
                                    MacroMigration v2MacroToUnmigratedWikiMarkupMacroMigration,
                                    MacroManager xhtmlOnlyMacroManager,
                                    MacroManager v2CompatibileMacroManager,
                                    MacroManager v2MacroManager,
                                    Set<String> whitelistedNames)

Sets the macro manager and the migration tasks for the rich text and plain text migrations.

Method Detail

getMacroMigration

public MacroMigration getMacroMigration(String macroName)

Description copied from interface: MacroMigrationManager

Returns the MacroMigration for the given macro.

If a custom MacroMigration is registered for this macro name it will be returned, otherwise if the macro implements the Macro interface it will return a MacroMigration based on the type of macro.

Specified by:

getMacroMigration in interface MacroMigrationManager

Returns:

a macro migration. Cannot be null.

pluginModuleEnabled

public void pluginModuleEnabled(com.atlassian.plugin.event.events.PluginModuleEnabledEvent event)

pluginModuleDisabled

public void pluginModuleDisabled(com.atlassian.plugin.event.events.PluginModuleDisabledEvent event)

setPluginEventManager

public void setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)