io.scalecube.cluster

Class ClusterConfig

java.lang.Object

io.scalecube.cluster.ClusterConfig

All Implemented Interfaces:

Cloneable

public final class ClusterConfig
extends Object
implements Cloneable

Cluster configuration encapsulate settings needed cluster to create and successfully join.

See Also:

MembershipConfig, FailureDetectorConfig, GossipConfig, TransportConfig

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LOCAL_METADATA_TIMEOUT
static int	DEFAULT_METADATA_TIMEOUT
static int	DEFAULT_WAN_METADATA_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ClusterConfig()

Method Summary

Modifier and Type	Method and Description
ClusterConfig	clone()
String	containerHost() Returns mappedHost.
ClusterConfig	containerHost(String mappedHost) Setter for mappedHost.
Integer	containerPort() Returns mappedPort.
ClusterConfig	containerPort(Integer mappedPort) Setter for mappedPort.
static ClusterConfig	defaultConfig()
static ClusterConfig	defaultLanConfig() Creates ClusterConfig with default settings for cluster on LAN network.
static ClusterConfig	defaultLocalConfig() Creates MembershipConfig with default settings for cluster on local loopback interface.
static ClusterConfig	defaultWanConfig() Creates ClusterConfig with default settings for cluster on WAN network.
ClusterConfig	failureDetector(UnaryOperator<FailureDetectorConfig> op) Applies FailureDetectorConfig settings.
FailureDetectorConfig	failureDetectorConfig()
ClusterConfig	gossip(UnaryOperator<GossipConfig> op) Applies GossipConfig settings.
GossipConfig	gossipConfig()
String	memberAlias() Returns memberAlias.
ClusterConfig	memberAlias(String memberAlias) Setter for memberAlias.
String	memberHost() Deprecated.
ClusterConfig	memberHost(String memberHost) Deprecated.
Integer	memberPort() Deprecated.
ClusterConfig	memberPort(Integer memberPort) Deprecated.
ClusterConfig	membership(UnaryOperator<MembershipConfig> op) Applies MembershipConfig settings.
MembershipConfig	membershipConfig()
<T> T	metadata()
ClusterConfig	metadata(Object metadata) Setter for metadata.
MetadataCodec	metadataCodec()
ClusterConfig	metadataCodec(MetadataCodec metadataCodec) Setter for metadataCodec.
MetadataDecoder	metadataDecoder() Deprecated.
ClusterConfig	metadataDecoder(MetadataDecoder metadataDecoder) Deprecated.
MetadataEncoder	metadataEncoder() Deprecated.
ClusterConfig	metadataEncoder(MetadataEncoder metadataEncoder) Deprecated.
int	metadataTimeout()
ClusterConfig	metadataTimeout(int metadataTimeout) Setter for metadataTimeout.
String	toString()
ClusterConfig	transport(UnaryOperator<TransportConfig> op) Applies TransportConfig settings.
TransportConfig	transportConfig()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METADATA_TIMEOUT

public static final int DEFAULT_METADATA_TIMEOUT

See Also:

Constant Field Values

DEFAULT_WAN_METADATA_TIMEOUT

public static final int DEFAULT_WAN_METADATA_TIMEOUT

See Also:

Constant Field Values

DEFAULT_LOCAL_METADATA_TIMEOUT

public static final int DEFAULT_LOCAL_METADATA_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

ClusterConfig

public ClusterConfig()

Method Detail

defaultConfig

public static ClusterConfig defaultConfig()

defaultLanConfig

public static ClusterConfig defaultLanConfig()

Creates ClusterConfig with default settings for cluster on LAN network.

Returns:

new ClusterConfig

defaultWanConfig

public static ClusterConfig defaultWanConfig()

Creates ClusterConfig with default settings for cluster on WAN network.

Returns:

new ClusterConfig

defaultLocalConfig

public static ClusterConfig defaultLocalConfig()

Creates MembershipConfig with default settings for cluster on local loopback interface.

Returns:

new MembershipConfig

metadata

public <T> T metadata()

metadata

public ClusterConfig metadata(Object metadata)

Setter for metadata.

Parameters:

metadata - metadata

Returns:

new ClusterConfig instance

metadataTimeout

public int metadataTimeout()

metadataTimeout

public ClusterConfig metadataTimeout(int metadataTimeout)

Setter for metadataTimeout.

Parameters:

metadataTimeout - metadata timeout

Returns:

new ClusterConfig instance

metadataCodec

public MetadataCodec metadataCodec()

metadataCodec

public ClusterConfig metadataCodec(MetadataCodec metadataCodec)

