com.atlassian.confluence.cluster
Interface ClusterConfigurationHelper

All Known Implementing Classes:

DefaultClusterConfigurationHelper

public interface ClusterConfigurationHelper

A facade for interacting with the clustering subsystem

Method Summary

void	bootstrapCluster() Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration
void	createCluster(String clusterName) Creates a new cluster with the given name as long as the given cluster does not exist.
void	createCluster(String clusterName, String networkInterfaceName) Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.
List	getClusterableInterfaces() Return a list of interfaces suitable for clustered communication.
int	getPermittedClusterNodes()
boolean	isClusteredInstance()
boolean	isLicensedClusterNodesExceeded()
void	joinCluster(String clusterName) Join the named cluster, as long as it exists and the licensed member count is not exceeded.
void	joinCluster(String clusterName, String networkInterfaceName) Join the named cluster, on the specified network interface, as long as it exists and the licensed member count is not exceeded.
void	publishConfiguration() Publish the configuration of this instance to the shared cluster cache, where it can be loaded by subsequent nodes during setup.

Method Detail

isClusteredInstance

public boolean isClusteredInstance()

Returns:

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

isLicensedClusterNodesExceeded

public boolean isLicensedClusterNodesExceeded()

Returns:

true if the cluster which this node belongs to has more members than is allowed by the license, otherwise false.

joinCluster

public void joinCluster(String clusterName)
                 throws ClusterException

Join the named cluster, as long as it exists and the licensed member count is not exceeded.

Throws:

ClusterException - if an error joining the cluster.

joinCluster

public void joinCluster(String clusterName,
                        String networkInterfaceName)
                 throws ClusterException

Join the named cluster, on the specified network interface, as long as it exists and the licensed member count is not exceeded.

Throws:

ClusterException - if an error joining the cluster.

createCluster

public void createCluster(String clusterName)
                   throws ClusterException

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

Throws:

ClusterException - if an error setting up the cluster.

createCluster

public void createCluster(String clusterName,
                          String networkInterfaceName)
                   throws ClusterException

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

Throws:

ClusterException - if an error setting up the cluster.

getPermittedClusterNodes

public int getPermittedClusterNodes()

Returns:

the number of clustered nodes permitted by the license on this instance of Confluence.

bootstrapCluster

public void bootstrapCluster()
                      throws ClusterException

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

Throws:

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

publishConfiguration

public void publishConfiguration()

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

getClusterableInterfaces

public List getClusterableInterfaces()

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

Returns:

List of NetworkInterface objects