com.pega.pegarules.pub.context

Interface PRCluster

public interface PRCluster

interface to the engine's cluster-tracking component. PRCluster

Version:

$Revision: 143764 $ $Date: 2015-07-10 07:26:04 -0400 (Fri, 10 Jul 2015) $

Author:

clinb

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.util.UUID	NULL_UUID_VALUE
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
void	alterState(ClusterState aState) alters the state of the cluster.
void	broadcastSystemPulse(java.util.Collection<PRPulseMessage> aPulseMessages) Broadcast a list of System Pulse Messages via the Cluster
boolean	checkMembershipConsistency() An implementation-specific check of cluster membership consistency.
boolean	checkNodeId(java.lang.String aNodeId) Check to ensure that a given nodeid is actually unique in the cluster.
boolean	checkProtocolConsistency() Checks that active members in the cluster are using the same cluster protocol.
java.io.Serializable	get(java.lang.String key) finds data based on given key
java.lang.String	getClusterAddress() Get's this node's cluster address.
java.util.UUID	getClusterId(java.lang.String aNodeId) Fetch the Cluster UUID for the given node.
java.lang.String	getClusterName() Get the name of the Cluster.
ClusterExecutor	getDistributedExecutor() Acquire the interface for a Cluster-wide executor implementation, based on the current clustering protocol.
PRDistributedObjectManager	getDistributedObjectManager()
ILockProviderService	getLockProviderService() Returns Lock Provider service
java.util.List<java.util.UUID>	getMemberUuids() Provide a list of the string representation for the UUIDs of all members in the cluster.
java.lang.String	getNodeInfo(java.lang.String aNodeId) Descriptive Member info
java.lang.String	getPotentialClusterMembers() Get a list of potential cluster members to be used for discovery
IPulseProvider	getPulseProvider() Returns Lock Provider service
ClusterState	getState() fetches the state of the cluster
java.net.InetAddress	getThisMembersAddress() Provide the InetAddress associated with this node.
int	getThisMembersPort() Provide the port associated with this node.
java.util.UUID	getThisMembersUuid() Provide the unique identifier associated with the node executing this method.
java.lang.String	getTransportProtocol() name of the transport [implementation] used for Clustering
boolean	hasValidClusterAddress() Does this cluster have a valid cluster address?
boolean	isInitialized()
void	set(java.lang.String key, java.io.Serializable value) Add value to cache which will be available across nodes
void	setInitialized(boolean isInitialized)
void	shutdown() Shut down the cluster and all it's threads

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

NULL_UUID_VALUE

static final java.util.UUID NULL_UUID_VALUE

Method Detail

getState

ClusterState getState()

fetches the state of the cluster

Returns:

current state

checkNodeId

boolean checkNodeId(java.lang.String aNodeId)

Check to ensure that a given nodeid is actually unique in the cluster.

Parameters:

aNodeId -

Returns:

true if aNodeId is NOT actually unique

getClusterName

java.lang.String getClusterName()

Get the name of the Cluster. Each cluster should be uniquely named on the network and all nodes sharing a database should belong to the same cluster.

Returns:

Cluster name

getPotentialClusterMembers

java.lang.String getPotentialClusterMembers()

Get a list of potential cluster members to be used for discovery

Returns:

A string representation of potential cluster members

getNodeInfo

java.lang.String getNodeInfo(java.lang.String aNodeId)

Descriptive Member info

Parameters:

aNodeId -

Returns:

String identifying a node

checkMembershipConsistency

boolean checkMembershipConsistency()

An implementation-specific check of cluster membership consistency. This should check the members of the cluster against what PRPC sees as valid nodes. If nodes exist in the cluster that are not present in PRPC, false is returned. This may simply be because a node has joined the cluster at startup, but has not yet registered in PRPC, which is why this shouldn't throw an exception in this case.

Returns:

true if the cluster is consistent, false if there are cluster members that are not (yet) in PRPC.

checkProtocolConsistency

boolean checkProtocolConsistency()

Checks that active members in the cluster are using the same cluster protocol. In the case that this node determines that other nodes are not using the same protocol or if this node is using a different protocol than that of all other nodes, we log an error/warn message and handle as appropriate.

Returns:

True if the cluster protocol is consistent, false if all nodes do not share the same protocol

alterState

void alterState(ClusterState aState)

alters the state of the cluster.

Parameters:

aState - - new state that should be entered.

getTransportProtocol

java.lang.String getTransportProtocol()

name of the transport [implementation] used for Clustering

Returns:

protocol name

getMemberUuids

java.util.List<java.util.UUID> getMemberUuids()

Provide a list of the string representation for the UUIDs of all members in the cluster.

Returns:

List if unique ids or an empty List if there is no cluster protocol specified.

getThisMembersUuid

java.util.UUID getThisMembersUuid()

Provide the unique identifier associated with the node executing this method.

Returns:

unique identifier or null if the cluster protocol is 'default'.

getThisMembersAddress

java.net.InetAddress getThisMembersAddress()

Provide the InetAddress associated with this node. Multiple PRPC nodes may have the same InetAddress. Use getThisMembersUuid() to get unique identifier.

Returns:

address associated with this node.

getThisMembersPort

int getThisMembersPort()

Provide the port associated with this node.

Returns:

port associated with this node.

getClusterAddress

java.lang.String getClusterAddress()

Get's this node's cluster address.

Returns:

the cluster address.

getDistributedExecutor

ClusterExecutor getDistributedExecutor()

Acquire the interface for a Cluster-wide executor implementation, based on the current clustering protocol.

Returns:

implementation of the protocol-specific executor implementation.

getClusterId

java.util.UUID getClusterId(java.lang.String aNodeId)

Fetch the Cluster UUID for the given node.

Parameters:

aNodeId -

Returns:

Cluster UUID corresponding to the node

get

java.io.Serializable get(java.lang.String key)

finds data based on given key

Parameters:

key -

Returns:

value

set

void set(java.lang.String key,
       java.io.Serializable value)

Add value to cache which will be available across nodes

Parameters:

key -

value -

shutdown

void shutdown()

Shut down the cluster and all it's threads

hasValidClusterAddress

boolean hasValidClusterAddress()

Does this cluster have a valid cluster address?

Returns:

true if cluster address is valid.

broadcastSystemPulse

void broadcastSystemPulse(java.util.Collection<PRPulseMessage> aPulseMessages)

Broadcast a list of System Pulse Messages via the Cluster

Parameters:

aPulseMessages - - The list of messages to broadcast

getDistributedObjectManager

PRDistributedObjectManager getDistributedObjectManager()

Returns:

the distributed map (a Cluster-wide Map) manager based on the current clustering protocol.

getLockProviderService

ILockProviderService getLockProviderService()

Returns Lock Provider service

Returns:

implementation of Lock Provider service

getPulseProvider

IPulseProvider getPulseProvider()

Returns Lock Provider service

Returns:

implementation of Lock Provider service

isInitialized

boolean isInitialized()

Returns:

if the cluster is initialized

setInitialized

void setInitialized(boolean isInitialized)

Parameters:

isInitialized - set the initialized parameter