public interface

UpgradeTask

com.atlassian.jira.upgrade.UpgradeTask
Known Indirect Subclasses

Summary

Nested Classes
class UpgradeTask.Status Track status of a task this session, if isTaskDone(String) returns true you don't need to do it again. 
Public Methods
void doUpgrade(boolean setupMode)
Perform the upgrade.
String getBuildNumber()
Collection<String> getErrors()
Return any errors that occur.
String getShortDescription()
A short (<50 chars) description of the upgrade action
boolean isReindexRequired()
Is a reindex required as a result of running this task.

Public Methods

public void doUpgrade (boolean setupMode)

Perform the upgrade.

Parameters
setupMode Indicating this upgrade task is running during set up.
Throws
Exception

public String getBuildNumber ()

Returns
  • The build number that this upgrade is applicable to

public Collection<String> getErrors ()

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

public String getShortDescription ()

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

public boolean isReindexRequired ()

Is a reindex required as a result of running this task. If this method returns true the Upgrade manager will perform a reindex before completing. If an upgrade task changes data that is indexed by Lucene, e.g. the content of Issue fields then it should return true. A task need not necessarily change data to require a reindex but may return true here and do nothing else if there is a functional change to the code that requires the Lucene index to be rebuilt.

Returns
  • true if a reindex is required as a result of running this task.