Interface UpgradeManager

All Known Implementing Classes:
UpgradeManagerImpl

public interface UpgradeManager
This manager is responsible for all things related to upgrades for Crowd. Upgrades are performed by UpgradeTask's and are associated to a given build number.
  • Method Details

    • needUpgrade

      boolean needUpgrade()
      Determines whether we need to run the upgrade or not.
      Returns:
      boolean whether the build was successful or not
    • getRequiredUpgrades

      List<UpgradeTask> getRequiredUpgrades()
      Returns:
      list of upgrade tasks that are required to be executed (in order).
    • doUpgrade

      Collection<String> doUpgrade() throws Exception
      Method to fire off the upgrade process
      Returns:
      Collection a string collection of error messages. Collection not empty denotes error occurred on upgrade
      Throws:
      Exception - error occurred during upgrade.
    • getDataBuildNumber

      int getDataBuildNumber()
      This gets the pre-build number. i.e The build number present in the database, BEFORE the upgrade process has been run.
      Returns:
      the current build number (in data store)