com.atlassian.confluence.upgrade
Interface UpgradeTask

All Known Subinterfaces:

DatabaseUpgradeTask, DeferredUpgradeTask

All Known Implementing Classes:

AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AbstractPageTemplateMigrationUpgradeTask, AbstractUpgradeTask, AbstractUserMappingUpgradeTask, AddSpaceStatusColumnUpgradeTask, AddUniqueAttachmentIdConstraintToAttachmentDataUpgradeTask, AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask, AttachmentLabellingUpgradeTask, BandanaKeyUniqueConstraintUpgradeTask, ChangeSpaceDescriptionsBodyTypeUpgradeTask, ConditionallyEnableMailArchivePluginUpgradeTask, ContentPermissionConstraintsUpgradeTask, ContentPermissionUserDeduplicationUpgradeTask, ConvertToRelativeLinksUpgradeTask, CorrectPNGImageAttachmentMimeTypeUpgradeTask, CrowdUsersUserMappingUpgradeTask, DefaultSpaceContentPageLayoutsUpgradeTask, DefaultSpaceContentToPageTemplateUpgradeTask, DeleteDidYouMeanIndexFolderUpgradeTask, DisableConfluenceInvitePluginUpgradeTask, DropContentLockTableUpgradeTask, EhCacheConfigMigrationUpgradeTask, EmbeddedCrowdInitUpgradeTask, EmbeddedCrowdPropertySetFactoryMigrationUpgradeTask, EmbeddedCrowdSchemaUpgradeTask, EmbeddedCrowdSynchronisationUpgradeTask, InstallationDateUpgradeTask, JiraIssueMacroServerParamsUpgradeTask, LikesDanglingFKCleanupUpgradeTask, LikesSqlConstraintsUpgradeTask, LoginInfoDuplicateEntryRemovalUpgradeTask, LowerCaseUsernameReferencesUpgradeTask, MailConvertToCustomContentUpgradeTask, MailServerUpgradeTask, MigrateMailArchiveConfigurationUpgradeTask, MigrateOndemandDocThemeCustomizations, NewColourUpgradeTask, NotificationPageColumnUpgradeTask, OnDemandSpacePermissionsDefaultUpgradeTask, PageTemplateWikiToXhtmlMigrationUpgradeTask, PageTemplateXhtmlRoundTripMigrationUpgradeTask, PersonalSpaceCreatorCheckUpgradeTask, RebuildIndexUpgradeTask, ReferencedUsersUserMappingUpgradeTask, RemoveEmailToPageWelcomeUpgradeTask, RemoveFixedWidthThemeUpgradeTask, RemovePeopleDirectoryDuplicatesUpgradeTask, RemoveRemoteAppsPluginUpgradeTask, UserIndexingUpgradeTask, UserKeyReferenceUpgradeTask, UserMappingLowerUsernameSchemaUpgradeTask, UserMappingSchemaUpgradeTask, WelcomeMessageUpgradeTask, WikiToXhtmlMigrationUpgradeTask, XhtmlRoundTripMigrationUpgradeTask

public interface UpgradeTask

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

Field Summary

static 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

void	doUpgrade() Perform the upgrade.
java.lang.String	getBuildNumber()
BuildNumberUpgradeConstraint	getConstraint()
java.util.Collection<UpgradeError>	getErrors() Return any errors that occur.
java.lang.String	getShortDescription() A short (<50 chars) description of the upgrade action
void	validate() Validates that this upgrade task can be performed.

Field Detail

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 Detail

getBuildNumber

java.lang.String getBuildNumber()

Returns:

The build number that this upgrade is applicable to

getConstraint

BuildNumberUpgradeConstraint getConstraint()

Returns:

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

getShortDescription

java.lang.String getShortDescription()

A short (<50 chars) description of the upgrade action

validate

void validate()
              throws java.lang.Exception

Validates that this upgrade task can be performed.

Throws:

java.lang.Exception

doUpgrade

void doUpgrade()
               throws java.lang.Exception

Perform the upgrade.

Throws:

java.lang.Exception

getErrors

java.util.Collection<UpgradeError> getErrors()

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

Returns:

a collection of UpgradeError objects, sometimes null.