com.atlassian.jira.upgrade.tasks

Class AbstractReindexUpgradeTask

java.lang.Object

com.atlassian.jira.upgrade.AbstractUpgradeTask

com.atlassian.jira.upgrade.AbstractImmediateUpgradeTask

com.atlassian.jira.upgrade.tasks.AbstractReindexUpgradeTask

All Implemented Interfaces:

com.atlassian.upgrade.spi.UpgradeTask

Direct Known Subclasses:

UpgradeTask_Build800004, UpgradeTask_Build900001

public abstract class AbstractReindexUpgradeTask
extends AbstractImmediateUpgradeTask

Nested Class Summary

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

UpgradeTask.ScheduleOption, UpgradeTask.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<AffectedIndex>	ALL_INDEXES
protected static Set<AffectedIndex>	ALL_ISSUE_INDEXES
protected static Set<SharedEntityType>	ALL_SHARED_ENTITY_TYPES
protected static Set<SharedEntityType>	NO_SHARED_ENTITIES
protected static Set<AffectedIndex>	WORKLOG_ONLY

Constructor Summary

Constructors

Constructor and Description
AbstractReindexUpgradeTask()

Method Summary

Modifier and Type	Method and Description
void	doUpgrade(boolean setupMode) Perform the upgrade.
String	getShortDescription() A short (<50 chars) description of the upgrade action
void	reIndexAllIssues()
abstract boolean	triggersFullReindex() When this task is pending, returned value is used to determine if index startup flow should perform normal procedure to obtain index.

Methods inherited from class com.atlassian.jira.upgrade.AbstractImmediateUpgradeTask

getScheduleOption

Methods inherited from class com.atlassian.jira.upgrade.AbstractUpgradeTask

addError, addErrors, addErrors, convertToSchemaTableName, dependsUpon, getApplicationProperties, getDatabaseConnection, getDatabaseType, getDatabaseUtil, getDelegator, getEntityEngine, getErrors, getI18nBean, getOfBizDelegator, getReindexRequestService, getSchemaName, isMSSQL, isMYSQL, isORACLE, isPostgreSQL, runUpgrade

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.upgrade.UpgradeTask

getBuildNumber, isDowngradeTaskRequired

Methods inherited from interface com.atlassian.upgrade.spi.UpgradeTask

getBuildNumber

Field Detail

ALL_INDEXES

protected static final Set<AffectedIndex> ALL_INDEXES

ALL_ISSUE_INDEXES

protected static final Set<AffectedIndex> ALL_ISSUE_INDEXES

ALL_SHARED_ENTITY_TYPES

protected static final Set<SharedEntityType> ALL_SHARED_ENTITY_TYPES

WORKLOG_ONLY

protected static final Set<AffectedIndex> WORKLOG_ONLY

NO_SHARED_ENTITIES

protected static final Set<SharedEntityType> NO_SHARED_ENTITIES

Constructor Detail

AbstractReindexUpgradeTask

public AbstractReindexUpgradeTask()

Method Detail

doUpgrade

public void doUpgrade(boolean setupMode)
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Parameters:

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

Throws:

Exception

reIndexAllIssues

public void reIndexAllIssues()
                      throws Exception

Throws:

Exception

triggersFullReindex

public abstract boolean triggersFullReindex()

When this task is pending, returned value is used to determine if index startup flow should perform normal procedure to obtain index. If we change the directory for indexes, index startup flow performs full reindex. If we already triggering full reindex as part of this upgrade task the one from index startup flow is obsolete. To prevent double full reindex caused by index startup flow + upgrade task combination return true.

Returns:

true if index startup flow should be skipped false if you want to perform index startup flow before this upgrade task.

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTask

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