com.atlassian.confluence.upgrade
Class AbstractUpgradeTask
java.lang.Object
com.atlassian.confluence.upgrade.AbstractUpgradeTask
- All Implemented Interfaces:
- UpgradeTask
- Direct Known Subclasses:
- AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AddSpaceStatusColumnUpgradeTask, AddUniqueAttachmentIdConstraintToAttachmentDataUpgradeTask, AtlassianUpgradeFollowersUpgradeTask, AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask, AtlassianUserToEmbeddedCrowdDataUpgradeTask, AttachmentLabellingUpgradeTask, BandanaKeyUniqueConstraintUpgradeTask, BodyTypeUpgradeTask, BundleUserMacrosUpgradeTask, ChangeLogoStorageUpgradeTask, ClickrLeftNavMigrationUpgradeTask, ContentPermissionConstraintsUpgradeTask, CorrectAttachmentCreatorUpgradeTask, DefaultSpaceContentPageLayoutsUpgradeTask, DefaultSpaceContentUpgradeTask, DraftDataCleaningUpgradeTask, DropContentLockTableUpgradeTask, EmbeddedCrowdInitUpgradeTask, EmbeddedCrowdSynchronisationUpgradeTask, EnableAntiXssModeUpgradeTask, FollowFavouriteUpgradeTask, HierarchicalFileSystemAttachmentUpgradeTask, HsqlLockModeUpgradeTask, LikesDanglingFKCleanupUpgradeTask, LoginInfoUpgradeTask, MailConvertToCustomContentUpgradeTask, MailServerUpgradeTask, MigrateMailArchiveConfigurationUpgradeTask, MigrateOndemandDocThemeCustomizations, MoveBackupSettingsToDatabaseUpgradeTask, NetworkAndSiteNotificationTypesRestoreUpgradeTask, NetworkAndSiteNotificationTypesUpgradeTask, NewColourUpgradeTask, OnDemandSpacePermissionsDefaultUpgradeTask, OSUserToEmbeddedCrowdMigrationUpgradeTask, PurgeThumbnailsUpgradeTask, RebuildAncestorsUpgradeTask, RemoveAPRUpgradeTask, RemoveClassicThemeUpgradeTask, RemoveEmailToPageWelcomeUpgradeTask, RemoveFixedWidthThemeUpgradeTask, RemoveSocialBookmarkingPluginUpgradeTask, TinyMce3UpgradeTask, TrustedApplicationsCleanUpUpgradeTask, UserIndexingUpgradeTask, UserMacroConfigConversionUpgradeTask, UserMacroConfigFormatUpgradeTask, UserStatusPermissionUpgradeTask
public abstract class AbstractUpgradeTask
- extends Object
- implements UpgradeTask
A useful base class for UpgradeTasks. Note that this base class has a default
implementation of validate which does nothing. This is a common case but if you
do need validation be sure to override it.
Fields inherited from interface com.atlassian.confluence.upgrade.UpgradeTask |
log |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AbstractUpgradeTask
public AbstractUpgradeTask()
getShortDescription
public String getShortDescription()
- Description copied from interface:
UpgradeTask
- A short (<50 chars) description of the upgrade action
- Specified by:
getShortDescription
in interface UpgradeTask
addError
protected void addError(UpgradeError error)
addError
protected void addError(String errorMessage)
addAllErrors
protected void addAllErrors(Collection<UpgradeError> errors)
getErrors
public Collection<UpgradeError> getErrors()
- Description copied from interface:
UpgradeTask
- Return any errors that occur. Each entry is an
UpgradeError
.
- Specified by:
getErrors
in interface UpgradeTask
- Returns:
- a collection of
UpgradeError
objects, sometimes null.
setBuildNumber
public void setBuildNumber(String buildNumber)
getBuildNumber
public String getBuildNumber()
- Specified by:
getBuildNumber
in interface UpgradeTask
- Returns:
- The build number that this upgrade is applicable to
validate
public void validate()
throws Exception
This is only implemented in this abstract base class for the convenience of the large number of older
upgrade tasks.
If you are implementing a new UpgradeTask you must give some consideration to implementing
validation as well.
- Specified by:
validate
in interface UpgradeTask
- Throws:
Exception
getConstraint
public BuildNumberUpgradeConstraint getConstraint()
- Specified by:
getConstraint
in interface UpgradeTask
- Returns:
- the constraint that must be passed for this task to be run.
Copyright © 2003-2013 Atlassian. All Rights Reserved.