com.atlassian.jira.upgrade

Class UpgradeManagerImpl

java.lang.Object

com.atlassian.jira.upgrade.UpgradeManagerImpl

All Implemented Interfaces:

Startable, UpgradeManager

public class UpgradeManagerImpl
extends Object
implements UpgradeManager, Startable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UpgradeManagerImpl.Upgrades

Nested classes/interfaces inherited from interface com.atlassian.jira.upgrade.UpgradeManager

UpgradeManager.Status

Field Summary

Fields

Modifier and Type	Field and Description
static com.atlassian.scheduler.config.JobId	JOB_ID
static com.atlassian.scheduler.config.JobRunnerKey	JOB_RUNNER_KEY

Constructor Summary

Constructors

Constructor and Description

UpgradeManagerImpl(JiraLicenseService jiraLicenseService, BuildUtilsInfo buildUtilsInfo, I18nHelper.BeanFactory i18HelperFactory, ApplicationProperties applicationProperties, BuildVersionRegistry buildVersionRegistry, com.atlassian.event.api.EventPublisher eventPublisher, OfBizDelegator ofBizDelegator, IndexLifecycleManager indexManager, FeatureManager featureManager, DowngradeUtilsImpl downgradeUtilsInfo, ReindexMessageManager reindexMessageManager, ReindexRequestManager reindexRequestManager, com.atlassian.scheduler.SchedulerService schedulerService, com.atlassian.scheduler.SchedulerHistoryService schedulerHistoryService, EntityEngine entityEngine, com.atlassian.beehive.ClusterLockService clusterLockService, BuildVersionLicenseCheck licenseCheck, UpgradeConstraints upgradeContstraints)

Method Summary

Modifier and Type	Method and Description
void	addUpgrade(UpgradeTask task)
boolean	areDelayedUpgradesRunning() Returns true if a scheduled upgrade is in progress.
UpgradeManager.Status	doUpgrade(UpgradeManagerParams upgradeManagerParams) Gets all the upgrades (standard, professional and enterprise) that need to be run from the build number stored in the database to the current build number
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.
protected AutoExport	getAutoExport(String defaultBackupPath)
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..
void	onClearCache(ClearCacheEvent event)
UpgradeManager.Status	scheduleDelayedUpgrades(int delayMins, boolean isAllowReindex) Schedules the execution of delayed upgrades.
void	start() This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JOB_RUNNER_KEY

public static final com.atlassian.scheduler.config.JobRunnerKey JOB_RUNNER_KEY

JOB_ID

public static final com.atlassian.scheduler.config.JobId JOB_ID

Constructor Detail

UpgradeManagerImpl

@Inject
public UpgradeManagerImpl(JiraLicenseService jiraLicenseService,
                                  BuildUtilsInfo buildUtilsInfo,
                                  I18nHelper.BeanFactory i18HelperFactory,
                                  ApplicationProperties applicationProperties,
                                  BuildVersionRegistry buildVersionRegistry,
                                  com.atlassian.event.api.EventPublisher eventPublisher,
                                  OfBizDelegator ofBizDelegator,
                                  IndexLifecycleManager indexManager,
                                  FeatureManager featureManager,
                                  DowngradeUtilsImpl downgradeUtilsInfo,
                                  ReindexMessageManager reindexMessageManager,
                                  ReindexRequestManager reindexRequestManager,
                                  com.atlassian.scheduler.SchedulerService schedulerService,
                                  com.atlassian.scheduler.SchedulerHistoryService schedulerHistoryService,
                                  EntityEngine entityEngine,
                                  com.atlassian.beehive.ClusterLockService clusterLockService,
                                  BuildVersionLicenseCheck licenseCheck,
                                  UpgradeConstraints upgradeContstraints)

Method Detail

start

public void start()
           throws Exception

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

Throws:

Exception - Allows implementations to throw an Exception.

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

doUpgradeIfNeededAndAllowed

public UpgradeManager.Status doUpgradeIfNeededAndAllowed(@Nullable
                                                         String backupPath,
                                                         UpgradeManagerParams upgradeManagerParams)
                                                  throws IllegalXMLCharactersException

Description copied from interface: UpgradeManager

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

Specified by:

doUpgradeIfNeededAndAllowed in interface UpgradeManager

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

getAutoExport

protected AutoExport getAutoExport(String defaultBackupPath)

doUpgrade

public UpgradeManager.Status doUpgrade(UpgradeManagerParams upgradeManagerParams)

Gets all the upgrades (standard, professional and enterprise) that need to be run from the build number stored in the database to the current build number

Get the set of upgradeNumbers which are to be performed for this upgrade.

Get the Maps of relevant upgrades using {#getRelevantUpgradesFromList}

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

If errors are found, it will cancel the upgrade, and list errors to the console.

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.

Parameters:

upgradeManagerParams - contain information needed to upgrade process

Returns:

a collection of error messages

getPendingDelayedUpgradeCount

public int getPendingDelayedUpgradeCount()

Specified by:

getPendingDelayedUpgradeCount in interface UpgradeManager

Returns:

the number of pending delayed upgrades.

scheduleDelayedUpgrades

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

Description copied from interface: UpgradeManager

Schedules the execution of delayed upgrades.

Specified by:

scheduleDelayedUpgrades in interface UpgradeManager

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.

areDelayedUpgradesRunning

public boolean areDelayedUpgradesRunning()

Description copied from interface: UpgradeManager

Returns true if a scheduled upgrade is in progress.

Specified by:

areDelayedUpgradesRunning in interface UpgradeManager

Returns:

if a scheduled upgrade is in progress.

getLastUpgradeResult

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

Specified by:

getLastUpgradeResult in interface UpgradeManager

addUpgrade

public void addUpgrade(@Nonnull
                       UpgradeTask task)

getExportFilePath

public String getExportFilePath()

Description copied from interface: UpgradeManager

Export path of the last backup performed by this manager

Specified by:

getExportFilePath in interface UpgradeManager

Returns:

path to the last backup file

getUpgradeHistory

public List<UpgradeHistoryItem> getUpgradeHistory()

Specified by:

getUpgradeHistory in interface UpgradeManager

Returns:

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

hasUpgradeTaskRun

public boolean hasUpgradeTaskRun(Class<? extends UpgradeTask> clazz)

Description copied from interface: UpgradeManager

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.

Specified by:

hasUpgradeTaskRun in interface UpgradeManager

Parameters:

clazz - The Upgrade Task's implementing class.