com.atlassian.confluence.cluster.nonclustered
Class NonClusterConfigurationHelper

java.lang.Object
  com.atlassian.confluence.cluster.nonclustered.NonClusterConfigurationHelper

All Implemented Interfaces:

ClusterConfigurationHelper

public class NonClusterConfigurationHelper
extends java.lang.Object
implements ClusterConfigurationHelper

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

NonClusterConfigurationHelper(com.atlassian.config.ApplicationConfig applicationConfig)

Method Summary

void	bootstrapCluster() Checks whether clustering is enabled, and bootstraps the cluster manager with an appropriate configuration
void	createCluster(java.lang.String clusterName, java.io.File clusterHome) Creates a new cluster with the given name as long as the given cluster does not exist.
void	createCluster(java.lang.String clusterName, java.io.File clusterHome, java.lang.String networkInterfaceName) Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.
java.util.List	getClusterableInterfaces() Return a list of interfaces suitable for clustered communication.
int	getPermittedClusterNodes()
com.atlassian.fugue.Option<java.io.File>	getSharedHome() Return the shared home directory if one has been configured.
boolean	isClusteredInstance()
boolean	isLicensedClusterNodesExceeded()
void	joinCluster(java.lang.String clusterName, java.io.File clusterHome) Join the named cluster, as long as it exists and the licensed member count is not exceeded.
void	joinCluster(java.lang.String clusterName, java.io.File clusterHome, java.lang.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.

Methods inherited from class java.lang.Object

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

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.

isLicensedClusterNodesExceeded

public boolean isLicensedClusterNodesExceeded()

Specified by:

isLicensedClusterNodesExceeded in interface ClusterConfigurationHelper

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(java.lang.String clusterName,
                        java.io.File clusterHome)

Description copied from interface: ClusterConfigurationHelper

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

Specified by:

joinCluster in interface ClusterConfigurationHelper

joinCluster

public void joinCluster(java.lang.String clusterName,
                        java.io.File clusterHome,
                        java.lang.String networkInterfaceName)

Description copied from interface: ClusterConfigurationHelper

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

Specified by:

joinCluster in interface ClusterConfigurationHelper

createCluster

public void createCluster(java.lang.String clusterName,
                          java.io.File clusterHome)

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

createCluster

public void createCluster(java.lang.String clusterName,
                          java.io.File clusterHome,
                          java.lang.String networkInterfaceName)

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

getPermittedClusterNodes

public int getPermittedClusterNodes()

Specified by:

getPermittedClusterNodes in interface ClusterConfigurationHelper

Returns:

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

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 java.util.List 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

public com.atlassian.fugue.Option<java.io.File> getSharedHome()

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