org.adroitlogic.x.feature.clustering.impl

Class ClusteringFeatureImpl

java.lang.Object

org.adroitlogic.x.api.AbstractIntegrationFeature

org.adroitlogic.x.feature.clustering.impl.ClusteringFeatureImpl

All Implemented Interfaces:

org.adroitlogic.x.api.dec.Initializable, ClusteringFeature

@IntegrationFeature(clazz=ClusteringFeature.class,
                    name="clustering")
public class ClusteringFeatureImpl
extends org.adroitlogic.x.api.AbstractIntegrationFeature
implements ClusteringFeature

Implementation of the clustering feature which will expose all required functionalities of the XClusterManager

Since:

17.01

Author:

Manjula Piyumal

Constructor Summary

Constructors

Constructor and Description
ClusteringFeatureImpl()

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.
void	init(org.springframework.context.ApplicationContext context)
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.

Methods inherited from class org.adroitlogic.x.api.AbstractIntegrationFeature

destroy, setProjectConfig, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteringFeatureImpl

public ClusteringFeatureImpl()

Method Detail

init

public void init(org.springframework.context.ApplicationContext context)

Specified by:

init in interface org.adroitlogic.x.api.dec.Initializable

Overrides:

init in class org.adroitlogic.x.api.AbstractIntegrationFeature

getClusterLock

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

Description copied from interface: ClusteringFeature

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)

Specified by:

getClusterLock in interface ClusteringFeature

Parameters:

lockPath - lock path

Returns:

XClusterLock

getNextSequenceNumber

public Optional<Integer> getNextSequenceNumber(String path)

Description copied from interface: ClusteringFeature

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.

Specified by:

getNextSequenceNumber in interface ClusteringFeature

Parameters:

path - path to be used to generate the sequence number

Returns:

next sequence number as an optional

publishControlCommand

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

Description copied from interface: ClusteringFeature

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.

Specified by:

publishControlCommand in interface ClusteringFeature

Parameters:

command - the command to be published

Returns:

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

getStatus

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

Description copied from interface: ClusteringFeature

Get the cluster manager's current Status.

Specified by:

getStatus in interface ClusteringFeature

Returns:

state of the cluster manager

getNodeName

public String getNodeName()

Description copied from interface: ClusteringFeature

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

Specified by:

getNodeName in interface ClusteringFeature

Returns:

Node name

getCommandSpace

public String getCommandSpace()

Description copied from interface: ClusteringFeature

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

Specified by:

getCommandSpace in interface ClusteringFeature

Returns:

command space name

getDomain

public String getDomain()

Description copied from interface: ClusteringFeature

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

Specified by:

getDomain in interface ClusteringFeature

Returns:

domain name

isClusteringEnabled

public boolean isClusteringEnabled()

Description copied from interface: ClusteringFeature

API to check whether the clustering is enabled within the framework

Specified by:

isClusteringEnabled in interface ClusteringFeature

Returns:

true if the clustering is enabled