com.atlassian.confluence.cluster

Class DefaultClusterConfigurationHelper

java.lang.Object

com.atlassian.confluence.cluster.DefaultClusterConfigurationHelper

All Implemented Interfaces:

ClusterConfigurationHelper, ClusterConfigurationHelperInternal

@ParametersAreNonnullByDefault
public class DefaultClusterConfigurationHelper
extends Object
implements ClusterConfigurationHelperInternal

An implementation of ClusterConfigurationHelper which assumes that a cluster of some sort is being used. The specifics of the underlying clustering technology are handled by the ClusterManager. If no cluster is being used, then this class is not appropriate, and NonClusterConfigurationHelper should be used instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER
static String	CLUSTER_ADDRESS
static String	CLUSTER_AUTHENTICATION_ENABLED
static String	CLUSTER_AUTHENTICATION_ENABLED_DEFAULT_VAL
static String	CLUSTER_AUTHENTICATION_SECRET
static String	CLUSTER_AWS
static String	CLUSTER_AWS_ACCESS_KEY
static String	CLUSTER_AWS_HOST_HEADER
static String	CLUSTER_AWS_IAM_ROLE
static String	CLUSTER_AWS_REGION
static String	CLUSTER_AWS_SECRET_KEY
static String	CLUSTER_AWS_SECURITY_GROUP_NAME
static String	CLUSTER_AWS_TAG_KEY
static String	CLUSTER_AWS_TAG_VALUE
static String	CLUSTER_HOME
static String	CLUSTER_INTERFACE
static String	CLUSTER_JOIN_TYPE
static String	CLUSTER_MULTICAST_PORT_SYS_PROP
static String	CLUSTER_NAME
static String	CLUSTER_PEERS
static Set<String>	CLUSTER_SETUP_ENTRIES
static String	CLUSTER_TTL
static String	SHARED_HOME
static List<String>	SUPPORTED_SHARED_HOME_CONFIG_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
DefaultClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig, ClusterManager clusterManager, LicenseServiceInternal licenseService, com.atlassian.config.db.DatabaseHelper databaseHelper, com.atlassian.config.db.HibernateConfig hibernateConfig, ClusterCompatibilityValidator clusterCompatibilityValidator) Deprecated. since 7.17.3, Replaced by DefaultClusterConfigurationHelper( applicationConfig, clusterManager, licenseService, databaseHelper, hibernateConfig, clusterCompatibilityValidator, secureTokenGenerator)
DefaultClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig, ClusterManager clusterManager, LicenseServiceInternal licenseService, com.atlassian.config.db.DatabaseHelper databaseHelper, com.atlassian.config.db.HibernateConfig hibernateConfig, ClusterCompatibilityValidator clusterCompatibilityValidator, com.atlassian.security.random.SecureTokenGenerator secureTokenGenerator)

Method Summary

Modifier and Type	Method and Description
void	bootstrapCluster() Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration
void	bootstrapCluster(BootstrapDatabaseAccessor.BootstrapDatabaseData bootstrapDatabaseData) Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Deprecated.
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress, @Nullable String networkInterfaceName) Deprecated.
void	createCluster(String clusterName, File clusterHome, @Nullable String networkInterfaceName, ClusterJoinConfig joinConfig) Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.
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.
List<NetworkInterface>	getClusterableInterfaces() Return a list of interfaces suitable for clustered communication.
protected Optional<com.atlassian.config.ApplicationConfig>	getClusterApplicationConfig()
com.atlassian.fugue.Option<ClusterJoinConfig>	getJoinConfig() Deprecated. since 7.0.1. Use ClusterConfigurationHelper.joinConfig()
Optional<String>	getSharedBuildNumber() Get the build number stored in the confluence.cfg.xml file in the shared home folder
com.atlassian.fugue.Option<File>	getSharedHome() Deprecated. since 7.0.1. Use ClusterConfigurationHelper.sharedHome()
Optional<Object>	getSharedProperty(Object key) Get the value of a property stored in the confluence.cfg.xml config file (in the shared home folder)
boolean	isClusteredInstance()
boolean	isClusterHomeConfigured()
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Deprecated.
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress, @Nullable String networkInterfaceName) Deprecated.
void	joinCluster(String clusterName, File clusterHome, @Nullable String networkInterfaceName, ClusterJoinConfig joinConfig) Deprecated.
void	populateExistingClusterSetupConfig() Merges the config file in shared home into the current config file (in local home folder).
void	publishConfiguration() Deprecated. since 5.9
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

