Package com.atlassian.confluence.setup

Class DefaultSetupPersister

java.lang.Object
com.atlassian.confluence.setup.DefaultSetupPersister
All Implemented Interfaces:
com.atlassian.config.setup.SetupPersister, ConfluenceSetupPersister
public class DefaultSetupPersister extends Object implements ConfluenceSetupPersister

  • Field Details

    • SETUP_TYPE_CLUSTER

      public static final String SETUP_TYPE_CLUSTER
      See Also:

    • SETUP_TYPE_STANDALONE_TO_CLUSTER

      public static final String SETUP_TYPE_STANDALONE_TO_CLUSTER
      See Also:

    • SETUP_TYPE_CLUSTER_TO_STANDALONE

      public static final String SETUP_TYPE_CLUSTER_TO_STANDALONE
      See Also:

    • MIGRATION_SETUP_TYPES

      public static final Set<String> MIGRATION_SETUP_TYPES

    • CLUSTER_SETUP_TYPES

      public static final Set<String> CLUSTER_SETUP_TYPES

  • Constructor Details

    • DefaultSetupPersister

      public DefaultSetupPersister()

  • Method Details

    • setApplicationConfig

      public void setApplicationConfig(com.atlassian.config.ApplicationConfiguration applicationConfig)

    • configureSetupSequence

      protected void configureSetupSequence(String setupType)
      Creates a default bootstrapManager sequence based on current state of confluence.config.xml

    • synchSetupStackWithConfigRecord

      public void synchSetupStackWithConfigRecord(String currentStep)
      Description copied from interface: ConfluenceSetupPersister
      Matches a recorded action in confluence.cfg.xml, element setupStep, to what is in the setupStack. Will then pop all previously performed steps.
      Specified by:
      synchSetupStackWithConfigRecord in interface ConfluenceSetupPersister
      Parameters:
      currentStep - the step we are up to

    • getUncompletedSteps

      public List<com.atlassian.core.util.PairType> getUncompletedSteps()
      Specified by:
      getUncompletedSteps in interface com.atlassian.config.setup.SetupPersister

    • getCompletedSteps

      public List<com.atlassian.core.util.PairType> getCompletedSteps()
      Specified by:
      getCompletedSteps in interface com.atlassian.config.setup.SetupPersister

    • getAllVisibleSteps

      public List<com.atlassian.core.util.PairType> getAllVisibleSteps()

    • getSetupType

      public String getSetupType()
      Specified by:
      getSetupType in interface com.atlassian.config.setup.SetupPersister
      Returns:
      the bootstrapManager type of the bootstrapManager process - initial, custom or install.

    • setSetupType

      public void setSetupType(String setupType)
      Specified by:
      setSetupType in interface com.atlassian.config.setup.SetupPersister

    • finishSetup

      public void finishSetup() throws com.atlassian.config.setup.SetupException
      Ensures that the bootstrapManager is written to a complete state by overriding all other remaining operations.
      Specified by:
      finishSetup in interface com.atlassian.config.setup.SetupPersister
      Throws:
      com.atlassian.config.setup.SetupException

    • progessSetupStep

      public void progessSetupStep()
      Specified by:
      progessSetupStep in interface com.atlassian.config.setup.SetupPersister

    • getCurrentDisplayStep

      public String getCurrentDisplayStep()
      Gets the key of the current step for displaying in setup step bar UI. This can be different from the actual step, for example, when the actual step is invisible and we want the setup step bar UI to still display the previous step.
      Returns:
      key of the current step for displaying purpose, null if the setup is done and there is no meaningful current step

    • getCurrentStep

      public String getCurrentStep()
      Gets the key of the actual current step.
      Specified by:
      getCurrentStep in interface com.atlassian.config.setup.SetupPersister
      Returns:
      key of the actual current step

    • setDemonstrationContentInstalled

      public void setDemonstrationContentInstalled()
      Specified by:
      setDemonstrationContentInstalled in interface com.atlassian.config.setup.SetupPersister

    • isDemonstrationContentInstalled

      public boolean isDemonstrationContentInstalled()
      Specified by:
      isDemonstrationContentInstalled in interface com.atlassian.config.setup.SetupPersister

    • isSetupTypeClustered

      public boolean isSetupTypeClustered()
      Description copied from interface: ConfluenceSetupPersister
      Determines whether or not the configured setup type is for a clustered edition
      Specified by:
      isSetupTypeClustered in interface ConfluenceSetupPersister
      Returns:
      True if the setup type is clustered or migration to cluster

    • isSetupTypeMigration

      public boolean isSetupTypeMigration()
      Description copied from interface: ConfluenceSetupPersister
      Determines whether or not the configured setup type is a migration to/from clustered
      Specified by:
      isSetupTypeMigration in interface ConfluenceSetupPersister
      Returns:
      True if the setup type is a migration

    • convertToClusterMigration

      public void convertToClusterMigration()
      Description copied from interface: ConfluenceSetupPersister
      Changes the setup type to a migration from standalone to cluster, and sets the current setup step
      Specified by:
      convertToClusterMigration in interface ConfluenceSetupPersister

    • convertToStandaloneMigration

      public void convertToStandaloneMigration()
      Description copied from interface: ConfluenceSetupPersister
      Changes the setup type to a migration from cluster to standalone, and sets the current setup step
      Specified by:
      convertToStandaloneMigration in interface ConfluenceSetupPersister

    • resetCancelledMigration

      public void resetCancelledMigration()
      Description copied from interface: ConfluenceSetupPersister
      Resets the confluence.cfg.xml into the previous working state after a migration to cluster was cancelled
      Specified by:
      resetCancelledMigration in interface ConfluenceSetupPersister

    • setMigrationCancelled

      public void setMigrationCancelled()
      Description copied from interface: ConfluenceSetupPersister
      Marks that a migration to cluster was attempted, and should be cleaned up upon next startup.
      Specified by:
      setMigrationCancelled in interface ConfluenceSetupPersister

    • removeClusterSetupEntries

      public void removeClusterSetupEntries()
      Description copied from interface: ConfluenceSetupPersister
      Removes config file entries pertaining to clustering
      Specified by:
      removeClusterSetupEntries in interface ConfluenceSetupPersister