com.atlassian.confluence.upgrade.upgradetask

Class SplitJournalUpgradeTask

java.lang.Object

com.atlassian.confluence.upgrade.AbstractUpgradeTask

com.atlassian.confluence.upgrade.AbstractDeferredRunUpgradeTask

com.atlassian.confluence.upgrade.upgradetask.SplitJournalUpgradeTask

All Implemented Interfaces:

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

public class SplitJournalUpgradeTask
extends AbstractDeferredRunUpgradeTask

Does 2 things:

• Updates the journalentry table to move items from main_index to change_index if they are:
  • DELETE_CHANGE_DOCUMENTS
  • DELETE_CHANGE_DOCUMENTS
  • ADD_CHANGE_DOCUMENT
  • REBUILD_CHANGE_DOCUMENTS
• writes the most recent id from the main_index journal to the change_index journal so that the change_index will continue at the same item as the main_index as the SplitIndexUpgradeTask will already have copied the relevant changes to the new index.

Since:

7.9.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_NUMBER

Constructor Summary

Constructors

Constructor and Description
SplitJournalUpgradeTask(@NonNull DdlExecutor ddlExecutor, @NonNull JournalStateStore journalStateStore, @NonNull JournalIdentifier contentJournalIdentifier, @NonNull JournalIdentifier changeJournalIdentifier, @NonNull org.hibernate.SessionFactory sessionFactory, @NonNull IndexTaskFactory indexTaskFactory, @NonNull JournalIndexTaskQueue changeQueue)

Method Summary

Modifier and Type	Method and Description
boolean	breaksBackwardCompatibility() Returns true if a new export can't be imported in an older instance.
protected void	createChangeTasks(JournalEntryType journalEntryType, Function<JournalEntry,ConfluenceIndexTask> changeTaskCreator) Create tasks to be written to the change index for all tasks that were previously writing both change and content documents
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

getConstraint, getErrors, validate

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

getName, getShortDescription, isDatabaseUpgrade

Field Detail

BUILD_NUMBER

public static final String BUILD_NUMBER

See Also:

Constant Field Values

Constructor Detail

SplitJournalUpgradeTask

public SplitJournalUpgradeTask(@NonNull DdlExecutor ddlExecutor,
                               @NonNull JournalStateStore journalStateStore,
                               @NonNull JournalIdentifier contentJournalIdentifier,
                               @NonNull JournalIdentifier changeJournalIdentifier,
                               @NonNull org.hibernate.SessionFactory sessionFactory,
                               @NonNull IndexTaskFactory indexTaskFactory,
                               @NonNull JournalIndexTaskQueue changeQueue)

Method Detail

doDeferredUpgrade

public void doDeferredUpgrade()
                       throws Exception

Description copied from interface: DeferredUpgradeTask

Run the upgrade that was deferred by an earlier call to doUpgrade.

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

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.

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.

createChangeTasks

protected void createChangeTasks(JournalEntryType journalEntryType,
                                 Function<JournalEntry,ConfluenceIndexTask> changeTaskCreator)

Create tasks to be written to the change index for all tasks that were previously writing both change and content documents