com.atlassian.confluence.upgrade.upgradetask
Class AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask

java.lang.Object
  com.atlassian.confluence.upgrade.AbstractUpgradeTask
      com.atlassian.confluence.upgrade.upgradetask.AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask

All Implemented Interfaces:

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

public class AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask
extends AbstractUpgradeTask

An upgrade task used to migrate the repository configuration from Atlassian User into the appropriate directories in Embedded Crowd. Uses the AtlassianUserMigratorFactory to create a migrator for the current atlassian user configuration.

Constructor Summary

AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask(AtlassianUserMigratorFactory atlassianUserMigratorFactory, EmbeddedCrowdBootstrap embeddedCrowdBootstrap)

Method Summary

boolean	breaksBackwardCompatibility() Returns true if a new export can't be imported in an older instance.
void	doUpgrade() Perform the upgrade.
java.lang.String	getBuildNumber()
java.lang.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.
void	validate() This is only implemented in this abstract base class for the convenience of the large number of older upgrade tasks.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask

public AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask(AtlassianUserMigratorFactory atlassianUserMigratorFactory,
                                                            EmbeddedCrowdBootstrap embeddedCrowdBootstrap)

Method Detail

getBuildNumber

public java.lang.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 java.lang.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

validate

public void validate()
              throws java.lang.Exception

Description copied from class: AbstractUpgradeTask

This is only implemented in this abstract base class for the convenience of the large number of older upgrade tasks.

If you are implementing a new UpgradeTask you must give some consideration to implementing validation as well.

Specified by:

validate in interface UpgradeTask

Overrides:

validate in class AbstractUpgradeTask

Throws:

java.lang.Exception

doUpgrade

public void doUpgrade()
               throws java.lang.Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Throws:

java.lang.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.