com.atlassian.jira.upgrade

Interface UpgradeManager

All Known Implementing Classes:

UpgradeManagerImpl

public interface UpgradeManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UpgradeManager.Status Status of the upgrade process

Method Summary

Modifier and Type	Method and Description
boolean	areDelayedUpgradesRunning() Returns true if a scheduled upgrade is in progress.
UpgradeManager.Status	doUpgradeIfNeededAndAllowed(String backupPath, UpgradeManagerParams upgradeManagerParams) 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
com.atlassian.scheduler.status.RunDetails	getLastUpgradeResult()
int	getPendingDelayedUpgradeCount()
List<UpgradeHistoryItem>	getUpgradeHistory()
boolean	hasUpgradeTaskRun(Class<? extends UpgradeTask> clazz) Return true if the upgrade task implemented in the parameter class has completed successfully..
UpgradeManager.Status	scheduleDelayedUpgrades(int delayMins, boolean isAllowReindex) Schedules the execution of delayed upgrades.

Method Detail

getPendingDelayedUpgradeCount

int getPendingDelayedUpgradeCount()

Returns:

the number of pending delayed upgrades.

scheduleDelayedUpgrades

@Nonnull
UpgradeManager.Status scheduleDelayedUpgrades(int delayMins,
                                                       boolean isAllowReindex)

Schedules the execution of delayed upgrades.

Parameters:

delayMins - the amount of time in minutes to wait before executing the delayed upgrades.

isAllowReindex - set this to true to allow any required reindex to be done.

Returns:

the status of the upgrade process.

Since:

6.4

areDelayedUpgradesRunning

boolean areDelayedUpgradesRunning()

Returns true if a scheduled upgrade is in progress.

Returns:

if a scheduled upgrade is in progress.

Since:

6.4

getLastUpgradeResult

com.atlassian.scheduler.status.RunDetails getLastUpgradeResult()

doUpgradeIfNeededAndAllowed

UpgradeManager.Status doUpgradeIfNeededAndAllowed(@Nullable
                                                  String backupPath,
                                                  UpgradeManagerParams upgradeManagerParams)
                                           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

upgradeManagerParams - contain information needed to upgrade process

Returns:

status of the upgrade process

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

hasUpgradeTaskRun

boolean hasUpgradeTaskRun(Class<? extends UpgradeTask> clazz)

Return true if the upgrade task implemented in the parameter class has completed successfully.. Note: We use the class as the parameter to help when tasks are refactored and reordered etc.

Parameters:

clazz - The Upgrade Task's implementing class.

Since:

v6.4