com.atlassian.crowd.upgrade.tasks
Interface UpgradeTask

All Known Implementing Classes:

UpgradeTask001, UpgradeTask002, UpgradeTask003, UpgradeTask112, UpgradeTask113, UpgradeTask114, UpgradeTask210, UpgradeTask211, UpgradeTask212, UpgradeTask214, UpgradeTask215, UpgradeTask216, UpgradeTask320, UpgradeTask321, UpgradeTask322, UpgradeTask342, UpgradeTask360, UpgradeTask361, UpgradeTask395, UpgradeTask396, UpgradeTask397, UpgradeTask420, UpgradeTask421, UpgradeTask422, UpgradeTask423, UpgradeTask424, UpgradeTask425, UpgradeTask426, UpgradeTask427, UpgradeTask428, UpgradeTask429

public interface UpgradeTask

An upgrade task for Crowd Please make sure when implementing an upgrade task that you write it in such a way as it can be run again and not corrupt the Crowd data on a second, third run.

Method Summary

void	doUpgrade() Perform the upgrade.
java.lang.String	getBuildNumber()
java.util.Collection<java.lang.String>	getErrors() Any errors that occur during the upgrade process will be added to this Collection as Strings.
java.lang.String	getShortDescription() A short (<50 chars) description of the upgrade action

Method Detail

getBuildNumber

java.lang.String getBuildNumber()

Returns:

The build number that this upgrade is applicable to.

getShortDescription

java.lang.String getShortDescription()

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

Returns:

description of upgrade task.

doUpgrade

void doUpgrade()
               throws java.lang.Exception

Perform the upgrade.

Throws:

java.lang.Exception - is thrown if any errors occur during the upgrade process.

getErrors

java.util.Collection<java.lang.String> getErrors()

Any errors that occur during the upgrade process will be added to this Collection as Strings.

Returns:

a Collection of errors. This may return an empty Collection.