com.atlassian.crowd.upgrade
Interface UpgradeManager

All Known Implementing Classes:

UpgradeManagerImpl

public interface UpgradeManager

This manager is responsible for all things related to upgrades for Crowd. Upgrades are performed by UpgradeTask's and are associated to a given build number.

Method Summary

java.util.Collection<java.lang.String>	doUpgrade() Method to fire off the upgrade process
int	getDataBuildNumber() This gets the pre-build number.
java.util.List<UpgradeTask>	getRequiredUpgrades()
boolean	needUpgrade() Determines whether we need to run the upgrade or not.

Method Detail

needUpgrade

boolean needUpgrade()

Determines whether we need to run the upgrade or not.

Returns:

boolean whether the build was successful or not

getRequiredUpgrades

java.util.List<UpgradeTask> getRequiredUpgrades()

Returns:

list of upgrade tasks that are required to be executed (in order).

doUpgrade

java.util.Collection<java.lang.String> doUpgrade()
                                                 throws java.lang.Exception

Method to fire off the upgrade process

Returns:

Collection a string collection of error messages. Collection not empty denotes error occurred on upgrade

Throws:

java.lang.Exception - error occured during upgrade.

getDataBuildNumber

int getDataBuildNumber()

This gets the pre-build number. i.e The build number present in the database, BEFORE the upgrade process has been run.

Returns:

the current build number (in data store)