com.atlassian.confluence.cluster

Interface ClusterSetupValidator

All Known Implementing Classes:

DefaultClusterSetupValidator

public interface ClusterSetupValidator

Simple service that validates the user-inputted parameters required to setup a cluster.

Method Summary

Modifier and Type	Method and Description
MessageHolder	validateAll(String clusterName, String clusterHome, Boolean generateAddress, String clusterAddress, String networkInterface, MessageHolder result) Deprecated. since 5.9
MessageHolder	validateAll(String clusterName, String clusterHome, String joinMethod, Boolean generateAddress, String clusterAddress, String clusterPeersString, String networkInterface, MessageHolder result) Validates all cluster parameters.
MessageHolder	validateClusterAddress(Boolean generateAddress, String clusterAddress, MessageHolder result) Validates just the cluster Address
MessageHolder	validateClusterHome(String clusterHome, MessageHolder result) Validates just the cluster Home
MessageHolder	validateClusterName(String clusterName, MessageHolder result) Validates just the cluster Name
MessageHolder	validateClusterPeers(String clusterPeersString, MessageHolder result) Validates the cluster peers
MessageHolder	validateNetworkInterface(String networkInterface, MessageHolder result) Validates just the cluster network address

Method Detail

validateAll

@Deprecated
MessageHolder validateAll(String clusterName,
                                      String clusterHome,
                                      Boolean generateAddress,
                                      String clusterAddress,
                                      String networkInterface,
                                      MessageHolder result)

Deprecated. since 5.9

Validates all cluster parameters.

Parameters:

clusterName - must be a non-empty string

clusterHome - must be a valid filepath to a readable directory

generateAddress - whether or not the cluster multicast address should be auto generated

clusterAddress - must be a valid IP multicast address

networkInterface - no restrictions yet, assuming it will be correct.

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateAll

MessageHolder validateAll(String clusterName,
                          String clusterHome,
                          String joinMethod,
                          Boolean generateAddress,
                          String clusterAddress,
                          String clusterPeersString,
                          String networkInterface,
                          MessageHolder result)

Validates all cluster parameters.

Parameters:

clusterName - must be a non-empty string

clusterHome - must be a valid filepath to a readable directory

joinMethod - which cluster join method to use

generateAddress - whether or not the cluster multicast address should be auto generated

clusterAddress - must be a valid IP multicast address

clusterPeersString - comma separated string of cluster node IPs

networkInterface - no restrictions yet, assuming it will be correct.

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateClusterName

MessageHolder validateClusterName(String clusterName,
                                  MessageHolder result)

Validates just the cluster Name

Parameters:

clusterName - must be a non-empty string

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateClusterHome

MessageHolder validateClusterHome(String clusterHome,
                                  MessageHolder result)

Validates just the cluster Home

Parameters:

clusterHome - must be a valid filepath to a readable directory

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateClusterPeers

MessageHolder validateClusterPeers(String clusterPeersString,
                                   MessageHolder result)

Validates the cluster peers

Parameters:

clusterPeersString - comma-separated string of cluster node IPs

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateClusterAddress

MessageHolder validateClusterAddress(Boolean generateAddress,
                                     String clusterAddress,
                                     MessageHolder result)

Validates just the cluster Address

Parameters:

generateAddress - whether or not the cluster multicast address should be auto generated

clusterAddress - must be a valid IP multicast address

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors

validateNetworkInterface

MessageHolder validateNetworkInterface(String networkInterface,
                                       MessageHolder result)

Validates just the cluster network address

Parameters:

networkInterface - The network interface to be used

result - The messageHolder that errors are put into

Returns:

the messageHolder, populated with errors