com.atlassian.confluence.setup.actions

Interface ConfluenceSetupPersister

All Superinterfaces:

com.atlassian.config.setup.SetupPersister

All Known Implementing Classes:

DefaultSetupPersister

@Internal
public interface ConfluenceSetupPersister
extends com.atlassian.config.setup.SetupPersister

Field Summary

Fields inherited from interface com.atlassian.config.setup.SetupPersister

SETUP_INSTALL_DEMO_DATA, SETUP_STATE_COMPLETE, SETUP_TYPE_CUSTOM, SETUP_TYPE_INITIAL, SETUP_TYPE_INSTALL

Method Summary

Modifier and Type	Method and Description
void	convertToClusterMigration() Changes the setup type to a migration from standalone to cluster, and sets the current setup step
void	convertToStandaloneMigration() Changes the setup type to a migration from cluster to standalone, and sets the current setup step
boolean	isSetupTypeClustered() Determines whether or not the configured setup type is for a clustered edition
boolean	isSetupTypeMigration() Determines whether or not the configured setup type is a migration to/from clustered
void	removeClusterSetupEntries() Removes config file entries pertaining to clustering
void	resetCancelledMigration() Resets the confluence.cfg.xml into the previous working state after a migration to cluster was cancelled
void	setMigrationCancelled() Marks that a migration to cluster was attempted, and should be cleaned up upon next startup.
void	synchSetupStackWithConfigRecord(String currentStep) Matches a recorded action in confluence.cfg.xml, element setupStep, to what is in the setupStack.

Methods inherited from interface com.atlassian.config.setup.SetupPersister

finishSetup, getCompletedSteps, getCurrentStep, getSetupType, getUncompletedSteps, isDemonstrationContentInstalled, progessSetupStep, setDemonstrationContentInstalled, setSetupType

Method Detail

isSetupTypeClustered

boolean isSetupTypeClustered()

Determines whether or not the configured setup type is for a clustered edition

Returns:

True if the setup type is clustered or migration to cluster

isSetupTypeMigration

boolean isSetupTypeMigration()

Determines whether or not the configured setup type is a migration to/from clustered

Returns:

True if the setup type is a migration

convertToClusterMigration

void convertToClusterMigration()

Changes the setup type to a migration from standalone to cluster, and sets the current setup step

convertToStandaloneMigration

void convertToStandaloneMigration()

Changes the setup type to a migration from cluster to standalone, and sets the current setup step

resetCancelledMigration

void resetCancelledMigration()

Resets the confluence.cfg.xml into the previous working state after a migration to cluster was cancelled

setMigrationCancelled

void setMigrationCancelled()

Marks that a migration to cluster was attempted, and should be cleaned up upon next startup.

removeClusterSetupEntries

void removeClusterSetupEntries()

Removes config file entries pertaining to clustering

synchSetupStackWithConfigRecord

void synchSetupStackWithConfigRecord(String currentStep)

Matches a recorded action in confluence.cfg.xml, element setupStep, to what is in the setupStack. Will then pop all previously performed steps.

Parameters:

currentStep - the step we are up to