Package com.atlassian.confluence.upgrade.upgradetask

Class RenameTempDirPropertyUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.RenameTempDirPropertyUpgradeTask

All Implemented Interfaces:

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

public class RenameTempDirPropertyUpgradeTask
extends AbstractUpgradeTask

After upgrading WebWork to Struts we need to update 'confluence.cfg.xml' by renaming property 'webwork.multipart.saveDir' -> 'struts.multipart.saveDir'.

Since:

8.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	LEGACY_TEMP_DIR_PROP
static String	NEXT_TEMP_DIR_PROP

Constructor Summary

Constructors

Constructor	Description
RenameTempDirPropertyUpgradeTask(com.atlassian.config.ApplicationConfig applicationConfig)

Method Summary

Modifier and Type	Method	Description
boolean	breaksBackwardCompatibility()	Returns true if a new export can't be imported in an older instance.
void	doUpgrade()	Perform the upgrade.
String	getBuildNumber()
String	getShortDescription()	A short (<50 chars) description of the upgrade action
boolean	runOnSpaceImport()	Returns true if an older Space can't be imported in a new instance without running this task.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LEGACY_TEMP_DIR_PROP

public static final String LEGACY_TEMP_DIR_PROP

See Also:

Constant Field Values

NEXT_TEMP_DIR_PROP

public static final String NEXT_TEMP_DIR_PROP

See Also:

Constant Field Values

Constructor Detail

RenameTempDirPropertyUpgradeTask

public RenameTempDirPropertyUpgradeTask(com.atlassian.config.ApplicationConfig applicationConfig)

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

runOnSpaceImport

public boolean runOnSpaceImport()

Returns true if an older Space can't be imported in a new instance without running this task. For example:

• A task updating macro names in the BodyContent table would be blocking.
• Tasks which updates data related to the space would be blocking.
• A task upgrading the user table wouldn't be blocking.
• Adding a mandatory column on space-related content breaks space import

Note that tasks don't run on space import yet, so we just reject the import in this case.

Since:

5.2

breaksBackwardCompatibility

public boolean breaksBackwardCompatibility()

Returns true if a new export can't be imported in an older instance.

Breaking compatibility means a snapshot of the new version will not work at all with the previous version. For example:

• A destructive operation (Some data is replaced by another) breaks backwards compatibility
• Adding a optional column does NOT break backwards compatibility
• Data is copied to another column doesn't breaks backwards compatibility
• A build number incrementation doesn't breaks backwards compatibility

The best way to test is whether a newer export can be imported (with fully working features) in an older instance.

Since:

5.2

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

Returns:

Short description of this upgrade task.

doUpgrade

public void doUpgrade()
               throws Exception

Perform the upgrade.

Throws:

Exception