io.aeron.samples.cluster

Class ClusterConfig

java.lang.Object

io.aeron.samples.cluster.ClusterConfig

public final class ClusterConfig
extends Object

Wrapper class to simplify cluster configuration. This is sample code and is intended to show a mechanism for managing the configuration of the components required for Aeron Cluster. This code may change between versions and API compatibility is not guaranteed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARCHIVE_CONTROL_PORT_OFFSET
static String	ARCHIVE_SUB_DIR
static int	CLIENT_FACING_PORT_OFFSET
static String	CLUSTER_SUB_DIR
static int	LOG_PORT_OFFSET
static int	MEMBER_FACING_PORT_OFFSET
static int	PORTS_PER_NODE
static int	TRANSFER_PORT_OFFSET

Method Summary

Modifier and Type	Method and Description
AeronArchive.Context	aeronArchiveContext() Gets the configuration's aeron archive context.
void	aeronDirectoryName(String aeronDir) Set the aeron directory for all configuration contexts.
Archive.Context	archiveContext() Gets the configuration's archive context.
void	baseDir(File baseDir) Set the base directory for cluster and archive.
static int	calculatePort(int nodeId, int portBase, int offset) Calculates a port for use with a node based on a specific offset.
ClusteredServiceContainer.Context	clusteredServiceContext() Gets the configuration's clustered service container context.
List<ClusteredServiceContainer.Context>	clusteredServiceContexts() Gets the configuration's list of clustered service container contexts.
String	clusterHostname() Hostname of this node that will receive cluster traffic.
static String	clusterMembers(int startingMemberId, List<String> ingressHostnames, List<String> clusterHostnames, int portBase) String representing the cluster members configuration which can be used for ClusterMember.parse(String).
static String	clusterMembers(List<String> ingressHostnames, List<String> clusterHostnames, int portBase) String representing the cluster members configuration which can be used for ClusterMember.parse(String).
ConsensusModule.Context	consensusModuleContext() Gets the configuration's consensus module context.
static ClusterConfig	create(int startingMemberId, int memberId, List<String> ingressHostnames, List<String> clusterHostnames, int portBase, File parentDir, ClusteredService clusteredService, ClusteredService... additionalServices) Create a new ClusterConfig.
static ClusterConfig	create(int nodeId, List<String> hostnames, int portBase, ClusteredService clusteredService) Create a new ClusterConfig.
static ClusterConfig	create(int nodeId, List<String> ingressHostnames, List<String> clusterHostnames, int portBase, ClusteredService clusteredService, ClusteredService... additionalServices) Create a new ClusterConfig.
void	errorHandler(ErrorHandler errorHandler) Set the same error handler for all contexts.
static String	ingressEndpoints(int startingMemberId, List<String> hostnames, int portBase, int clientFacingPortOffset) Ingress endpoints generated from a list of hostnames.
static String	ingressEndpoints(List<String> hostnames, int portBase, int clientFacingPortOffset) Ingress endpoints generated from a list of hostnames.
String	ingressHostname() Hostname of this node that will receive ingress traffic.
MediaDriver.Context	mediaDriverContext() Gets the configuration's media driver context.
int	memberId() memberId of this node.

Methods inherited from class java.lang.Object

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

Field Detail

PORTS_PER_NODE

public static final int PORTS_PER_NODE

See Also:

Constant Field Values

ARCHIVE_CONTROL_PORT_OFFSET

public static final int ARCHIVE_CONTROL_PORT_OFFSET

See Also:

Constant Field Values

CLIENT_FACING_PORT_OFFSET

public static final int CLIENT_FACING_PORT_OFFSET

See Also:

Constant Field Values

MEMBER_FACING_PORT_OFFSET

public static final int MEMBER_FACING_PORT_OFFSET

See Also:

Constant Field Values

LOG_PORT_OFFSET

public static final int LOG_PORT_OFFSET

See Also:

Constant Field Values

TRANSFER_PORT_OFFSET

public static final int TRANSFER_PORT_OFFSET

See Also:

Constant Field Values

ARCHIVE_SUB_DIR

public static final String ARCHIVE_SUB_DIR

See Also:

Constant Field Values

CLUSTER_SUB_DIR

public static final String CLUSTER_SUB_DIR

See Also:

Constant Field Values

Method Detail

create

public static ClusterConfig create(int startingMemberId,
                                   int memberId,
                                   List<String> ingressHostnames,
                                   List<String> clusterHostnames,
                                   int portBase,
                                   File parentDir,
                                   ClusteredService clusteredService,
                                   ClusteredService... additionalServices)

Create a new ClusterConfig. This call allows for 2 separate lists of hostnames, so that there can be 'external' addresses for ingress requests and 'internal' addresses that will handle all the cluster replication and control traffic.

Parameters:

startingMemberId - id for the first member in the list of entries.

memberId - id for this node.

ingressHostnames - list of hostnames that will receive ingress request traffic.

clusterHostnames - list of hostnames that will receive cluster traffic.

portBase - base port to derive remaining ports from.

parentDir - directory under which the persistent directories will be created.

clusteredService - instance of the clustered service that will run with this configuration.

additionalServices - instances of additional clustered services that will run with this configuration.

Returns:

configuration that wraps all aeron service configuration.

create

public static ClusterConfig create(int nodeId,
                                   List<String> ingressHostnames,
                                   List<String> clusterHostnames,
                                   int portBase,
                                   ClusteredService clusteredService,
                                   ClusteredService... additionalServices)

