com.atlassian.jira.upgrade

Interface UpgradeTask

All Known Implementing Classes:

AbstractDelayableUpgradeTask, AbstractImmediateUpgradeTask, AbstractNotificationSchemeUpgradeTask, AbstractReindexUpgradeTask, AbstractUpgradeTask, DropIndexTask, FailingUpgradeTaskForTesting, LegacyImmediateUpgradeTask, UpgradeTask_Build509, UpgradeTask_Build520, UpgradeTask_Build551, UpgradeTask_Build552, UpgradeTask_Build554, UpgradeTask_Build571, UpgradeTask_Build572, UpgradeTask_Build6001, UpgradeTask_Build6005, UpgradeTask_Build6006, UpgradeTask_Build6007, UpgradeTask_Build601, UpgradeTask_Build602, UpgradeTask_Build603, UpgradeTask_Build6038, UpgradeTask_Build6039, UpgradeTask_Build6040, UpgradeTask_Build6041, UpgradeTask_Build6042, UpgradeTask_Build6044, UpgradeTask_Build6045, UpgradeTask_Build6047, UpgradeTask_Build605, UpgradeTask_Build606, UpgradeTask_Build608, UpgradeTask_Build6081, UpgradeTask_Build6083, UpgradeTask_Build6085, UpgradeTask_Build6096, UpgradeTask_Build6100, UpgradeTask_Build6121, UpgradeTask_Build6122, UpgradeTask_Build6123, UpgradeTask_Build6124, UpgradeTask_Build6128, UpgradeTask_Build6129, UpgradeTask_Build6130, UpgradeTask_Build6131, UpgradeTask_Build6132, UpgradeTask_Build6133, UpgradeTask_Build6134, UpgradeTask_Build6135, UpgradeTask_Build6136, UpgradeTask_Build6137, UpgradeTask_Build6138, UpgradeTask_Build6139, UpgradeTask_Build6140, UpgradeTask_Build6141, UpgradeTask_Build6142, UpgradeTask_Build6151, UpgradeTask_Build6152, UpgradeTask_Build6153, UpgradeTask_Build6154, UpgradeTask_Build6200, UpgradeTask_Build6205, UpgradeTask_Build6206, UpgradeTask_Build6207, UpgradeTask_Build6208, UpgradeTask_Build6209, UpgradeTask_Build6210, UpgradeTask_Build6211, UpgradeTask_Build6251, UpgradeTask_Build6254, UpgradeTask_Build6256, UpgradeTask_Build6258, UpgradeTask_Build6301, UpgradeTask_Build6302, UpgradeTask_Build6304, UpgradeTask_Build6305, UpgradeTask_Build6306, UpgradeTask_Build6316, UpgradeTask_Build6318, UpgradeTask_Build6319, UpgradeTask_Build6320, UpgradeTask_Build6321, UpgradeTask_Build6322, UpgradeTask_Build6323, UpgradeTask_Build6325, UpgradeTask_Build6326, UpgradeTask_Build6327, UpgradeTask_Build6328, UpgradeTask_Build633, UpgradeTask_Build634, UpgradeTask_Build637, UpgradeTask_Build638, UpgradeTask_Build640, UpgradeTask_Build64001, UpgradeTask_Build64002, UpgradeTask_Build64003, UpgradeTask_Build64004, UpgradeTask_Build64005, UpgradeTask_Build64006, UpgradeTask_Build64007, UpgradeTask_Build64008, UpgradeTask_Build64009, UpgradeTask_Build64011, UpgradeTask_Build64012, UpgradeTask_Build64014, UpgradeTask_Build64015, UpgradeTask_Build64016, UpgradeTask_Build642, UpgradeTask_Build643, UpgradeTask_Build645, UpgradeTask_Build65001, UpgradeTask_Build663, UpgradeTask_Build70007, UpgradeTask_Build70009, UpgradeTask_Build70010, UpgradeTask_Build70011, UpgradeTask_Build70013, UpgradeTask_Build70023, UpgradeTask_Build70024, UpgradeTask_Build70025, UpgradeTask_Build70026, UpgradeTask_Build70027, UpgradeTask_Build701, UpgradeTask_Build70100, UpgradeTask_Build70101, UpgradeTask_Build70102, UpgradeTask_Build70109, UpgradeTask_Build705, UpgradeTask_Build707, UpgradeTask_Build708, UpgradeTask_Build751, UpgradeTask_Build752, UpgradeTask_Build753, UpgradeTask_Build754, UpgradeTask_Build755, UpgradeTask_Build756, UpgradeTask_Build757, UpgradeTask_Build758, UpgradeTask_Build759, UpgradeTask_Build771, UpgradeTask_Build801, UpgradeTask_Build802, UpgradeTask_Build807, UpgradeTask_Build808, UpgradeTask_Build809, UpgradeTask_Build810, UpgradeTask_Build812, UpgradeTask_Build813, UpgradeTask_Build843, UpgradeTask_Build849, UpgradeTask_Build851, UpgradeTaskForTesting, UpgradeTaskForTestingNoReindex

public interface UpgradeTask

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UpgradeTask.ScheduleOption
static class	UpgradeTask.Status Track status of a task this session, if isTaskDone(String) returns true you don't need to do it again.

Method Summary

Modifier and Type	Method and Description
String	dependsUpon() Return the Upgrade task id of another upgrade task that must be run prior to this task.
void	doUpgrade(boolean setupMode) Perform the upgrade.
String	getBuildNumber()
Collection<String>	getErrors() Return any errors that occur.
UpgradeTask.ScheduleOption	getScheduleOption() Return when this upgrade task can be scheduled.
String	getShortDescription() A short (<50 chars) description of the upgrade action
boolean	isDowngradeTaskRequired() Flag to claim whether this upgrade task needs an explicit downgrade task to reverse the data changes.

Method Detail

getBuildNumber

String getBuildNumber()

Returns:

The build number that this upgrade is applicable to

getShortDescription

String getShortDescription()

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

doUpgrade

void doUpgrade(boolean setupMode)
        throws Exception

Perform the upgrade.

Parameters:

setupMode - Indicating this upgrade task is running during set up.

Throws:

Exception

dependsUpon

@Nullable
String dependsUpon()

Return the Upgrade task id of another upgrade task that must be run prior to this task.

Since:

v6.4

getScheduleOption

UpgradeTask.ScheduleOption getScheduleOption()

Return when this upgrade task can be scheduled.

Since:

v6.4

getErrors

Collection<String> getErrors()

Return any errors that occur. Each entry is a string.

isDowngradeTaskRequired

boolean isDowngradeTaskRequired()

Flag to claim whether this upgrade task needs an explicit downgrade task to reverse the data changes.

If a downgrade is a simple no-op then return false, and JIRA will ignore these changes during a downgrade.

If you need to actually undo the changes made here then declare true and add a Downgrade Task to the bug fix branch.

Returns:

true if an actual Downgrade Task must run to revert these changes, false if downgrade is a no-op.