org.adroitlogic.x.clustering.failover.strategy.paths

Class GroupFailoverClusterPaths

java.lang.Object

org.adroitlogic.x.clustering.failover.FailoverClusterPaths

org.adroitlogic.x.clustering.failover.strategy.paths.GroupFailoverClusterPaths

public class GroupFailoverClusterPaths
extends FailoverClusterPaths

ZNode path structure used by the GroupFailoverStrategy.

Since:

17.01

Author:

Imesha Sudasingha

Field Summary

Fields inherited from class org.adroitlogic.x.clustering.failover.FailoverClusterPaths

clusterPaths, failoverZNodePath, failoverZNodeRoot, strategiesZNodePath, strategiesZNodeRoot, strategyZNodePath, strategyZNodeRoot

Constructor Summary

Constructors

Constructor and Description
GroupFailoverClusterPaths(String groupName)

Method Summary

Modifier and Type	Method and Description
protected void	clearAllClusterPaths(org.apache.curator.framework.CuratorFramework client) Clears all cluster paths
protected void	createAllClusterPaths(org.apache.curator.framework.CuratorFramework client) Creates all cluster paths
void	createAllEphemeralNodes(org.apache.curator.framework.CuratorFramework client) This method will be called whenever a connection reconnection happens.
void	createPathStructure(org.apache.curator.framework.CuratorFramework client, Set<String> groupNames) Creates the path structure, {active, actingAs, registered} ZNode paths under each group name
String	getActingAsNodesZNodePath(String groupName)
String	getActingAsNodesZNodePath(String groupName, String nodeName)
String	getActiveNodesZNodePath(String groupName)
String	getClusterLockZNodePathSuffix(String nodeName) Get the path, on which a cluster lock to be taken whenever a distributed lock has to be acquired to start failover.
String	getGroupName()
String	getGroupZNodePath(String groupName) ZNode path to a given group.
String	getMyNodeActiveEphemeralZNodePath()
String	getRegisteredNodesZNodePath(String groupName)
String	getStrategyName() Get the name of the strategy to which this cluster path pattern is binded to
protected void	initializeClusterPaths() Initializes the cluster paths

Methods inherited from class org.adroitlogic.x.clustering.failover.FailoverClusterPaths

clearAll, createAll, getClusterPaths, getFailoverZNodePath, getFailoverZNodeRoot, getStrategiesZNodePath, getStrategiesZNodeRoot, getStrategyZNodePath, getStrategyZNodeRoot, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupFailoverClusterPaths

public GroupFailoverClusterPaths(String groupName)

Method Detail

initializeClusterPaths

protected void initializeClusterPaths()

Description copied from class: FailoverClusterPaths

Initializes the cluster paths

Specified by:

initializeClusterPaths in class FailoverClusterPaths

See Also:

FailoverClusterPaths.initialize(ClusterPaths)

createAllClusterPaths

protected void createAllClusterPaths(org.apache.curator.framework.CuratorFramework client)

Description copied from class: FailoverClusterPaths

Creates all cluster paths

Specified by:

createAllClusterPaths in class FailoverClusterPaths

Parameters:

client - the curator framework to be used for creation

See Also:

FailoverClusterPaths.createAll(CuratorFramework)

clearAllClusterPaths

protected void clearAllClusterPaths(org.apache.curator.framework.CuratorFramework client)

Description copied from class: FailoverClusterPaths

Clears all cluster paths

Specified by:

clearAllClusterPaths in class FailoverClusterPaths

Parameters:

client - the curator framework to be used for clearing

See Also:

FailoverClusterPaths.clearAll(CuratorFramework)

createAllEphemeralNodes

public void createAllEphemeralNodes(org.apache.curator.framework.CuratorFramework client)

Description copied from class: FailoverClusterPaths

This method will be called whenever a connection reconnection happens. That is, whenever the connection is lost, we cannot guarantee that the ephemeral nodes we created at the beginning still exists as wwe may have lost our session. In order to address that, this method is called whenever the ephemeral nodes has to be created

Specified by:

createAllEphemeralNodes in class FailoverClusterPaths

Parameters:

client - CuratorFramework instance

createPathStructure

public void createPathStructure(org.apache.curator.framework.CuratorFramework client,
                                Set<String> groupNames)

Creates the path structure, {active, actingAs, registered} ZNode paths under each group name

Parameters:

client - CuratorFramework instance

groupNames - set of group names

getGroupZNodePath

public String getGroupZNodePath(String groupName)

ZNode path to a given group. /${STRATEGY_NAME}/${groupName}

Parameters:

groupName - group name

Returns:

ZNode path

getActiveNodesZNodePath

public String getActiveNodesZNodePath(String groupName)

getActingAsNodesZNodePath

public String getActingAsNodesZNodePath(String groupName)

getActingAsNodesZNodePath

public String getActingAsNodesZNodePath(String groupName,
                                        String nodeName)

getRegisteredNodesZNodePath

public String getRegisteredNodesZNodePath(String groupName)

getClusterLockZNodePathSuffix

public String getClusterLockZNodePathSuffix(String nodeName)

Description copied from class: FailoverClusterPaths

Get the path, on which a cluster lock to be taken whenever a distributed lock has to be acquired to start failover.

Specified by:

getClusterLockZNodePathSuffix in class FailoverClusterPaths

Parameters:

nodeName - the name of the node, group etc.

Returns:

cluster lock path

getStrategyName

public String getStrategyName()

Description copied from class: FailoverClusterPaths

Get the name of the strategy to which this cluster path pattern is binded to

Specified by:

getStrategyName in class FailoverClusterPaths

Returns:

strategy name

getGroupName

public String getGroupName()

getMyNodeActiveEphemeralZNodePath

public String getMyNodeActiveEphemeralZNodePath()