Package com.atlassian.confluence.upgrade.upgradetask

Class BandanaXStreamValueUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.BandanaXStreamValueUpgradeTask

All Implemented Interfaces:

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

public class BandanaXStreamValueUpgradeTask
extends AbstractDeferredRunUpgradeTask
implements DatabaseUpgradeTask

Migrates Bandana values stored with XStream 1.1.1 format to XStream 1.4.1 based format. See this link for more information.

Since:

7.10.0

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
BandanaXStreamValueUpgradeTask(com.atlassian.bandana.BandanaManager bandanaManager, org.hibernate.SessionFactory sessionFactory, BatchOperationManager batchOperationManager)

Method Summary

Modifier and Type	Method	Description
boolean	breaksBackwardCompatibility()	Returns true if a new export can't be imported in an older instance.
void	doDeferredUpgrade()	Run it as deferred upgrade to wait for plugin framework and classloaders to get ready.
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.AbstractDeferredRunUpgradeTask

doUpgrade, isUpgradeRequired, setUpgradeRequired

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

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

doUpgrade, getConstraint, getErrors, validate

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

getName, isDatabaseUpgrade

Constructor Details

BandanaXStreamValueUpgradeTask

public BandanaXStreamValueUpgradeTask(com.atlassian.bandana.BandanaManager bandanaManager,
 org.hibernate.SessionFactory sessionFactory,
 BatchOperationManager batchOperationManager)

Method Details

doDeferredUpgrade

public void doDeferredUpgrade()

Run it as deferred upgrade to wait for plugin framework and classloaders to get ready.

Specified by:

doDeferredUpgrade in interface DeferredUpgradeTask

runOnSpaceImport

public boolean runOnSpaceImport()

Description copied from interface: BackupSupport

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.

Specified by:

runOnSpaceImport in interface BackupSupport

breaksBackwardCompatibility

public boolean breaksBackwardCompatibility()

Description copied from interface: BackupSupport

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.

Specified by:

breaksBackwardCompatibility in interface BackupSupport

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

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