com.atlassian.confluence.upgrade.upgradetask
Class UserMacroConfigFormatUpgradeTask

java.lang.Object
  extended by com.atlassian.confluence.upgrade.upgradetask.UserMacroConfigFormatUpgradeTask
All Implemented Interfaces:
DatabaseUpgradeTask, UpgradeTask

public class UserMacroConfigFormatUpgradeTask
extends java.lang.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.
 java.lang.String getBuildNumber()
           
 java.util.Collection<UpgradeError> getErrors()
          Return any errors that occur.
 java.lang.String getShortDescription()
          A short (<50 chars) description of the upgrade action
 void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
           
 
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 java.lang.String getBuildNumber()
Specified by:
getBuildNumber in interface UpgradeTask
Returns:
The build number that this upgrade is applicable to

getShortDescription

public java.lang.String getShortDescription()
Description copied from interface: UpgradeTask
A short (<50 chars) description of the upgrade action

Specified by:
getShortDescription in interface UpgradeTask

doUpgrade

public void doUpgrade()
               throws java.lang.Exception
Description copied from interface: UpgradeTask
Perform the upgrade.

Specified by:
doUpgrade in interface UpgradeTask
Throws:
java.lang.Exception

getErrors

public java.util.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.

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)


Copyright © 2003-2011 Atlassian. All Rights Reserved.