com.atlassian.confluence.cluster

Interface ClusterConfigurationHelper

All Known Implementing Classes:

DefaultClusterConfigurationHelper, NonClusterConfigurationHelper

public interface ClusterConfigurationHelper

A facade for interacting with the clustering subsystem

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) Deprecated. since 5.5.1. See createCluster(String, java.io.File, java.net.InetAddress) instead
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Creates a new cluster with the given name as long as the given cluster does not exist.
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress, String networkInterfaceName) Creates a new cluster with the given name, on the specified network interface, as long as the given cluster does not exist.
void	createCluster(String clusterName, File clusterHome, String networkInterfaceName) Deprecated. since 5.5.1. See createCluster(String, java.io.File, java.net.InetAddress, String) instead
List<NetworkInterface>	getClusterableInterfaces() Return a list of interfaces suitable for clustered communication.
int	getPermittedClusterNodes() Deprecated. Since 5.6. Use LicenseService.isLicensedForDataCenter() instead as licensing is now based on clustering capability, not the number of nodes.
com.atlassian.fugue.Option<File>	getSharedHome() Return the shared home directory if one has been configured.
boolean	isClusteredInstance()
boolean	isLicensedClusterNodesExceeded() Deprecated. Since 5.6. Use LicenseService.isLicensedForDataCenter() instead as licensing is now based on clustering capability, not the number of nodes.
void	joinCluster(String clusterName, File clusterHome) Deprecated. since 5.5.1. See joinCluster(String, java.io.File, java.net.InetAddress) instead
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Join the named cluster, as long as it exists and the licensed member count is not exceeded.
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress, 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	joinCluster(String clusterName, File clusterHome, String networkInterfaceName) Deprecated. since 5.5.1. See joinCluster(String, java.io.File, java.net.InetAddress, String) instead
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

boolean isClusteredInstance()

Returns:

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

isLicensedClusterNodesExceeded

@Deprecated
boolean isLicensedClusterNodesExceeded()

Deprecated. Since 5.6. Use LicenseService.isLicensedForDataCenter() instead as licensing is now based on clustering capability, not the number of nodes.

Returns:

Always returns false as the licensing model has changed.

joinCluster

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

Deprecated. since 5.5.1. See joinCluster(String, java.io.File, java.net.InetAddress) instead

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

void joinCluster(String clusterName,
                 File clusterHome,
                 InetAddress clusterAddress)
          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

@Deprecated
void joinCluster(String clusterName,
                             File clusterHome,
                             String networkInterfaceName)
                      throws ClusterException

Deprecated. since 5.5.1. See joinCluster(String, java.io.File, java.net.InetAddress, String) instead

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.

joinCluster

void joinCluster(String clusterName,
                 File clusterHome,
                 InetAddress clusterAddress,
                 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

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

Deprecated. since 5.5.1. See createCluster(String, java.io.File, java.net.InetAddress) instead

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

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

@Deprecated
void createCluster(String clusterName,
                               File clusterHome,
                               String networkInterfaceName)
                        throws ClusterException

Deprecated. since 5.5.1. See createCluster(String, java.io.File, java.net.InetAddress, String) instead

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.

createCluster

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

@Deprecated
int getPermittedClusterNodes()

Deprecated. Since 5.6. Use LicenseService.isLicensedForDataCenter() instead as licensing is now based on clustering capability, not the number of nodes.

Returns:

if licensed for clustering, then returns Integer.MAX_VALUE, otherwise returns 0.

bootstrapCluster

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

void publishConfiguration()

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

getClusterableInterfaces

List<NetworkInterface> 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

getSharedHome

com.atlassian.fugue.Option<File> getSharedHome()

Return the shared home directory if one has been configured.

Returns:

shared home directory