Package com.atlassian.confluence.upgrade.upgradetask

Class EmbeddedCrowdSchemaUpgradeTask

java.lang.Object
com.atlassian.confluence.upgrade.AbstractUpgradeTask
com.atlassian.confluence.upgrade.upgradetask.AbstractConstraintCreationUpgradeTask
com.atlassian.confluence.upgrade.upgradetask.EmbeddedCrowdSchemaUpgradeTask
All Implemented Interfaces:
BackupSupport, DatabaseUpgradeTask, UpgradeTask, UpgradeTaskInfo, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware
public class EmbeddedCrowdSchemaUpgradeTask extends AbstractConstraintCreationUpgradeTask
Adds required multi-column unique constraints to the Crowd database tables

This upgrade task is only retained due to its usage in DefaultHibernateConfigurator.

  • Constructor Details

    • EmbeddedCrowdSchemaUpgradeTask

      public EmbeddedCrowdSchemaUpgradeTask(org.hibernate.SessionFactory sessionFactory)

  • Method Details

    • 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

    • getUniqueConstraintSqlStatements

      public static List<String> getUniqueConstraintSqlStatements()

    • getSqlStatementsFromPropertiesFile

      protected List<String> getSqlStatementsFromPropertiesFile()
      Specified by:
      getSqlStatementsFromPropertiesFile in class AbstractConstraintCreationUpgradeTask

    • 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
      Overrides:
      getErrors in class AbstractUpgradeTask
      Returns:
      a collection of UpgradeError objects, sometimes null.

    • doBeforeUpgrade

      protected void doBeforeUpgrade(org.hibernate.Session session, org.springframework.jdbc.core.JdbcTemplate template)
      Specified by:
      doBeforeUpgrade in class AbstractConstraintCreationUpgradeTask

    • 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.