com.atlassian.confluence.upgrade.upgradetask

Class ContentPermissionConstraintsUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.ContentPermissionConstraintsUpgradeTask

All Implemented Interfaces:

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

public class ContentPermissionConstraintsUpgradeTask
extends AbstractUpgradeTask
implements DatabaseUpgradeTask

Adds required multi-column unique constraints to the content permission tables.

Since:

3.5.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_PERM_SET_TABLE_NAME
static String	CONTENT_PERM_TABLE_NAME
static String	CP_OS_IDX_NAME
static AddUniqueConstraintCommand	CP_UNIQUE_GROUP_CONSTRAINT
static String	CP_UNIQUE_GROUP_CONSTRAINT_NAME
static AddUniqueConstraintCommand	CP_UNIQUE_USER_CONSTRAINT
static String	CP_UNIQUE_USER_CONSTRAINT_NAME
static AddUniqueConstraintCommand	CP_UNIQUE_USER_GROUPS_CONSTRAINT
static String	CP_UNIQUE_USER_GROUPS_CONSTRAINT_NAME
static String	CPS_CONTENT_IDX_NAME
static AddUniqueConstraintCommand	CPS_UNIQUE_TYPE_CONSTRAINT
static String	CPS_UNIQUE_TYPE_CONSTRAINT_NAME
static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ContentPermissionConstraintsUpgradeTask(AlterTableExecutor alterTableExecutor, DdlExecutor ddlExecutor, com.atlassian.confluence.upgrade.upgradetask.ContentPermissionConstraintsCleaner contentPermissionConstraintsCleaner)

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	doPreUpgradeCleanup()
void	doUpgrade() Perform the upgrade.
String	getBuildNumber()
String	getShortDescription() A short (<50 chars) description of the upgrade action
static List<String>	getUniqueConstraintSqlStatements()
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

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

getConstraint, getErrors, validate

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

getName, isDatabaseUpgrade

Field Detail

log

public static final org.slf4j.Logger log

CPS_UNIQUE_TYPE_CONSTRAINT_NAME

public static final String CPS_UNIQUE_TYPE_CONSTRAINT_NAME

See Also:

Constant Field Values

CP_UNIQUE_USER_GROUPS_CONSTRAINT_NAME

public static final String CP_UNIQUE_USER_GROUPS_CONSTRAINT_NAME

See Also:

Constant Field Values

CP_UNIQUE_USER_CONSTRAINT_NAME

public static final String CP_UNIQUE_USER_CONSTRAINT_NAME

See Also:

Constant Field Values

CP_UNIQUE_GROUP_CONSTRAINT_NAME

public static final String CP_UNIQUE_GROUP_CONSTRAINT_NAME

See Also:

Constant Field Values

CPS_UNIQUE_TYPE_CONSTRAINT

public static final AddUniqueConstraintCommand CPS_UNIQUE_TYPE_CONSTRAINT

CP_UNIQUE_USER_GROUPS_CONSTRAINT

public static final AddUniqueConstraintCommand CP_UNIQUE_USER_GROUPS_CONSTRAINT

CP_UNIQUE_USER_CONSTRAINT

public static final AddUniqueConstraintCommand CP_UNIQUE_USER_CONSTRAINT

CP_UNIQUE_GROUP_CONSTRAINT

public static final AddUniqueConstraintCommand CP_UNIQUE_GROUP_CONSTRAINT

CONTENT_PERM_TABLE_NAME

public static final String CONTENT_PERM_TABLE_NAME

See Also:

Constant Field Values

CONTENT_PERM_SET_TABLE_NAME

public static final String CONTENT_PERM_SET_TABLE_NAME

See Also:

Constant Field Values

CP_OS_IDX_NAME

public static final String CP_OS_IDX_NAME

See Also:

Constant Field Values

CPS_CONTENT_IDX_NAME

public static final String CPS_CONTENT_IDX_NAME

See Also:

Constant Field Values

Constructor Detail

ContentPermissionConstraintsUpgradeTask

public ContentPermissionConstraintsUpgradeTask(AlterTableExecutor alterTableExecutor,
                                               DdlExecutor ddlExecutor,
                                               com.atlassian.confluence.upgrade.upgradetask.ContentPermissionConstraintsCleaner contentPermissionConstraintsCleaner)

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

getUniqueConstraintSqlStatements

public static List<String> getUniqueConstraintSqlStatements()

doUpgrade

public final void doUpgrade()
                     throws Exception

Description copied from interface: UpgradeTask

Perform the upgrade.

Specified by:

doUpgrade in interface UpgradeTask

Throws:

Exception

doPreUpgradeCleanup

public void doPreUpgradeCleanup()

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