org.jboss.as.clustering

Interface GroupCommunicationService

All Known Subinterfaces:

GroupMembershipNotifier, GroupRpcDispatcher, GroupStateTransferService

All Known Implementing Classes:

CoreGroupCommunicationService

public interface GroupCommunicationService

Abstraction of a server that provides group communication services to a set of nodes that share a common group communication infrastructure. This is a base interface that provides common methods expected to be used by subinterfaces that provide more useful services.

Version:

$Revision: 104233 $

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
ClusterNode	getClusterNode() Gets the object that represents this node in the current group.
List<ClusterNode>	getClusterNodes() Gets the member nodes that comprise the current group membership.
long	getCurrentViewId() Identifier for the current group topology.
String	getGroupName() The name of the group with which communication occurs.
String	getNodeName() Return the name of this node in the current group.
boolean	isConsistentWith(GroupCommunicationService other) Gets whether this GroupCommunicationService is logically consistent with another service; e.g.
boolean	isCoordinator() Indicates whether this node is the group coordinator.

Method Detail

getClusterNode

ClusterNode getClusterNode()

Gets the object that represents this node in the current group.

Returns:

ClusterNode containing the current node name

getNodeName

String getNodeName()

Return the name of this node in the current group. The name will be the String returned by getClusterNode().getName().

Returns:

The node name

See Also:

getClusterNode()

getGroupName

String getGroupName()

The name of the group with which communication occurs.

Returns:

Name of the current group

getClusterNodes

List<ClusterNode> getClusterNodes()

Gets the member nodes that comprise the current group membership.

Returns:

An array of ClusterNode listing the current members of the group. This array will be in the same order in all nodes in the cluster that have received the current membership view.

getCurrentViewId

long getCurrentViewId()

Identifier for the current group topology. Each time the group topology changes, a new view is computed. A view is a list of members, the first member being the coordinator of the view. Each view also has a distinct identifier.

Returns:

the identifier of the current view

isConsistentWith

boolean isConsistentWith(GroupCommunicationService other)

Gets whether this GroupCommunicationService is logically consistent with another service; e.g. is using common group communication infrastructure.

Parameters:

other - the other GroupCommunicationService. Cannot be null.

Returns:

true if an application can use this service and other together to interact with the same set of nodes.

isCoordinator

boolean isCoordinator()

Indicates whether this node is the group coordinator.

Returns:

true if this node is the coordinator, false otherwise