com.atlassian.jira.upgrade
Interface UpgradeTask

All Known Implementing Classes:

AbstractFieldScreenUpgradeTask, AbstractNotificationSchemeUpgradeTask, AbstractReindexUpgradeTask, AbstractSearchRequestUpgradeTask, AbstractUpgradeTask, DropIndexTask, 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_Build6317, UpgradeTask_Build6318, UpgradeTask_Build6319, UpgradeTask_Build6320, UpgradeTask_Build6321, UpgradeTask_Build6322, UpgradeTask_Build6323, UpgradeTask_Build6325, UpgradeTask_Build6326, UpgradeTask_Build6327, UpgradeTask_Build6328, UpgradeTask_Build633, UpgradeTask_Build6331, UpgradeTask_Build634, UpgradeTask_Build637, UpgradeTask_Build638, UpgradeTask_Build640, UpgradeTask_Build642, UpgradeTask_Build643, UpgradeTask_Build645, UpgradeTask_Build663, UpgradeTask_Build701, UpgradeTask_Build704, 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

public interface UpgradeTask

Nested Class Summary

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

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.

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

getErrors

Collection<String> getErrors()

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

isReindexRequired

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.