com.atlassian.confluence.upgrade.upgradetask
Class UserMacroConfigFormatUpgradeTask

java.lang.Object
  com.atlassian.confluence.upgrade.upgradetask.UserMacroConfigFormatUpgradeTask

All Implemented Interfaces:

DatabaseUpgradeTask, UpgradeTask

public class UserMacroConfigFormatUpgradeTask
extends Object
implements DatabaseUpgradeTask

Update old pre 1.4 user macros that were stored as strings. Note that this was previously done UserMacroLibrary, but we now do it in this upgrade task.

Constructor Summary

UserMacroConfigFormatUpgradeTask()

Method Summary

void	doNonDatabaseUpgrade() Perform any non-database related parts of the upgrade task.
void	doUpgrade() Perform the upgrade.
String	getBuildNumber()
Collection<UpgradeError>	getErrors() Return any errors that occur.
String	getShortDescription() A short (<50 chars) description of the upgrade action
void	nonDatabaseValidate() Validate any non-database related parts of the upgrade task.
void	setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
void	validate() Validates that this upgrade task can be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserMacroConfigFormatUpgradeTask

public UserMacroConfigFormatUpgradeTask()

Method Detail

getBuildNumber

public String getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTask

Returns:

The build number that this upgrade is applicable to

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTask

A short (<50 chars) description of the upgrade action

Specified by:

getShortDescription in interface UpgradeTask

validate

public void validate()

Description copied from interface: UpgradeTask

Validates that this upgrade task can be performed.

Specified by:

validate in interface UpgradeTask

doUpgrade

public void doUpgrade()
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:

doUpgrade in interface UpgradeTask

Throws:

Exception

getErrors

public Collection<UpgradeError> getErrors()

Description copied from interface: UpgradeTask

Return any errors that occur. Each entry is an UpgradeError.

Specified by:

getErrors in interface UpgradeTask

Returns:

a collection of UpgradeError objects, sometimes null.

nonDatabaseValidate

public void nonDatabaseValidate()

Description copied from interface: DatabaseUpgradeTask

Validate any non-database related parts of the upgrade task.

Specified by:

nonDatabaseValidate in interface DatabaseUpgradeTask

doNonDatabaseUpgrade

public void doNonDatabaseUpgrade()

Description copied from interface: DatabaseUpgradeTask

Perform any non-database related parts of the upgrade task. If the upgrade manager determines that the database has already been upgraded, it will call this method instead of UpgradeTask.doUpgrade(). This allows the upgrade task to perform any local non-db cleanup that might be involved in the upgrade.

Specified by:

doNonDatabaseUpgrade in interface DatabaseUpgradeTask

setBandanaManager

public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)