Setter for metadataCodec.

Parameters:

metadataCodec - metadata codec

Returns:

new ClusterConfig instance

metadataEncoder

@Deprecated
public MetadataEncoder metadataEncoder()

Deprecated.

Deprecated since 2.4.10 in favor of MetadataCodec.

Returns:

metadataEncoder

metadataEncoder

@Deprecated
public ClusterConfig metadataEncoder(MetadataEncoder metadataEncoder)

Deprecated.

Setter for metadataEncoder. Deprecated since 2.4.10 in favor of MetadataCodec.

Parameters:

metadataEncoder - metadata encoder

Returns:

new ClusterConfig instance

metadataDecoder

@Deprecated
public MetadataDecoder metadataDecoder()

Deprecated.

Deprecated since 2.4.10 in favor of MetadataCodec.

Returns:

metadataDecoder

metadataDecoder

@Deprecated
public ClusterConfig metadataDecoder(MetadataDecoder metadataDecoder)

Deprecated.

Setter for metadataDecoder. Deprecated since 2.4.10 in favor of MetadataCodec.

Parameters:

metadataDecoder - metadata decoder

Returns:

new ClusterConfig instance

memberHost

@Deprecated
public String memberHost()

Deprecated.

Deprecated since 2.4.10 in favor of containerHost().

Returns:

member host

memberHost

@Deprecated
public ClusterConfig memberHost(String memberHost)

Deprecated.

Deprecated since 2.4.10 in favor of containerHost(String).

Parameters:

memberHost - member host

Returns:

new ClusterConfig instance

containerHost

public String containerHost()

Returns mappedHost. mappedHost is a config property for container environments, it's being set for advertising to scalecube cluster some connectable hostname which maps to scalecube transport's hostname on which scalecube transport is listening.

Returns:

mapped host

containerHost

public ClusterConfig containerHost(String mappedHost)

Setter for mappedHost. mappedHost is a config property for container environments, it's being set for advertising to scalecube cluster some connectable hostname which maps to scalecube transport's hostname on which scalecube transport is listening.

Parameters:

mappedHost - mapped host

Returns:

new ClusterConfig instance

memberAlias

public String memberAlias()

Returns memberAlias. memberAlias is a config property which facilitates Member.toString().

Returns:

member alias.

memberAlias

public ClusterConfig memberAlias(String memberAlias)

Setter for memberAlias. memberAlias is a config property which facilitates Member.toString().

Parameters:

memberAlias - member alias

Returns:

new ClusterConfig instance

containerPort

public Integer containerPort()

Returns mappedPort. mappedPort is a config property for container environments, it's being set for advertising to scalecube cluster a port which mapped to scalecube transport's listening port.

Returns:

mapped port

containerPort

public ClusterConfig containerPort(Integer mappedPort)

Setter for mappedPort. mappedPort is a config property for container environments, it's being set for advertising to scalecube cluster a port which mapped to scalecube transport's listening port.

Parameters:

mappedPort - mapped port

Returns:

new ClusterConfig instance

memberPort

@Deprecated
public Integer memberPort()

Deprecated.

Deprecated since 2.4.10 in favor of containerPort().

Returns:

member port

memberPort

@Deprecated
public ClusterConfig memberPort(Integer memberPort)

Deprecated.

Deprecated since 2.4.10 in favor of containerPort(Integer).

Parameters:

memberPort - member port

Returns:

new ClusterConfig instance

transport

public ClusterConfig transport(UnaryOperator<TransportConfig> op)

Applies TransportConfig settings.

Parameters:

op - operator to apply TransportConfig settings

Returns:

new ClusterConfig instance

transportConfig

public TransportConfig transportConfig()

failureDetector

public ClusterConfig failureDetector(UnaryOperator<FailureDetectorConfig> op)

Applies FailureDetectorConfig settings.

Parameters:

op - operator to apply FailureDetectorConfig settings

Returns:

new ClusterConfig instance

failureDetectorConfig

public FailureDetectorConfig failureDetectorConfig()

gossip

public ClusterConfig gossip(UnaryOperator<GossipConfig> op)

Applies GossipConfig settings.

Parameters:

op - operator to apply GossipConfig settings

Returns:

new ClusterConfig instance

gossipConfig

public GossipConfig gossipConfig()

membership

public ClusterConfig membership(UnaryOperator<MembershipConfig> op)

Applies MembershipConfig settings.

Parameters:

op - operator to apply MembershipConfig settings

Returns:

new ClusterConfig instance

membershipConfig

public MembershipConfig membershipConfig()

clone

public ClusterConfig clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object