com.atlassian.confluence.upgrade.upgradetask

Class EmbeddedCrowdSynchronisationUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.EmbeddedCrowdSynchronisationUpgradeTask

All Implemented Interfaces:

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

public final class EmbeddedCrowdSynchronisationUpgradeTask
extends AbstractUpgradeTask

Constructor Summary

Constructors

Constructor and Description
EmbeddedCrowdSynchronisationUpgradeTask(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService)

Method Summary

Modifier and Type	Method and 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

Constructor Detail

EmbeddedCrowdSynchronisationUpgradeTask

public EmbeddedCrowdSynchronisationUpgradeTask(com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService)

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

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

doUpgrade

public void doUpgrade()
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Throws:

Exception

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.

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.