org.adroitlogic.x.clustering

Class ClusterPaths

java.lang.Object

org.adroitlogic.x.clustering.ClusterPaths

public class ClusterPaths
extends Object

Paths to be used throughout the cluster manager. The path hierarchy is as follows.

• domains - domains are distinct clusters.
  • locks - used to obtain cluster locks in a given domain
  • sequences
  • commands/${commandSpace}

Since:

17.01

Author:

Imesha Sudasingha

Constructor Summary

Constructors

Constructor and Description
ClusterPaths()

Method Summary

Modifier and Type	Method and Description
void	createAll(org.apache.curator.framework.CuratorFramework client) Creates all the paths required for the clustering in the zookeeper.
String	getArchivedCommandPathFromVersion(int version) Generates the ZNode path of an archived command by appending the version number.
String	getArchivedCommandsZNodePath()
String	getArchivedCommandsZNodeRoot()
String	getCommandSpaceZnodePath()
String	getCommandSpaceZnodeRoot()
String	getCommandsZNodePath()
String	getCommandsZNodeRoot()
String	getCurrentCommandPathFromVersion(int version) Generates the ZNode path in which the ZNode to publish a command has to be created
String	getCurrentCommandsZNodePath()
String	getCurrentCommandsZNodeRoot()
String	getDomain()
String	getDomainZNodePath()
String	getDomainZNodeRoot()
String	getLocksZNodePath()
String	getLocksZNodeRoot()
String	getNodeCommandFailedPath(int version) Given a command version, this method returns the
String	getNodeCommandFailedPath(String basePath) Given the command path, generates the
String	getNodeCommandSuccessPath(int version) Given a command version, this method returns the
String	getNodeCommandSuccessPath(String basePath) Given the command path, generates the
String	getNodeName()
String	getSequencesZNodePath()
String	getSequencesZNodeRoot()
ClusterPaths	initialize(String domain, String nodeName, String commandSpace) Creates the paths used by this node's cluster manager for clustering functions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterPaths

public ClusterPaths()

Method Detail

initialize

public ClusterPaths initialize(String domain,
                               String nodeName,
                               String commandSpace)

Creates the paths used by this node's cluster manager for clustering functions.

Parameters:

domain - this node's domain

nodeName - the name of the server node that is being initialized

commandSpace - the space name for the commands

Returns:

the initialized ClusterPaths

createAll

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

Creates all the paths required for the clustering in the zookeeper.

Parameters:

client - curatorFramework instance

getCurrentCommandPathFromVersion

public String getCurrentCommandPathFromVersion(int version)

Generates the ZNode path in which the ZNode to publish a command has to be created

Parameters:

version - version number

Returns:

command path

getArchivedCommandPathFromVersion

public String getArchivedCommandPathFromVersion(int version)

Generates the ZNode path of an archived command by appending the version number.

Parameters:

version - sequence number corresponding to the command

Returns:

command path

getNodeCommandFailedPath

public String getNodeCommandFailedPath(int version)

Given a command version, this method returns the

commandPath/failed

path.

Parameters:

version - command version

Returns:

failed path for command execution reporting

getNodeCommandFailedPath

public String getNodeCommandFailedPath(String basePath)

Given the command path, generates the

commandPath/failed/${nodeName}

Parameters:

basePath - command's path

Returns:

node's command execution failure status reporting path

getNodeCommandSuccessPath

public String getNodeCommandSuccessPath(int version)

Given a command version, this method returns the

commandPath/success

path.

Parameters:

version - command version

Returns:

success path for command execution reporting

getNodeCommandSuccessPath

public String getNodeCommandSuccessPath(String basePath)

Given the command path, generates the

commandPath/success/${nodeName}

Parameters:

basePath - command's path

Returns:

node's command execution success status reporting path

getLocksZNodeRoot

public String getLocksZNodeRoot()

getSequencesZNodeRoot

public String getSequencesZNodeRoot()

getCommandsZNodePath

public String getCommandsZNodePath()

getCommandsZNodeRoot

public String getCommandsZNodeRoot()

getCurrentCommandsZNodeRoot

public String getCurrentCommandsZNodeRoot()

getCurrentCommandsZNodePath

public String getCurrentCommandsZNodePath()

getArchivedCommandsZNodePath

public String getArchivedCommandsZNodePath()

getArchivedCommandsZNodeRoot

public String getArchivedCommandsZNodeRoot()

getNodeName

public String getNodeName()

getDomain

public String getDomain()

getDomainZNodePath

public String getDomainZNodePath()

getDomainZNodeRoot

public String getDomainZNodeRoot()

getLocksZNodePath

public String getLocksZNodePath()

getSequencesZNodePath

public String getSequencesZNodePath()

getCommandSpaceZnodePath

public String getCommandSpaceZnodePath()

getCommandSpaceZnodeRoot

public String getCommandSpaceZnodeRoot()