com.atlassian.confluence.plugins.createcontent.upgrade

Class GlobalBlueprintsUpgradeTask

java.lang.Object

com.atlassian.confluence.plugins.createcontent.upgrade.GlobalBlueprintsUpgradeTask

All Implemented Interfaces:

com.atlassian.sal.api.upgrade.PluginUpgradeTask

public class GlobalBlueprintsUpgradeTask
extends Object
implements com.atlassian.sal.api.upgrade.PluginUpgradeTask

Persists global-level user-customised blueprints state after upgrade. - Globally disabled blueprints are persisted in Bandana an enabled in the plugin system. - Globally user-customised blueprints.

Note: The reason of combining the above tasks is... When we are upgrading Global Blueprints and sorting through the disabled ones, we are creating clones for them and adding that to Bandana. However, if the global blueprints have been edited, we want to store the UUID of the customised global blueprint and not the clone UUID. Before combining the upgrade tasks, only template edited upgrade task knew about which templates were edited, and creates the customised global blueprint. At this point, if the blueprint is disabled, the Bandana entry will need to be modified. Due of this coupling of customisation and disabling of global bps, we decided to combine the upgrade tasks.

Constructor Summary

Constructors

Constructor and Description
GlobalBlueprintsUpgradeTask(com.atlassian.plugin.PluginAccessor pluginAccessor, ContentBlueprintManager contentBlueprintManager, com.atlassian.plugin.PluginController pluginController, TemplateUpdater templateUpdater, BlueprintStateController blueprintStateController, PluginPageTemplateHelper pluginPageTemplateHelper)

Method Summary

Modifier and Type	Method and Description
Collection<com.atlassian.sal.api.message.Message>	doUpgrade()
int	getBuildNumber() The build number for this upgrade task.
String	getPluginKey()
String	getShortDescription()

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalBlueprintsUpgradeTask

public GlobalBlueprintsUpgradeTask(com.atlassian.plugin.PluginAccessor pluginAccessor,
                                   ContentBlueprintManager contentBlueprintManager,
                                   com.atlassian.plugin.PluginController pluginController,
                                   TemplateUpdater templateUpdater,
                                   BlueprintStateController blueprintStateController,
                                   PluginPageTemplateHelper pluginPageTemplateHelper)

Method Detail

getBuildNumber

public int getBuildNumber()

The build number for this upgrade task. Once this upgrade task has run the plugin manager will store this build number against this plugin type. After this only upgrade tasks with higher build numbers will be run

Specified by:

getBuildNumber in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

doUpgrade

public Collection<com.atlassian.sal.api.message.Message> doUpgrade()

Specified by:

doUpgrade in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask

getPluginKey

public String getPluginKey()

Specified by:

getPluginKey in interface com.atlassian.sal.api.upgrade.PluginUpgradeTask