Package com.atlassian.confluence.upgrade.upgradetask

Class BandanaToPluginSettingsUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.BandanaToPluginSettingsUpgradeTask

All Implemented Interfaces:

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

public class BandanaToPluginSettingsUpgradeTask
extends AbstractUpgradeTask

This upgrade task migrates compatible Bandana data to the new Plugin Settings table. This task is also wired to run on site restores and will run on space restores via PostImportTaskRunner.

Since:

10.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final BandanaManager	bandanaManager
protected final BatchOperationManager	batchOperationManager
static final String	BUILD_NUMBER
protected AtomicInteger	counter
protected final BiFunction<PluginSettingRepository,String,ConfluencePluginSettings>	pluginSettingsFactory
protected final PluginSettingRepository	repository

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

log

Constructor Summary

Constructors

Constructor	Description
BandanaToPluginSettingsUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory, BandanaManager bandanaManager, PluginSettingRepository repository, BatchOperationManager batchOperationManager)

Method Summary

Modifier and Type	Method	Description
boolean	breaksBackwardCompatibility()	Returns true if a new export can't be imported in an older instance.
void	doUpgrade()	Perform the upgrade.
protected <T> T	executeInReadOnlyTransaction(Function<org.hibernate.Session,T> function)
String	getBuildNumber()
String	getShortDescription()	A short (invalid input: '<'50 chars) description of the upgrade action
protected Object	mapValue(Object value)
void	migrateForContext(String context)
protected Object	migrateSingleKey(KeyedBandanaContext ctx, String key, ConfluencePluginSettings pluginSettings)
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 Details

BUILD_NUMBER

public static final String BUILD_NUMBER

See Also:

• Constant Field Values

bandanaManager

protected final BandanaManager bandanaManager

repository

protected final PluginSettingRepository repository

batchOperationManager

protected final BatchOperationManager batchOperationManager

pluginSettingsFactory

protected final BiFunction<PluginSettingRepository,String,ConfluencePluginSettings> pluginSettingsFactory

counter

protected AtomicInteger counter

Constructor Details

BandanaToPluginSettingsUpgradeTask

public BandanaToPluginSettingsUpgradeTask(org.springframework.transaction.PlatformTransactionManager transactionManager,
 org.hibernate.SessionFactory sessionFactory,
 BandanaManager bandanaManager,
 PluginSettingRepository repository,
 BatchOperationManager batchOperationManager)

Method Details

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 (invalid input: '<'50 chars) description of the upgrade action

Specified by:

getShortDescription in interface UpgradeTaskInfo

Overrides:

getShortDescription in class AbstractUpgradeTask

doUpgrade

public void doUpgrade()

Description copied from interface: UpgradeTask

Perform the upgrade.

migrateForContext

public void migrateForContext(String context)

mapValue

protected Object mapValue(Object value)

executeInReadOnlyTransaction

protected <T> T executeInReadOnlyTransaction(Function<org.hibernate.Session,T> function)

migrateSingleKey

protected Object migrateSingleKey(KeyedBandanaContext ctx,
 String key,
 ConfluencePluginSettings pluginSettings)

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