com.atlassian.confluence.cluster.nonclustered

Class NonClusterConfigurationHelper

java.lang.Object

com.atlassian.confluence.cluster.nonclustered.NonClusterConfigurationHelper

All Implemented Interfaces:

ClusterConfigurationHelper, ClusterConfigurationHelperInternal

public class NonClusterConfigurationHelper
extends Object
implements ClusterConfigurationHelperInternal

An implementation of ClusterConfigurationHelper for use when clustering is not being used. Some methods may throw exceptions if they are used, so isClusteredInstance() should be used to check in advance if the other methods are appropriate to use.

Constructor Summary

Constructors

Constructor and Description
NonClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig)

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	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Deprecated.
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress, String networkInterfaceName) Deprecated.
void	createCluster(String clusterName, File clusterHome, 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.
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()
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Deprecated.
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress, String networkInterfaceName) Deprecated.
void	joinCluster(String clusterName, File clusterHome, 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() Publish the configuration of this instance to the shared cluster cache, where it can be loaded by subsequent nodes during setup.
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

Constructor Detail

NonClusterConfigurationHelper

public NonClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig)

Method Detail

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.

joinCluster

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

Deprecated.

Specified by:

joinCluster in interface ClusterConfigurationHelper

joinCluster

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

Deprecated.

Specified by:

joinCluster in interface ClusterConfigurationHelper

joinCluster

@Deprecated
public void joinCluster(String clusterName,
                                    File clusterHome,
                                    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,
                                      String networkInterfaceName)

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

createCluster

public void createCluster(String clusterName,
                          File clusterHome,
                          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()

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

publishConfiguration

public void publishConfiguration()

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

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

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

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

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

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

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