Create a new ClusterConfig. This call allows for 2 separate lists of hostnames, so that there can be 'external' addresses for ingress requests and 'internal' addresses that will handle all the cluster replication and control traffic.

Parameters:

nodeId - id for this node.

ingressHostnames - list of hostnames that will receive ingress request traffic.

clusterHostnames - list of hostnames that will receive cluster traffic.

portBase - base port to derive remaining ports from.

clusteredService - instance of the clustered service that will run with this configuration.

additionalServices - instances of additional clustered services that will run with this configuration.

Returns:

configuration that wraps all aeron service configuration.

create

public static ClusterConfig create(int nodeId,
                                   List<String> hostnames,
                                   int portBase,
                                   ClusteredService clusteredService)

Create a new ClusterConfig. This only supports a single lists of hostnames.

Parameters:

nodeId - id for this node.

hostnames - list of hostnames that will receive ingress request and cluster traffic.

portBase - base port to derive remaining ports from.

clusteredService - instance of the clustered service that will run on this node.

Returns:

configuration that wraps the detailed aeron service configuration.

errorHandler

public void errorHandler(ErrorHandler errorHandler)

Set the same error handler for all contexts.

Parameters:

errorHandler - to receive errors.

aeronDirectoryName

public void aeronDirectoryName(String aeronDir)

Set the aeron directory for all configuration contexts.

Parameters:

aeronDir - directory to use for aeron.

baseDir

public void baseDir(File baseDir)

Set the base directory for cluster and archive.

Parameters:

baseDir - parent directory to be used for archive and cluster stored data.

mediaDriverContext

public MediaDriver.Context mediaDriverContext()

Gets the configuration's media driver context.

Returns:

configured MediaDriver.Context.

See Also:

MediaDriver.Context

archiveContext

public Archive.Context archiveContext()

Gets the configuration's archive context.

Returns:

configured Archive.Context.

See Also:

Archive.Context

aeronArchiveContext

public AeronArchive.Context aeronArchiveContext()

Gets the configuration's aeron archive context.

Returns:

configured Archive.Context.

See Also:

AeronArchive.Context

consensusModuleContext

public ConsensusModule.Context consensusModuleContext()

Gets the configuration's consensus module context.

Returns:

configured ConsensusModule.Context.

See Also:

ConsensusModule.Context

clusteredServiceContext

public ClusteredServiceContainer.Context clusteredServiceContext()

Gets the configuration's clustered service container context.

Returns:

configured ClusteredServiceContainer.Context.

See Also:

ClusteredServiceContainer.Context

clusteredServiceContexts

public List<ClusteredServiceContainer.Context> clusteredServiceContexts()

Gets the configuration's list of clustered service container contexts.

Returns:

configured list of ClusteredServiceContainer.Context.

See Also:

ClusteredServiceContainer.Context

memberId

public int memberId()

memberId of this node.

Returns:

memberId.

ingressHostname

public String ingressHostname()

Hostname of this node that will receive ingress traffic.

Returns:

ingress hostname.

clusterHostname

public String clusterHostname()

Hostname of this node that will receive cluster traffic.

Returns:

cluster hostname

clusterMembers

public static String clusterMembers(List<String> ingressHostnames,
                                    List<String> clusterHostnames,
                                    int portBase)

String representing the cluster members configuration which can be used for ClusterMember.parse(String).

Parameters:

ingressHostnames - of the cluster members.

clusterHostnames - of the cluster members internal address (can be the same as 'hostnames').

portBase - initial port to derive other port from via appropriate node id and offset.

Returns:

the String which can be used for ClusterMember.parse(String).

clusterMembers

public static String clusterMembers(int startingMemberId,
                                    List<String> ingressHostnames,
                                    List<String> clusterHostnames,
                                    int portBase)

String representing the cluster members configuration which can be used for ClusterMember.parse(String).

Parameters:

startingMemberId - first memberId to be used in the list of clusterMembers. The memberId will increment by 1 from that value for each entry.

ingressHostnames - of the cluster members.

clusterHostnames - of the cluster members internal address (can be the same as 'hostnames').

portBase - initial port to derive other port from via appropriate node id and offset.

Returns:

the String which can be used for ClusterMember.parse(String).

ingressEndpoints

public static String ingressEndpoints(List<String> hostnames,
                                      int portBase,
                                      int clientFacingPortOffset)

Ingress endpoints generated from a list of hostnames.

Parameters:

hostnames - for the cluster members.

portBase - Base port for the cluster

clientFacingPortOffset - Offset for the client facing port

Returns:

a formatted string of ingress endpoints for connecting to a cluster.

ingressEndpoints

public static String ingressEndpoints(int startingMemberId,
                                      List<String> hostnames,
                                      int portBase,
                                      int clientFacingPortOffset)

Ingress endpoints generated from a list of hostnames.

Parameters:

startingMemberId - first memberId to be used when generating the ports.

hostnames - for the cluster members.

portBase - Base port for the cluster

clientFacingPortOffset - Offset for the client facing port

Returns:

a formatted string of ingress endpoints for connecting to a cluster.

calculatePort

public static int calculatePort(int nodeId,
                                int portBase,
                                int offset)

Calculates a port for use with a node based on a specific offset. Can be used with the predefined offsets, e.g. ARCHIVE_CONTROL_PORT_OFFSET or with custom offsets. For custom offsets select a value larger than largest predefined offsets. A value larger than the largest predefined offset, but less than PORTS_PER_NODE is required.

Parameters:

nodeId - The id for the member of the cluster.

portBase - The port base to be used.

offset - The offset to add onto the port base

Returns:

a calculated port, which should be unique for the specified criteria.