net.kuujo.vertigo.cluster

Interface ClusterConfig

All Superinterfaces:

Config<ClusterConfig>, JsonSerializable

All Known Implementing Classes:

DefaultClusterConfig

public interface ClusterConfig
extends Config<ClusterConfig>

Network cluster configuration.

The cluster configuration is used by Vertigo to determine how the components of a network should be deployed. When a network is deployed in a Vert.x clustered instance, the network can be deployed across the cluster in what is known as the CLUSTER scope. Users can specify in the cluster configuration how a network should be deployed.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_ADDRESS address is the cluster event bus address.
static String	CLUSTER_SCOPE scope is the cluster scope.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddress() Returns the cluster address.
ClusterScope	getScope() Returns the network scope.
ClusterConfig	setAddress(String address) Sets the cluster address.
ClusterConfig	setScope(ClusterScope scope) Sets the network scope.

Field Detail

CLUSTER_ADDRESS

static final String CLUSTER_ADDRESS

address is the cluster event bus address.

See Also:

Constant Field Values

CLUSTER_SCOPE

static final String CLUSTER_SCOPE

scope is the cluster scope.

See Also:

Constant Field Values

Method Detail

setAddress

ClusterConfig setAddress(String address)

Sets the cluster address.

The cluster address is used by Vertigo to deploy components and work with cluster-wide data structures when the network is clustered. If the network is deployed in LOCAL scope then the cluster address does not need to be set up.

Parameters:

address - The cluster address.

Returns:

The cluster configuration.

getAddress

String getAddress()

Returns the cluster address.

Returns:

The cluster event bus address.

setScope

ClusterConfig setScope(ClusterScope scope)

Sets the network scope.

Setting the network's scope to CLUSTER will result in the network's components being deployed across the cluster when Vert.x is a clustered instance. If the cluster scope is being used you must provide an event bus address to the cluster manager. This is the default scope.

If the scope is set to LOCAL then the network will always be deployed in the local Vert.x instance regardless of the Vert.x cluster state.

Parameters:

scope - The network scope.

Returns:

The cluster configuration.

getScope

ClusterScope getScope()

Returns the network scope.

Returns:

The network scope. Defaults to CLUSTER