csw.services.location.commons

Class ClusterSettings

java.lang.Object

csw.services.location.commons.ClusterSettings

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

Direct Known Subclasses:

ClusterAwareSettings$

public class ClusterSettings
extends java.lang.Object
implements scala.Product, scala.Serializable

ClusterSettings manages Config values required by an ActorSystem to boot. It configures mainly four parameters of an ActorSystem, namely :

- name (Name is defaulted to a constant value so that ActorSystem joins the cluster while booting) - akka.remote.netty.tcp.hostname (The hostname to boot an ActorSystem on) - akka.remote.netty.tcp.port (The port to boot an ActorSystem on) - akka.cluster.seed-nodes (Seed Nodes of the cluster)

ClusterSettings require three values namely : - interfaceName (The network interface where cluster is formed.) - clusterSeeds (The host address of the seedNode of the cluster) - clusterPort (Specify port on which to start this service)

The config values of the ActorSystem will be evaluated based on the above three settings as follows : - akka.remote.netty.tcp.hostname will be ipV4 address based on interfaceName from csw.services.location.internal.Networks - akka.remote.netty.tcp.port will be a random port or if clusterPort is specified that value will be picked - akka.cluster.seed-nodes will pick values of clusterSeeds

If none of the settings are provided then defaults will be picked as follows : - akka.remote.netty.tcp.hostname will be ipV4 address from csw.services.location.internal.Networks - akka.remote.netty.tcp.port will be a random port - akka.cluster.seed-nodes will be empty and an ActorSystem will be created and a cluster will be formed with no Seed Nodes. It will self join the cluster.

ClusterSettings can be given in three ways : - by using the api - by providing system properties - or by providing environment variables

If a ClusterSettings value e.g. clusterPort is provided by more than one ways, then the precedence of consumption will be first from - System Properties - then from Environment variable - and then from ClusterSettings api

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClusterSettings(java.lang.String clusterName, scala.collection.immutable.Map<java.lang.String,java.lang.Object> values)

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that)
java.lang.String	clusterName()
com.typesafe.config.Config	config()
abstract static boolean	equals(java.lang.Object that)
java.lang.String	hostname()
java.lang.String	interfaceName()
ClusterSettings	joinLocal(int port, int... ports)
ClusterSettings	joinLocal(int port, scala.collection.Seq<java.lang.Object> ports)
ClusterSettings	joinSeeds(java.lang.String seeds)
scala.Option<java.lang.Object>	managementPort()
ClusterSettings	onPort(int port)
int	port()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
scala.collection.immutable.List<java.lang.String>	seedNodes()
scala.collection.immutable.List<java.lang.String>	seeds()
akka.actor.ActorSystem	system()
scala.collection.immutable.Map<java.lang.String,java.lang.Object>	values()
ClusterSettings	withEntries(scala.collection.immutable.Map<java.lang.String,java.lang.Object> entries)
ClusterSettings	withInterface(java.lang.String name)
ClusterSettings	withManagementPort(int port)

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ClusterSettings

public ClusterSettings(java.lang.String clusterName,
                       scala.collection.immutable.Map<java.lang.String,java.lang.Object> values)

Method Detail

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

joinLocal

public ClusterSettings joinLocal(int port,
                                 int... ports)

clusterName

public java.lang.String clusterName()

values

public scala.collection.immutable.Map<java.lang.String,java.lang.Object> values()

withEntries

public ClusterSettings withEntries(scala.collection.immutable.Map<java.lang.String,java.lang.Object> entries)

withInterface

public ClusterSettings withInterface(java.lang.String name)

withManagementPort

public ClusterSettings withManagementPort(int port)

joinSeeds

public ClusterSettings joinSeeds(java.lang.String seeds)

joinLocal

public ClusterSettings joinLocal(int port,
                                 scala.collection.Seq<java.lang.Object> ports)

onPort

public ClusterSettings onPort(int port)

interfaceName

public java.lang.String interfaceName()

hostname

public java.lang.String hostname()

port

public int port()

managementPort

public scala.Option<java.lang.Object> managementPort()

seeds

public scala.collection.immutable.List<java.lang.String> seeds()

seedNodes

public scala.collection.immutable.List<java.lang.String> seedNodes()

config

public com.typesafe.config.Config config()

system

public akka.actor.ActorSystem system()