com.atlassian.confluence.cluster

Interface ClusterConfigurationHelper

All Known Subinterfaces:

ClusterConfigurationHelperInternal

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, InetAddress clusterAddress) Deprecated. since 5.9 See createCluster(String, java.io.File, String, com.atlassian.confluence.cluster.ClusterJoinConfig)
void	createCluster(String clusterName, File clusterHome, InetAddress clusterAddress, String networkInterfaceName) Deprecated. since 5.9. See createCluster(String, java.io.File, String, com.atlassian.confluence.cluster.ClusterJoinConfig)
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.
List<NetworkInterface>	getClusterableInterfaces() Return a list of interfaces suitable for clustered communication.
com.atlassian.fugue.Option<ClusterJoinConfig>	getJoinConfig() Deprecated. since 7.0.1. Use joinConfig()
com.atlassian.fugue.Option<File>	getSharedHome() Deprecated. since 7.0.1. Use sharedHome()
boolean	isClusteredInstance()
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress) Deprecated. since 5.9 - cluster joining is not supported this way
void	joinCluster(String clusterName, File clusterHome, InetAddress clusterAddress, String networkInterfaceName) Deprecated. since 5.9 - cluster joining is not supported this way
void	joinCluster(String clusterName, File clusterHome, String networkInterfaceName, ClusterJoinConfig joinConfig) Deprecated. since 5.9 - cluster joining is not supported this way
default Optional<ClusterJoinConfig>	joinConfig() Returns the configured join config if setup has progressed that far.
void	publishConfiguration() Deprecated. since 5.9
default Optional<File>	sharedHome() Return the shared home directory if one has been configured.

Method Detail

isClusteredInstance

boolean isClusteredInstance()

Returns:

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

joinCluster

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

Deprecated. since 5.9 - cluster joining is not supported this way

Throws:

ClusterException - if an error joining the cluster.

joinCluster

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

Deprecated. since 5.9 - cluster joining is not supported this way

Throws:

ClusterException - if an error joining the cluster.

joinCluster

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

Deprecated. since 5.9 - cluster joining is not supported this way

Throws:

ClusterException - if an error joining the cluster.

createCluster

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

Deprecated. since 5.9 See createCluster(String, java.io.File, String, com.atlassian.confluence.cluster.ClusterJoinConfig)

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,
                               InetAddress clusterAddress,
                               String networkInterfaceName)
                        throws ClusterException

Deprecated. since 5.9. See createCluster(String, java.io.File, String, com.atlassian.confluence.cluster.ClusterJoinConfig)

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,
                   String networkInterfaceName,
                   ClusterJoinConfig joinConfig)
            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.

LicenseException - if there is an error while checking the license

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

@Deprecated
void publishConfiguration()

Deprecated. since 5.9

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

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

Deprecated. since 7.0.1. Use sharedHome()

Return the shared home directory if one has been configured.

Returns:

shared home directory

sharedHome

default Optional<File> sharedHome()

Return the shared home directory if one has been configured.

Returns:

shared home directory

Since:

7.0.1

getJoinConfig

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

Deprecated. since 7.0.1. Use joinConfig()

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

Returns:

Join configuration

joinConfig

default Optional<ClusterJoinConfig> joinConfig()

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

Returns:

Join configuration

Since:

7.0.1