UpgradeTask (Atlassian Jira - Server 11.2.0 API)

All Known Implementing Classes:: AbstractDelayableUpgradeTask, AbstractImmediateUpgradeTask, AbstractMd5ToShaWorkflowMigrationUpgradeTask, AbstractNotificationSchemeUpgradeTask, AbstractReindexUpgradeTask, AbstractUpgradeTask, LegacyImmediateUpgradeTask, NoOpUpgradeTask, UpgradeTask_Build10000001, UpgradeTask_Build10000002, UpgradeTask_Build10020000, UpgradeTask_Build10020002, UpgradeTask_Build10040000, UpgradeTask_Build70101, UpgradeTask_Build70102, UpgradeTask_Build710001, UpgradeTask_Build71001, UpgradeTask_Build72001, UpgradeTask_Build72002, UpgradeTask_Build73002, UpgradeTask_Build76001, UpgradeTask_Build77001, UpgradeTask_Build800003, UpgradeTask_Build800004, UpgradeTask_Build800005, UpgradeTask_Build800006, UpgradeTask_Build800007, UpgradeTask_Build801000, UpgradeTask_Build804000, UpgradeTask_Build811001, UpgradeTask_Build814000, UpgradeTask_Build815000, UpgradeTask_Build819000, UpgradeTask_Build822000, UpgradeTask_Build900000, UpgradeTask_Build900001, UpgradeTask_Build9150000, UpgradeTask_Build960000

public interface UpgradeTask

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

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

Description

Integer

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.

int

getBuildNumber()

Collection<String>

getErrors()

Return any errors that occur.

UpgradeTask.ScheduleOption

getScheduleOption()

Return when this upgrade task can be scheduled.

String

getShortDescription()

A short (invalid input: '<'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 in Jira-Server.

Method Details
- getBuildNumber
  
  int getBuildNumber()
  
  Returns:
  
  The build number that this upgrade is applicable to
- getShortDescription
  
  String getShortDescription()
  
  A short (invalid input: '<'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 Integer 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 in Jira-Server. Jira-Cloud always needs corresponding downgrade task.
  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.