com.atlassian.confluence.upgrade.upgradetask

Class AbstractPageTemplateMigrationUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.AbstractPageTemplateMigrationUpgradeTask

All Implemented Interfaces:

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

Direct Known Subclasses:

PageTemplateWikiToXhtmlMigrationUpgradeTask, PageTemplateXhtmlRoundTripMigrationUpgradeTask

public abstract class AbstractPageTemplateMigrationUpgradeTask
extends AbstractDeferredRunUpgradeTask
implements DatabaseUpgradeTask

Base class for upgrade tasks that want to migrate page templates from one format to another. It should be noted that any migration errors from individual pages will be recorded and logged but will not cause the upgrade itself to fail. This is to allow for cases where most content migrates successfully and there are simply a few failures that can be fixed through a different mechanism.

Since:

5.3

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
AbstractPageTemplateMigrationUpgradeTask(SiteMigrator migrator)

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	doDeferredUpgrade() Run the upgrade that was deferred by an earlier call to doUpgrade.
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, getBuildNumber, getConstraint, getErrors, getName, getShortDescription, 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

getBuildNumber, getName, getShortDescription, isDatabaseUpgrade

Constructor Detail

AbstractPageTemplateMigrationUpgradeTask

public AbstractPageTemplateMigrationUpgradeTask(SiteMigrator migrator)

Method Detail

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

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