com.atlassian.jira.upgrade
Interface UpgradeManager

All Known Implementing Classes:

UpgradeManagerImpl

public interface UpgradeManager

Method Summary

Collection<String>	doSetupUpgrade() Performs any upgrades that may be needed as a result of the Setup procedure of JIRA Get the set of setupUpgradeNumbers which are to be performed for this setup.
Collection<String>	doUpgradeIfNeededAndAllowed(String backupPath) Performs the upgrade if one is required and the license is not too old to proceed with the upgrade.
String	getExportFilePath() Export path of the last backup performed by this manager
List<UpgradeHistoryItem>	getUpgradeHistory()

Method Detail

doSetupUpgrade

Collection<String> doSetupUpgrade()

Performs any upgrades that may be needed as a result of the Setup procedure of JIRA

Get the set of setupUpgradeNumbers which are to be performed for this setup.

Iterate over these numbers and if either of the standard, professional or enterprise upgrade maps contains an UpgradeTask with this number then do the upgrade

If errors are found, it will cancel the upgrade, and return the list of errors.

For each upgrade that happens successfully, it will increment the build number in the database, so that if one fails, you do not have to repeat all the upgrades that have already run.

If there are no errors from the upgrade, the build number in the database is incremented to the current build number. This is because there may be no upgrades for a particular version & needUpgrade() checks build no in database.

Returns:

list of errors that occured during the upgrade process

doUpgradeIfNeededAndAllowed

Collection<String> doUpgradeIfNeededAndAllowed(@Nullable
                                               String backupPath)
                                               throws IllegalXMLCharactersException

Performs the upgrade if one is required and the license is not too old to proceed with the upgrade.

Parameters:

backupPath - - a path to the default location of the export, may be null, in which case no auto export will be performed

Returns:

a list of errors that occurred during the upgrade

Throws:

IllegalXMLCharactersException - if backup was impossible due to invalid XML characters

getExportFilePath

String getExportFilePath()

Export path of the last backup performed by this manager

Returns:

path to the last backup file

getUpgradeHistory

List<UpgradeHistoryItem> getUpgradeHistory()

Returns:

the history of upgrades performed on this instance of JIRA in reverse chronological order

Since:

v4.1