Package com.atlassian.confluence.upgrade

Interface UpgradeTask

All Superinterfaces:

UpgradeTaskInfo

All Known Subinterfaces:

DatabaseUpgradeTask, DeferredUpgradeTask

All Known Implementing Classes:

AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AbstractIndexContentUpgradeTask, AbstractUpgradeTask, BandanaComplexTypesUpgradeTask, BandanaTokenCleanupUpgradeTask, BandanaToPluginSettingsUpgradeTask, DbTrueFalseTypeFixUpgradeTask, DecoratorLangMacroReplacementUpgradeTask, DenormalisedContentStatusUpgradeTask, DenormalisedPermissionsTriggersUpgradeTask, DropIncrementalSyncSubscriptionUpgradeTask, EmbeddedCrowdSchemaUpgradeTask, LabelUniqueIndexUpgradeTask, MigrateScheduledJobCacheUpgradeTask, MigrateTrashDateUpgradeTask, NullModificationDateDraftUpgradeTask, RenameTempDirPropertyUpgradeTask, ReplaceC3p0ConnectionPoolWithHikariCPUpgradeTask, ResetJournalStateUpgradeTask, SecureLocalConfigSecretsUpgradeTask, SecureMailServerSecretUpgradeTask, SecureSharedConfigSecretsUpgradeTask, SynchronyPidFileRemovalUpgradeTask, TurnFastPermissionsOnByDefaultUpgradeTask, UserDirectoryPasswordEncryptionUpgradeTask, WikiToXhtmlMigrationUpgradeTask

public interface UpgradeTask
extends UpgradeTaskInfo

Upgrade task.

Don't forget the ugprade tasks are also run on backup import: Please implement BackupSupport and declare your backward-compatibility.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	log	All upgrade tasks should use this log for convenience, unless there's some overriding reason to use a different log

Method Summary

Modifier and Type	Method	Description
void	doUpgrade()	Perform the upgrade.
BuildNumberUpgradeConstraint	getConstraint()
Collection<UpgradeError>	getErrors()	Return any errors that occur.
void	validate()	Validates that this upgrade task can be performed.

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

getBuildNumber, getName, getShortDescription, isDatabaseUpgrade

Field Details

log

static final org.slf4j.Logger log

All upgrade tasks should use this log for convenience, unless there's some overriding reason to use a different log

Method Details

getConstraint

BuildNumberUpgradeConstraint getConstraint()

Returns:

the constraint that must be passed for this task to be run.

validate

void validate()
       throws Exception

Validates that this upgrade task can be performed.

Throws:

Exception

doUpgrade

void doUpgrade()
        throws Exception

Perform the upgrade.

Throws:

Exception

getErrors

Collection<UpgradeError> getErrors()

Return any errors that occur. Each entry is an UpgradeError.

Returns:

a collection of UpgradeError objects, sometimes null.