com.atlassian.confluence.upgrade.upgradetask

Class ChangeSpaceDescriptionsBodyTypeUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.upgradetask.ChangeSpaceDescriptionsBodyTypeUpgradeTask

All Implemented Interfaces:

UpgradeTask, UpgradeTaskInfo

public class ChangeSpaceDescriptionsBodyTypeUpgradeTask
extends Object
implements UpgradeTask

This upgrade task has two responsibilities:
(1) update all SpaceDescriptions that have a BodyContent with type BodyType.XHTML back to BodyType.WIKI.
(2) resolve all entity references introduced as a result of erroneously marking SpaceDescription's as XHTML to begin with.

This upgrade task is only required on instances that upgraded to 4.0.0.

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ChangeSpaceDescriptionsBodyTypeUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager, ContentDao contentDao, BatchTask<ContentEntityObject> batchTask, int applicationConfigBuildNumber)

Method Summary

Modifier and Type	Method and Description
void	doUpgrade() Perform the upgrade.
String	getBuildNumber()
BuildNumberUpgradeConstraint	getConstraint()
Collection<UpgradeError>	getErrors() Return any errors that occur.
String	getName() The human-readable name of the upgrade task
String	getShortDescription() A short (<50 chars) description of the upgrade action
boolean	isDatabaseUpgrade()
void	validate() Validates that this upgrade task can be performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeSpaceDescriptionsBodyTypeUpgradeTask

public ChangeSpaceDescriptionsBodyTypeUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                                  ContentDao contentDao,
                                                  BatchTask<ContentEntityObject> batchTask,
                                                  int applicationConfigBuildNumber)

Method Detail

doUpgrade

public void doUpgrade()
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:

doUpgrade in interface UpgradeTask

Throws:

Exception

getBuildNumber

public String getBuildNumber()

Specified by:

getBuildNumber in interface UpgradeTaskInfo

Returns:

The build number that this upgrade is applicable to

getConstraint

public BuildNumberUpgradeConstraint getConstraint()

Specified by:

getConstraint in interface UpgradeTask

Returns:

the constraint that must be passed for this task to be run.

getShortDescription

public String getShortDescription()

Description copied from interface: UpgradeTaskInfo

A short (<50 chars) description of the upgrade action

Specified by:

getShortDescription in interface UpgradeTaskInfo

isDatabaseUpgrade

public boolean isDatabaseUpgrade()

Specified by:

isDatabaseUpgrade in interface UpgradeTaskInfo

validate

public void validate()
              throws Exception

Description copied from interface: UpgradeTask

Validates that this upgrade task can be performed.

Specified by:

validate in interface UpgradeTask

Throws:

Exception

getName

public String getName()

Description copied from interface: UpgradeTaskInfo

The human-readable name of the upgrade task

Specified by:

getName in interface UpgradeTaskInfo

getErrors

public Collection<UpgradeError> getErrors()

Description copied from interface: UpgradeTask

Return any errors that occur. Each entry is an UpgradeError.

Specified by:

getErrors in interface UpgradeTask

Returns:

a collection of UpgradeError objects, sometimes null.