com.atlassian.confluence.upgrade
Interface UpgradeTask

All Known Subinterfaces:
DatabaseUpgradeTask, DeferredUpgradeTask
All Known Implementing Classes:
AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AbstractUpgradeTask, AddSpaceStatusColumnUpgradeTask, AddUniqueAttachmentIdConstraintToAttachmentDataUpgradeTask, AtlassianUpgradeFollowersUpgradeTask, AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask, AtlassianUserToEmbeddedCrowdDataUpgradeTask, AttachmentLabellingUpgradeTask, BandanaKeyUniqueConstraintUpgradeTask, BodyTypeUpgradeTask, BundleUserMacrosUpgradeTask, ChangeLogoStorageUpgradeTask, ChangeSpaceDescriptionsBodyTypeUpgradeTask, ClickrLeftNavMigrationUpgradeTask, ConditionallyEnableMailArchivePluginUpgradeTask, ContentPermissionConstraintsUpgradeTask, ConvertToRelativeLinksUpgradeTask, CorrectAttachmentCreatorUpgradeTask, DefaultSpaceContentPageLayoutsUpgradeTask, DefaultSpaceContentToPageTemplateUpgradeTask, DefaultSpaceContentUpgradeTask, DisableConfluenceInvitePluginUpgradeTask, DraftDataCleaningUpgradeTask, DropContentLockTableUpgradeTask, EmbeddedCrowdInitUpgradeTask, EmbeddedCrowdSchemaUpgradeTask, EmbeddedCrowdSynchronisationUpgradeTask, EnableAntiXssModeUpgradeTask, FollowFavouriteUpgradeTask, HierarchicalFileSystemAttachmentUpgradeTask, HsqlLockModeUpgradeTask, LikesDanglingFKCleanupUpgradeTask, LikesSqlConstraintsUpgradeTask, LoginInfoUpgradeTask, MailConvertToCustomContentUpgradeTask, MailServerUpgradeTask, MigrateMailArchiveConfigurationUpgradeTask, MigrateOndemandDocThemeCustomizations, MoveBackupSettingsToDatabaseUpgradeTask, NetworkAndSiteNotificationTypesRestoreUpgradeTask, NetworkAndSiteNotificationTypesUpgradeTask, NewColourUpgradeTask, OnDemandSpacePermissionsDefaultUpgradeTask, OSUserToEmbeddedCrowdMigrationUpgradeTask, PageTemplateWikiToXhtmlMigrationUpgradeTask, PurgeThumbnailsUpgradeTask, RebuildAncestorsUpgradeTask, RebuildIndexUpgradeTask, RemoveAPRUpgradeTask, RemoveClassicThemeUpgradeTask, RemoveEmailToPageWelcomeUpgradeTask, RemoveFixedWidthThemeUpgradeTask, RemoveSocialBookmarkingPluginUpgradeTask, ReportUserMacrosWithWikiTemplateUpgradeTask, TableStyleRemovalUpgradeTask, TinyMce3UpgradeTask, TrustedApplicationsCleanUpUpgradeTask, UserIndexingUpgradeTask, UserMacroConfigConversionUpgradeTask, UserMacroConfigFormatUpgradeTask, UserStatusPermissionUpgradeTask, WelcomeMessageUpgradeTask, WikiToXhtmlMigrationUpgradeTask

public interface UpgradeTask


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.
 String getBuildNumber()
           
 BuildNumberUpgradeConstraint getConstraint()
           
 Collection<UpgradeError> getErrors()
          Return any errors that occur.
 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

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

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


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-2013 Atlassian. All Rights Reserved.