com.atlassian.confluence.upgrade.upgradetask

Class MigrateIndexTaskQueueToJournalUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.MigrateIndexTaskQueueToJournalUpgradeTask

All Implemented Interfaces:

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

public class MigrateIndexTaskQueueToJournalUpgradeTask
extends AbstractDeferredRunUpgradeTask
implements DatabaseUpgradeTask

This upgrade task migrates recent entries from index queue to journal subsystem. Not all index queue entries will be migrated as it would take too much time. In standalone installations only unprocessed entries and at least one processed entry will be migrated. In cluster installations entries unprocessed on the local node and processed entries for a few minutes worth will be migrated.

While this task will be run on only the first node. A subsequent upgrade task (InitialiseIndexJournalStateUpgradeTask) will be run on all nodes in order to update their idea of which journal entries they need to process.

Since:

5.6

Constructor Summary

Constructors

Constructor and Description
MigrateIndexTaskQueueToJournalUpgradeTask(org.hibernate.SessionFactory sessionFactory, HibernateJournalDao hibernateJournalDao, ClusterConfigurationHelper clusterConfigurationHelper, com.atlassian.core.util.Clock clock)

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.
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.AbstractDeferredRunUpgradeTask

doUpgrade, isUpgradeRequired, setUpgradeRequired

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

doUpgrade, getConstraint, getErrors, validate

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

getName, getShortDescription, isDatabaseUpgrade

Constructor Detail

MigrateIndexTaskQueueToJournalUpgradeTask

public MigrateIndexTaskQueueToJournalUpgradeTask(org.hibernate.SessionFactory sessionFactory,
                                                 HibernateJournalDao hibernateJournalDao,
                                                 ClusterConfigurationHelper clusterConfigurationHelper,
                                                 com.atlassian.core.util.Clock clock)

Method Detail

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

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

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