org.adroitlogic.x.feature.clustering.api

Interface ClusteringFeature

All Known Implementing Classes:

ClusteringFeatureImpl

public interface ClusteringFeature

This is the feature API to use clustering related functionalities. This will expose all required functionalities of the XClusterManager

Since:

17.01

Author:

Manjula Piyumal

Method Summary

Modifier and Type	Method and Description
org.adroitlogic.x.api.clustering.locks.XClusterLock	getClusterLock(String lockPath) Returns a distributed lock unique to the given path.
String	getCommandSpace() Name of the command space to which this cluster manager is listening to.
String	getDomain() Domain of this node.
Optional<Integer>	getNextSequenceNumber(String path) Generates a distributed sequence number which is the next in line of a distributed sequence.
String	getNodeName() Get the name of the cluster manager's node.
org.adroitlogic.x.api.Status	getStatus() Get the cluster manager's current Status.
boolean	isClusteringEnabled() API to check whether the clustering is enabled within the framework
String	publishControlCommand(org.adroitlogic.x.api.clustering.XControlCommand command) Publishes a command to the cluster.

Method Detail

getClusterLock

org.adroitlogic.x.api.clustering.locks.XClusterLock getClusterLock(String lockPath)

Returns a distributed lock unique to the given path. The returned XClusterLock can be used to acquire a lock which will guarantee a critical section between different instances of the cluster manager (project x/ultraESB)

Parameters:

lockPath - lock path

Returns:

XClusterLock

getNextSequenceNumber

Optional<Integer> getNextSequenceNumber(String path)

Generates a distributed sequence number which is the next in line of a distributed sequence. this will return an Optional as the result. Users have to check whether the value is available.

Parameters:

path - path to be used to generate the sequence number

Returns:

next sequence number as an optional

publishControlCommand

String publishControlCommand(org.adroitlogic.x.api.clustering.XControlCommand command)

Publishes a command to the cluster. An XControlCommand instance should be provided as the command. The command will be marshaled and sent to the zookeeper for publishing the command.

Parameters:

command - the command to be published

Returns:

the path of the newly created command ZNode | null if failed

getStatus

org.adroitlogic.x.api.Status getStatus()

Get the cluster manager's current Status.

Returns:

state of the cluster manager

getNodeName

String getNodeName()

Get the name of the cluster manager's node. The node name has to be unique throughput the nodes in the same command space

Returns:

Node name

getCommandSpace

String getCommandSpace()

Name of the command space to which this cluster manager is listening to. The nodes in the same command space will receive the same cluster commands

Returns:

command space name

getDomain

String getDomain()

Domain of this node. Domains can be considered as distinct clusters

Returns:

domain name

isClusteringEnabled

boolean isClusteringEnabled()

API to check whether the clustering is enabled within the framework

Returns:

true if the clustering is enabled