Package com.atlassian.crowd.upgrade.tasks

Interface UpgradeTask

All Known Implementing Classes:
UpgradeTask001, UpgradeTask002, UpgradeTask003, UpgradeTask1000SetPasswordExpirationReminderMailTemplate, UpgradeTask1002RemovePrepareThresholdForPostgres, UpgradeTask1003ChangeHibernateDialectForOracle, UpgradeTask1004SetNotificationEmailsAsJsonArray, UpgradeTask1008ParseUserAttributesToNumericValue, UpgradeTask112, UpgradeTask113, UpgradeTask114, UpgradeTask1422ChangeHsqlDialect, UpgradeTask1526UpdateSyncDuringAuthModeForAzureAd, UpgradeTask1578UpdateEncryptionSettings, UpgradeTask1629UpdateSynchronisationSchedulingType, UpgradeTask1631AddAuthenticationWithoutPasswordEnabledAttribute, UpgradeTask1684AddEmailChangeTemplates, UpgradeTask1686EnableAuthenticationByEmailForCrowdApp, UpgradeTask1888EnsureSafeEncryptorIsUsed, UpgradeTask1888UpdateCrowdApplicationPassword, UpgradeTask1939SetUserAddedNotificationEmailTemplate, UpgradeTask1940UpdateHsqlHibernateProperties, UpgradeTask210, UpgradeTask211, UpgradeTask212, UpgradeTask214, UpgradeTask215, UpgradeTask216, UpgradeTask320, UpgradeTask321, UpgradeTask322, UpgradeTask342, UpgradeTask360, UpgradeTask361, UpgradeTask395, UpgradeTask396, UpgradeTask397, UpgradeTask420, UpgradeTask421, UpgradeTask422, UpgradeTask423, UpgradeTask424, UpgradeTask425, UpgradeTask426, UpgradeTask427, UpgradeTask428, UpgradeTask429, UpgradeTask430, UpgradeTask452, UpgradeTask502, UpgradeTask523, UpgradeTask524, UpgradeTask542, UpgradeTask622, UpgradeTask622ExternalId, UpgradeTask623GenerateExternalId, UpgradeTask645IntroduceUserPermissions, UpgradeTask852MoveSSOCookieNameToDb, UpgradeTask853EnsureCrowdApplicationExists, UpgradeTask854MoveBaseUrlToDb, UpgradeTask855RemoveCrowdProperties, UpgradeTask856SharedHome, UpgradeTask861ClusterFlagInCrowdConfig, UpgradeTask886FullSync, UpgradeTask907UpdateApisUrlsForAzureAdDirectories, UpgradeTask908MailServerTimeout, UpgradeTask910ResetHiLoAfterAuditLogMigration, UpgradeTask911MigrateOldEvents, UpgradeTask950MigrateSsoCookieDomain
public interface UpgradeTask
An upgrade task for Crowd

Please make sure when implementing an upgrade task that you write it in such a way as it can be run again and not corrupt the Crowd data on a second, third run.

  • Method Details

    • getBuildNumber

      int getBuildNumber()
      Returns:
      The build number that this upgrade is applicable to.

    • getShortDescription

      String getShortDescription()
      A short (less than 50 chars) description of the upgrade action
      Returns:
      description of upgrade task.

    • doUpgrade

      void doUpgrade() throws Exception
      Perform the upgrade.
      Throws:
      Exception - is thrown if any errors occur during the upgrade process.

    • getErrors

      @Deprecated default Collection<String> getErrors()
      Deprecated.
      Just throw from @doUpgrade() instead. Upgrade tasks are singleton beans, so most hold the error list across multiple imports.
      Any errors that occur during the upgrade process will be added to this Collection as Strings.
      Returns:
      a Collection<String> of errors. This may return an empty Collection.