Package com.atlassian.confluence.upgrade.upgradetask

Class SecureLocalConfigSecretsUpgradeTask

java.lang.Object
com.atlassian.confluence.upgrade.AbstractUpgradeTask
com.atlassian.confluence.upgrade.upgradetask.SecureLocalConfigSecretsUpgradeTask
All Implemented Interfaces:
BackupSupport, UpgradeTask, UpgradeTaskInfo, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware
public class SecureLocalConfigSecretsUpgradeTask extends AbstractUpgradeTask
An upgrade task to secure the secret properties configured in local home as defined in the Set ConfluenceApplicationConfig.propertiesToSecure

This task utilises the SecretService to secure the secrets.

This task can also be manually invoked via the endpoint: "admin/do-force-upgrade.action"

(see story for details).

Since:
9.1.0

  • Constructor Details

    • SecureLocalConfigSecretsUpgradeTask

      public SecureLocalConfigSecretsUpgradeTask(com.atlassian.config.ApplicationConfiguration applicationConfiguration)

  • Method Details

    • runOnSpaceImport

      public boolean runOnSpaceImport()
      Description copied from interface: BackupSupport
      Returns true if an older Space can't be imported in a new instance without running this task. For example:
      • A task updating macro names in the BodyContent table would be blocking.
      • Tasks which updates data related to the space would be blocking.
      • A task upgrading the user table wouldn't be blocking.
      • Adding a mandatory column on space-related content breaks space import

      Note that tasks don't run on space import yet, so we just reject the import in this case.

    • breaksBackwardCompatibility

      public boolean breaksBackwardCompatibility()
      Description copied from interface: BackupSupport
      Returns true if a new export can't be imported in an older instance.

      Breaking compatibility means a snapshot of the new version will not work at all with the previous version. For example:

      • A destructive operation (Some data is replaced by another) breaks backwards compatibility
      • Adding a optional column does NOT break backwards compatibility
      • Data is copied to another column doesn't breaks backwards compatibility
      • A build number incrementation doesn't breaks backwards compatibility
      The best way to test is whether a newer export can be imported (with fully working features) in an older instance.

    • getBuildNumber

      public String getBuildNumber()
      Specified by:
      getBuildNumber in interface UpgradeTaskInfo
      Overrides:
      getBuildNumber in class AbstractUpgradeTask
      Returns:
      The build number that this upgrade is applicable to

    • getShortDescription

      public String getShortDescription()
      Description copied from interface: UpgradeTaskInfo
      A short (<50 chars) description of the upgrade action
      Specified by:
      getShortDescription in interface UpgradeTaskInfo
      Overrides:
      getShortDescription in class AbstractUpgradeTask

    • doUpgrade

      public void doUpgrade() throws Exception
      Description copied from interface: UpgradeTask
      Perform the upgrade.
      Throws:
      Exception