com.atlassian.confluence.upgrade
Interface UpgradeTask

All Superinterfaces:
UpgradeTaskInfo
All Known Subinterfaces:
DatabaseUpgradeTask, DeferredUpgradeTask
All Known Implementing Classes:
AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AbstractPageTemplateMigrationUpgradeTask, AbstractUpgradeTask, AbstractUserMappingUpgradeTask, AddSpaceStatusColumnUpgradeTask, AddUniqueAttachmentIdConstraintToAttachmentDataUpgradeTask, AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask, AttachmentLabellingUpgradeTask, AttachmentToCeoConversionUpgradeTask, BandanaKeyUniqueConstraintUpgradeTask, ChangeSpaceDescriptionsBodyTypeUpgradeTask, ConditionallyEnableMailArchivePluginUpgradeTask, ContainedCustomContentEntityObjectUpgradeTask, ContentParentTypeFixingUpgradeTask, ContentPermissionConstraintsUpgradeTask, ContentPermissionUserDeduplicationUpgradeTask, ConvertToRelativeLinksUpgradeTask, CorrectPNGImageAttachmentMimeTypeUpgradeTask, CrowdUsersUserMappingUpgradeTask, DefaultSpaceContentPageLayoutsUpgradeTask, DefaultSpaceContentToPageTemplateUpgradeTask, DeleteDidYouMeanIndexFolderUpgradeTask, DisableConfluenceInvitePluginUpgradeTask, DropContentLockTableUpgradeTask, EhCacheConfigMigrationUpgradeTask, EmbeddedCrowdInitUpgradeTask, EmbeddedCrowdMembershipAggregationUpgradeTask, EmbeddedCrowdPropertySetFactoryMigrationUpgradeTask, EmbeddedCrowdSchemaUpgradeTask, EmbeddedCrowdSynchronisationUpgradeTask, GenericContentPropertiesUpgradeTask, InitialiseIndexJournalStateUpgradeTask, InstallationDateUpgradeTask, JiraIssueMacroServerParamsUpgradeTask, LikesDanglingFKCleanupUpgradeTask, LikesSqlConstraintsUpgradeTask, LoginInfoDuplicateEntryRemovalUpgradeTask, LowerCaseUsernameReferencesUpgradeTask, MailConvertToCustomContentUpgradeTask, MailServerTimeoutUpgradeTask, MailServerUpgradeTask, MigrateIndexTaskQueueToJournalUpgradeTask, MigrateMailArchiveConfigurationUpgradeTask, MigrateOndemandDocThemeCustomizations, NewColourUpgradeTask, NotificationPageColumnUpgradeTask, OnDemandSpacePermissionsDefaultUpgradeTask, PageTemplateWikiToXhtmlMigrationUpgradeTask, PageTemplateXhtmlRoundTripMigrationUpgradeTask, PersonalSpaceCreatorCheckUpgradeTask, RebuildIndexUpgradeTask, ReferencedUsersUserMappingUpgradeTask, RemoveEmailToPageWelcomeUpgradeTask, RemoveFixedWidthThemeUpgradeTask, RemovePeopleDirectoryDuplicatesUpgradeTask, RemoveRemoteAppsPluginUpgradeTask, RenameEhcachePropertiesUpgradeTask, SetAttachmentStorageSettingForClustersUpgradeTask, UserIndexingUpgradeTask, UserKeyReferenceUpgradeTask, UserMappingLowerUsernameSchemaUpgradeTask, UserMappingSchemaUpgradeTask, WelcomeMessageUpgradeTask, WikiToXhtmlMigrationUpgradeTask, XhtmlRoundTripMigrationUpgradeTask

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

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.


Copyright © 2003–2015 Atlassian. All rights reserved.