com.atlassian.confluence.upgrade.upgradetask

Class JiraIssueMacroServerParamsUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.JiraIssueMacroServerParamsUpgradeTask

All Implemented Interfaces:

BackupSupport, DatabaseUpgradeTask, DeferredUpgradeTask, UpgradeTask, UpgradeTaskInfo, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class JiraIssueMacroServerParamsUpgradeTask
extends AbstractDeferredRunUpgradeTask
implements DatabaseUpgradeTask

CONF-25329: This upgrade task adds additional Jira Issue macro params that allow us to resolve a renamed application link.

See Also:

for details.

This upgrade task can be re-run to fix existing macro usages that were previously broken, e.g.: (1) Run upgrade task so that all macros added since the applink was renamed have the correct applink ID stored (2) Rename the applink to its old name that the broken macros used (3) Re-run the upgrade task so that the broken macros now have the correct applink ID and URL stored (4) Rename the applink to desired name - all existing macro usages should now be resolved correctly via the 'serverId' param

Field Summary

Fields inherited from interface com.atlassian.confluence.upgrade.UpgradeTask

log

Constructor Summary

Constructors

Constructor and Description
JiraIssueMacroServerParamsUpgradeTask(JiraIssueMacroServerParamsMigrator migrator, int applicationConfigBuildNumber)

Method Summary

Modifier and Type	Method and Description
boolean	breaksBackwardCompatibility() This upgrade task enforces a migration which should have happened when the applink was renumbered.
void	doDeferredUpgrade() Run the upgrade that was deferred by an earlier call to doUpgrade.
String	getBuildNumber()
BuildNumberUpgradeConstraint	getConstraint()
String	getShortDescription() A short (<50 chars) description of the upgrade action
boolean	runOnSpaceImport() This upgrade task operates on Space data.

Methods inherited from class com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

doUpgrade, isUpgradeRequired, setUpgradeRequired

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

addAllErrors, addError, addError, getErrors, getName, isDatabaseUpgrade, setBeanName, setBuildNumber, validate

Methods inherited from class java.lang.Object

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

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

doUpgrade, getErrors, validate

Methods inherited from interface com.atlassian.confluence.upgrade.UpgradeTaskInfo

getName, isDatabaseUpgrade

Constructor Detail

JiraIssueMacroServerParamsUpgradeTask

public JiraIssueMacroServerParamsUpgradeTask(JiraIssueMacroServerParamsMigrator migrator,
                                             int applicationConfigBuildNumber)

Method Detail

getBuildNumber

public String getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTaskInfo

Overrides:

getBuildNumber in class AbstractUpgradeTask

Returns:

The build number that this upgrade is applicable to

getConstraint

public BuildNumberUpgradeConstraint getConstraint()

Specified by:

getConstraint in interface UpgradeTask

Overrides:

getConstraint in class AbstractUpgradeTask

Returns:

the constraint that must be passed for this task to be run.

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTaskInfo

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

Specified by:

getShortDescription in interface UpgradeTaskInfo

Overrides:

getShortDescription in class AbstractUpgradeTask

doDeferredUpgrade

public void doDeferredUpgrade()
                       throws Exception

Description copied from interface: DeferredUpgradeTask

Run the upgrade that was deferred by an earlier call to doUpgrade.

Specified by:

doDeferredUpgrade in interface DeferredUpgradeTask

Throws:

Exception

breaksBackwardCompatibility

public boolean breaksBackwardCompatibility()

This upgrade task enforces a migration which should have happened when the applink was renumbered.

Specified by:

breaksBackwardCompatibility in interface BackupSupport

runOnSpaceImport

public boolean runOnSpaceImport()

This upgrade task operates on Space data.

Specified by:

runOnSpaceImport in interface BackupSupport