Package com.atlassian.confluence.impl.cluster

Interface ClusterConfigurationHelperInternal

All Superinterfaces:

ClusterConfigurationHelper

All Known Implementing Classes:

DefaultClusterConfigurationHelper, NonClusterConfigurationHelper

@Internal
public interface ClusterConfigurationHelperInternal
extends ClusterConfigurationHelper

Parts of ClusterConfigurationHelper that should not be visible for plugins.

Since:

5.9.1

Method Summary

Modifier and Type	Method	Description
void	createClusterConfig()	Creates and sets up the cluster config file in the shared home if it doesn't already exist.
void	createSharedHome()	Creates shared home directory if it does not exist already.
Optional<String>	getSharedBuildNumber()	Get the build number stored in the confluence.cfg.xml file in the shared home folder
Optional<Object>	getSharedProperty(Object key)	Get the value of a property stored in the confluence.cfg.xml config file (in the shared home folder)
void	populateExistingClusterSetupConfig()	Merges the config file in shared home into the current config file (in local home folder).
void	saveSetupConfigIntoSharedHome()	This method need to be trigger when we finish setup.
void	saveSharedBuildNumber(String sharedBuildNumber)	Store the build number into the confluence.cfg.xml file in the shared home folder
void	saveSharedProperty(Object key, Object value)	Save a property into the shared confluence.cfg.xml config file (in the shared home folder)

Methods inherited from interface com.atlassian.confluence.cluster.ClusterConfigurationHelper

bootstrapCluster, createCluster, getClusterableInterfaces, isClusteredInstance, isClusterHomeConfigured, joinConfig, sharedHome

Method Detail

createSharedHome

void createSharedHome()

Creates shared home directory if it does not exist already.

Shared home is created only if not clustering.

saveSetupConfigIntoSharedHome

void saveSetupConfigIntoSharedHome()

This method need to be trigger when we finish setup. If we setup Confluence Cluster then this method will write all necessary information so from second node won't go to setup again

Since:

6.1

populateExistingClusterSetupConfig

void populateExistingClusterSetupConfig()

Merges the config file in shared home into the current config file (in local home folder). Does nothing if the cluster config file doesn't exist.

Since:

6.1

createClusterConfig

void createClusterConfig()

Creates and sets up the cluster config file in the shared home if it doesn't already exist. Does nothing if the cluster config file already exists.

Since:

6.11.1

saveSharedProperty

void saveSharedProperty(Object key,
                        Object value)

Save a property into the shared confluence.cfg.xml config file (in the shared home folder)

Parameters:

key - the key of the property

value - the value of the property

Since:

6.9.0

getSharedProperty

Optional<Object> getSharedProperty(Object key)

Get the value of a property stored in the confluence.cfg.xml config file (in the shared home folder)

Parameters:

key - the key of the property

Returns:

the value of the property

Since:

6.9.0

saveSharedBuildNumber

void saveSharedBuildNumber(String sharedBuildNumber)

Store the build number into the confluence.cfg.xml file in the shared home folder

Parameters:

sharedBuildNumber - the shared build number to be saved

Since:

6.10.1

getSharedBuildNumber

Optional<String> getSharedBuildNumber()

Get the build number stored in the confluence.cfg.xml file in the shared home folder

Returns:

the shared build number

Since:

6.10.1