joinConfig, sharedHome

Field Detail

CLUSTER

public static final String CLUSTER

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

CLUSTER_INTERFACE

public static final String CLUSTER_INTERFACE

See Also:

Constant Field Values

CLUSTER_JOIN_TYPE

public static final String CLUSTER_JOIN_TYPE

See Also:

Constant Field Values

CLUSTER_ADDRESS

public static final String CLUSTER_ADDRESS

See Also:

Constant Field Values

CLUSTER_TTL

public static final String CLUSTER_TTL

See Also:

Constant Field Values

CLUSTER_MULTICAST_PORT_SYS_PROP

public static final String CLUSTER_MULTICAST_PORT_SYS_PROP

See Also:

Constant Field Values

CLUSTER_PEERS

public static final String CLUSTER_PEERS

See Also:

Constant Field Values

CLUSTER_AWS

public static final String CLUSTER_AWS

See Also:

Constant Field Values

CLUSTER_AWS_ACCESS_KEY

public static final String CLUSTER_AWS_ACCESS_KEY

See Also:

Constant Field Values

CLUSTER_AWS_SECRET_KEY

public static final String CLUSTER_AWS_SECRET_KEY

See Also:

Constant Field Values

CLUSTER_AWS_IAM_ROLE

public static final String CLUSTER_AWS_IAM_ROLE

See Also:

Constant Field Values

CLUSTER_AWS_TAG_KEY

public static final String CLUSTER_AWS_TAG_KEY

See Also:

Constant Field Values

CLUSTER_AWS_TAG_VALUE

public static final String CLUSTER_AWS_TAG_VALUE

See Also:

Constant Field Values

CLUSTER_AWS_REGION

public static final String CLUSTER_AWS_REGION

See Also:

Constant Field Values

CLUSTER_AWS_HOST_HEADER

public static final String CLUSTER_AWS_HOST_HEADER

See Also:

Constant Field Values

CLUSTER_AWS_SECURITY_GROUP_NAME

public static final String CLUSTER_AWS_SECURITY_GROUP_NAME

See Also:

Constant Field Values

CLUSTER_HOME

public static final String CLUSTER_HOME

See Also:

Constant Field Values

SHARED_HOME

public static final String SHARED_HOME

See Also:

Constant Field Values

CLUSTER_AUTHENTICATION_ENABLED

public static final String CLUSTER_AUTHENTICATION_ENABLED

See Also:

Constant Field Values

CLUSTER_AUTHENTICATION_ENABLED_DEFAULT_VAL

public static final String CLUSTER_AUTHENTICATION_ENABLED_DEFAULT_VAL

See Also:

Constant Field Values

CLUSTER_AUTHENTICATION_SECRET

public static final String CLUSTER_AUTHENTICATION_SECRET

See Also:

Constant Field Values

SUPPORTED_SHARED_HOME_CONFIG_PROPERTIES

public static final List<String> SUPPORTED_SHARED_HOME_CONFIG_PROPERTIES

CLUSTER_SETUP_ENTRIES

public static final Set<String> CLUSTER_SETUP_ENTRIES

Constructor Detail

DefaultClusterConfigurationHelper

public DefaultClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig,
                                         ClusterManager clusterManager,
                                         LicenseServiceInternal licenseService,
                                         com.atlassian.config.db.DatabaseHelper databaseHelper,
                                         com.atlassian.config.db.HibernateConfig hibernateConfig,
                                         ClusterCompatibilityValidator clusterCompatibilityValidator,
                                         com.atlassian.security.random.SecureTokenGenerator secureTokenGenerator)

Since:

7.17.3

DefaultClusterConfigurationHelper

@Deprecated
public DefaultClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig,
                                                     ClusterManager clusterManager,
                                                     LicenseServiceInternal licenseService,
                                                     com.atlassian.config.db.DatabaseHelper databaseHelper,
                                                     com.atlassian.config.db.HibernateConfig hibernateConfig,
                                                     ClusterCompatibilityValidator clusterCompatibilityValidator)

Deprecated. since 7.17.3, Replaced by DefaultClusterConfigurationHelper( applicationConfig, clusterManager, licenseService, databaseHelper, hibernateConfig, clusterCompatibilityValidator, secureTokenGenerator)

Method Detail

getClusterApplicationConfig

protected Optional<com.atlassian.config.ApplicationConfig> getClusterApplicationConfig()

Returns:

ApplicationConfig for the cluster if the cluster config file exists otherwise an empty Optional

createClusterConfig

public void createClusterConfig()

Description copied from interface: ClusterConfigurationHelperInternal

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.

Specified by:

createClusterConfig in interface ClusterConfigurationHelperInternal

populateExistingClusterSetupConfig

public void populateExistingClusterSetupConfig()

Description copied from interface: ClusterConfigurationHelperInternal

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.

Specified by:

populateExistingClusterSetupConfig in interface ClusterConfigurationHelperInternal

saveSharedProperty

public void saveSharedProperty(Object key,
                               Object value)

Description copied from interface: ClusterConfigurationHelperInternal

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

Specified by:

saveSharedProperty in interface ClusterConfigurationHelperInternal

Parameters:

key - the key of the property

value - the value of the property

getSharedProperty

public Optional<Object> getSharedProperty(Object key)

Description copied from interface: ClusterConfigurationHelperInternal

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

Specified by:

getSharedProperty in interface ClusterConfigurationHelperInternal

Parameters:

key - the key of the property

Returns:

the value of the property

saveSharedBuildNumber

public void saveSharedBuildNumber(String sharedBuildNumber)

Description copied from interface: ClusterConfigurationHelperInternal

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

Specified by:

saveSharedBuildNumber in interface ClusterConfigurationHelperInternal

Parameters:

sharedBuildNumber - the shared build number to be saved

getSharedBuildNumber

public Optional<String> getSharedBuildNumber()

Description copied from interface: ClusterConfigurationHelperInternal

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

Specified by:

getSharedBuildNumber in interface ClusterConfigurationHelperInternal

Returns:

the shared build number

saveSetupConfigIntoSharedHome

public void saveSetupConfigIntoSharedHome()

Description copied from interface: ClusterConfigurationHelperInternal

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

Specified by:

saveSetupConfigIntoSharedHome in interface ClusterConfigurationHelperInternal

isClusteredInstance

public boolean isClusteredInstance()

Specified by:

isClusteredInstance in interface ClusterConfigurationHelper

Returns:

true if the application is currently configured to be part of a cluster, otherwise false.

isClusterHomeConfigured

public boolean isClusterHomeConfigured()

Specified by:

isClusterHomeConfigured in interface ClusterConfigurationHelper

Returns:

true if the application has the confluence.cluster.home property set, otherwise false.

joinCluster

@Deprecated
public void joinCluster(String clusterName,
                                    File clusterHome,
                                    InetAddress clusterAddress)
                             throws ClusterException

Deprecated.

Specified by:

joinCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error joining the cluster.

joinCluster

@Deprecated
public void joinCluster(String clusterName,
                                    File clusterHome,
                                    InetAddress clusterAddress,
                                    @Nullable String networkInterfaceName)
                             throws ClusterException

Deprecated.

Specified by:

joinCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error joining the cluster.

joinCluster

@Deprecated
public void joinCluster(String clusterName,
                                    File clusterHome,
                                    @Nullable String networkInterfaceName,
                                    ClusterJoinConfig joinConfig)
                             throws ClusterException

Deprecated.

Specified by:

joinCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error joining the cluster.

createCluster

@Deprecated
public void createCluster(String clusterName,
                                      File clusterHome,
                                      InetAddress clusterAddress)
                               throws ClusterException

Deprecated.

Description copied from interface: ClusterConfigurationHelper

Creates a new cluster with the given name as long as the given cluster does not exist.

Specified by:

createCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error setting up the cluster.

createCluster

@Deprecated
public void createCluster(String clusterName,
                                      File clusterHome,
                                      InetAddress clusterAddress,
                                      @Nullable String networkInterfaceName)
                               throws ClusterException

Deprecated.

Description copied from interface: ClusterConfigurationHelper

Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.

Specified by:

createCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error setting up the cluster.

createCluster

public void createCluster(String clusterName,
                          File clusterHome,
                          @Nullable String networkInterfaceName,
                          ClusterJoinConfig joinConfig)
                   throws ClusterException

Description copied from interface: ClusterConfigurationHelper

Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.

Specified by:

createCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if an error setting up the cluster.

bootstrapCluster

public void bootstrapCluster(BootstrapDatabaseAccessor.BootstrapDatabaseData bootstrapDatabaseData)
                      throws ClusterException

Description copied from interface: ClusterConfigurationHelper

Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration

Specified by:

bootstrapCluster in interface ClusterConfigurationHelper

Parameters:

bootstrapDatabaseData - contains the build number and cluster upgrade state information to decide whether this node can join

Throws:

ClusterException - if there was an error configuring the cluster manager, or if the licensed nodes were exceeded by joining the cluster.

bootstrapCluster

public void bootstrapCluster()
                      throws ClusterException

Description copied from interface: ClusterConfigurationHelper

Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration

Specified by:

bootstrapCluster in interface ClusterConfigurationHelper

Throws:

ClusterException - if there was an error configuring the cluster manager, or if the licensed nodes were exceeded by joining the cluster.

publishConfiguration

@Deprecated
public void publishConfiguration()

Deprecated. since 5.9

Description copied from interface: ClusterConfigurationHelper

Publish the configuration of this instance to the shared cluster cache, where it can be loaded by subsequent nodes during setup.

Specified by:

publishConfiguration in interface ClusterConfigurationHelper

getClusterableInterfaces

public List<NetworkInterface> getClusterableInterfaces()

Description copied from interface: ClusterConfigurationHelper

Return a list of interfaces suitable for clustered communication. The list is ordered for suitable rendering in a UI.

Specified by:

getClusterableInterfaces in interface ClusterConfigurationHelper

Returns:

List of NetworkInterface objects

getSharedHome

@Deprecated
public com.atlassian.fugue.Option<File> getSharedHome()

Deprecated. since 7.0.1. Use ClusterConfigurationHelper.sharedHome()

Description copied from interface: ClusterConfigurationHelper

Return the shared home directory if one has been configured.

Specified by:

getSharedHome in interface ClusterConfigurationHelper

Returns:

shared home directory

createSharedHome

public void createSharedHome()

Description copied from interface: ClusterConfigurationHelperInternal

Creates shared home directory if it does not exist already.

Shared home is created only if not clustering.

Specified by:

createSharedHome in interface ClusterConfigurationHelperInternal

getJoinConfig

@Deprecated
public com.atlassian.fugue.Option<ClusterJoinConfig> getJoinConfig()

Deprecated. since 7.0.1. Use ClusterConfigurationHelper.joinConfig()

Description copied from interface: ClusterConfigurationHelper

Returns the configured join config if setup has progressed that far.

Specified by:

getJoinConfig in interface ClusterConfigurationHelper

Returns:

Join configuration