com.atlassian.confluence.upgrade.upgradetask

Class ContentParentTypeFixingUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.ContentParentTypeFixingUpgradeTask

All Implemented Interfaces:

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

public class ContentParentTypeFixingUpgradeTask
extends AbstractUpgradeTask
implements DatabaseUpgradeTask

When writing StorageToAoMigrationUpgradeTask in the Inline Tasks plugin, we discovered that CAC had some trashed pages whose parent was a blog post. Some investigation into code followed to determine how this may have happened, and while we could not determine the exact way this could have happened, we found some code paths that could lead to the content type of an object changing (and fixed them). See CONF-17972 and HHH-416. This upgrade task was written to clean up instances with data like that just so other code doesn't blow up.

We can't use Hibernate here because it would blow up as the ORM mapping is not as described in the HBM file.

Since:

5.5

Constructor Summary

Constructors

Constructor and Description
ContentParentTypeFixingUpgradeTask(org.hibernate.SessionFactory sessionFactory)

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()
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, 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

getConstraint, getErrors, validate

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

getName, getShortDescription, isDatabaseUpgrade

Constructor Detail

ContentParentTypeFixingUpgradeTask

public ContentParentTypeFixingUpgradeTask(org.hibernate.SessionFactory sessionFactory)

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

doUpgrade

public void doUpgrade()
               throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:

doUpgrade in interface UpgradeTask

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