org.jboss.as.clustering.impl

Class CoreGroupCommunicationService

java.lang.Object

org.jboss.as.clustering.msc.AsynchronousService<CoreGroupCommunicationService>

org.jboss.as.clustering.impl.CoreGroupCommunicationService

All Implemented Interfaces:

GroupCommunicationService, GroupMembershipNotifier, GroupRpcDispatcher, GroupStateTransferService, org.jboss.msc.service.Service<CoreGroupCommunicationService>, org.jboss.msc.value.Value<CoreGroupCommunicationService>

public class CoreGroupCommunicationService
extends AsynchronousService<CoreGroupCommunicationService>
implements GroupRpcDispatcher, GroupMembershipNotifier, GroupStateTransferService

Implementation of the GroupCommunicationService interface and its direct subinterfaces based on a JGroups MuxRpcDispatcher and a JChannel. TODO: look into decomposing this class: the RPC stuff, the membership stuff and the state transfer stuff could be handled by separate components with this class used to integrate the pieces and expose a common API. The separate components could then be separately testable.

Author:

Sacha Labourey., Bill Burke., Scott.Stark@jboss.org, Brian Stansberry, Vladimir Blagojevic, Galder Zamarreno, Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CoreGroupCommunicationService.GroupView A simple data class containing the current view information as well as change information needed to notify the GroupMembershipListeners about the event that led to this view.
static class	CoreGroupCommunicationService.NoHandlerForRPC Returned when an RPC call arrives for a service that isn't registered.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusteringImplLogger	log The cluster instance log category

Fields inherited from interface org.jboss.msc.service.Service

NULL

Constructor Summary

Constructors

Constructor and Description
CoreGroupCommunicationService(short scope)

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.msc.service.ServiceBuilder<CoreGroupCommunicationService>	build(org.jboss.msc.service.ServiceTarget target, String name)
void	callAsynchMethodOnCluster(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf) Invoke an RPC call on all nodes of the partition/cluster without waiting for any responses.
void	callAsynchMethodOnCluster(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf, boolean unordered) Invoke an RPC call on all nodes of the partition/cluster without waiting for any responses.
void	callAsyncMethodOnCoordinatorNode(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf) Calls method on Cluster coordinator node only.
void	callAsyncMethodOnCoordinatorNode(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf, boolean unordered) Calls method on Cluster coordinator node only.
void	callAsyncMethodOnNode(String serviceName, String methodName, Object[] args, Class<?>[] types, ClusterNode targetNode) Calls method on target node only.
void	callAsyncMethodOnNode(String serviceName, String methodName, Object[] args, Class<?>[] types, ClusterNode targetNode, boolean unordered) Calls method on target node only.
<T> List<T>	callMethodOnCluster(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf) Invoke an RPC call on all nodes of the partition/cluster and return their response values as a list.
<T> List<T>	callMethodOnCluster(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf, ResponseFilter filter) Invoke a synchronous RPC call on all nodes of the partition/cluster and return their response values as a list.
<T> List<T>	callMethodOnCluster(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf, ResponseFilter filter, long methodTimeout, boolean unordered) Invoke an RPC call on all nodes of the partition/cluster and return their response values as a list.
<T> T	callMethodOnCoordinatorNode(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf) Calls method on Cluster coordinator node only.
<T> T	callMethodOnCoordinatorNode(String serviceName, String methodName, Object[] args, Class<?>[] types, boolean excludeSelf, long methodTimeout, boolean unordered) Calls method on Cluster coordinator node only.
<T> T	callMethodOnNode(String serviceName, String methodName, Object[] args, Class<?>[] types, ClusterNode targetNode) Calls method on target node only.
<T> T	callMethodOnNode(String serviceName, String methodName, Object[] args, Class<?>[] types, long methodTimeout, ClusterNode targetNode) Calls method on target node only.
<T> T	callMethodOnNode(String serviceName, String methodName, Object[] args, Class<?>[] types, long methodTimeout, ClusterNode targetNode, boolean unordered) Calls method synchronously on target node only.
void	create()
protected org.jgroups.Channel	createChannel()
protected void	createService()
void	destroy()
protected void	destroyService()
boolean	getAllowSynchronousMembershipNotifications()
protected org.jgroups.Channel	getChannel()
ChannelFactory	getChannelFactory()
String	getChannelStackName()
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.
List<String>	getCurrentView()
long	getCurrentViewId() Identifier for the current group topology.
String	getGroupName() The name of the group with which communication occurs.
String	getJGroupsVersion()
int	getMaxHistoryLength()
long	getMethodCallTimeout() Gets the default period, in ms, that the various callMethodOnXXX methods that don't specify a methodTimeout parameter will wait for a response.
String	getNodeName() Return the name of this node in the current group.
static org.jboss.msc.service.ServiceName	getServiceName(String name)
Future<SerializableStateTransferResult>	getServiceState(String serviceName) Gets the current service state from an existing member of the group.
Future<SerializableStateTransferResult>	getServiceState(String serviceName, ClassLoader classloader) Gets the current service state from an existing member of the group, using the given classloader to deserialize it.
Future<StreamStateTransferResult>	getServiceStateAsStream(String serviceName) Gets an input stream from which can be read the current service state from an existing member of the group.
org.jboss.as.clustering.impl.CoreGroupCommunicationService.State	getState()
long	getStateTransferTimeout()
Executor	getThreadPool()
CoreGroupCommunicationService	getValue()
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.
protected void	logHistory(String pattern, Object... args)
void	registerGroupMembershipListener(GroupMembershipListener listener) Subscribes to receive GroupMembershipListener events.
protected void	registerGroupMembershipListener(GroupMembershipListener listener, boolean sync)
void	registerRPCHandler(String objName, Object subscriber) Register an object upon which RPCs associated with the given serviceName will be invoked.
void	registerRPCHandler(String serviceName, Object handler, ClassLoader classLoader) Use GroupRpcDispatcher.registerRPCHandler(String, Object, ClassResolver) instead.
void	registerRPCHandler(String objName, Object subscriber, org.jboss.marshalling.ClassResolver resolver) Register an object upon which RPCs associated with the given serviceName will be invoked.
void	registerStateTransferProvider(String serviceName, StateTransferProvider provider) Registers the object that can provide state for the service when newly joining group members request it.
void	setAllowSynchronousMembershipNotifications(boolean allowSync) Sets whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g.
void	setChannel(org.jgroups.Channel channel)
void	setChannelFactory(ChannelFactory factory)
void	setChannelStackName(String stackName)
void	setGroupName(String groupName)
void	setMaxHistoryLength(int maxHistoryLength)
void	setMethodCallTimeout(long timeout)
void	setStateTransferTimeout(long timeout)
void	setThreadPool(Executor threadPool)
String	showHistory()
String	showHistoryAsXML()
void	start()
void	start(org.jboss.msc.service.StartContext context)
protected void	startService()
void	stop()
void	stop(org.jboss.msc.service.StopContext context)
protected void	stopService()
void	unregisterGroupMembershipListener(GroupMembershipListener listener) Unsubscribes from receiving GroupMembershipListener events.
protected void	unregisterGroupMembershipListener(GroupMembershipListener listener, boolean sync)
void	unregisterRPCHandler(String objName, Object subscriber) Unregister the service from the partition
void	unregisterStateTransferProvider(String serviceName) Unregisters the object that can provide state for the service.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected ClusteringImplLogger log

The cluster instance log category

Constructor Detail

CoreGroupCommunicationService

public CoreGroupCommunicationService(short scope)

Method Detail

getServiceName

public static org.jboss.msc.service.ServiceName getServiceName(String name)

build

public org.jboss.msc.service.ServiceBuilder<CoreGroupCommunicationService> build(org.jboss.msc.service.ServiceTarget target,
                                                                        String name)

getValue

public CoreGroupCommunicationService getValue()

Specified by:

getValue in interface org.jboss.msc.value.Value<CoreGroupCommunicationService>

See Also:

Value.getValue()

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Specified by:

start in interface org.jboss.msc.service.Service<CoreGroupCommunicationService>

Overrides:

start in class AsynchronousService<CoreGroupCommunicationService>

Throws:

org.jboss.msc.service.StartException

See Also:

Service.start(org.jboss.msc.service.StartContext)

stop

public void stop(org.jboss.msc.service.StopContext context)

Specified by:

stop in interface org.jboss.msc.service.Service<CoreGroupCommunicationService>

Overrides:

stop in class AsynchronousService<CoreGroupCommunicationService>

See Also:

Service.stop(org.jboss.msc.service.StopContext)

isConsistentWith

public boolean isConsistentWith(GroupCommunicationService other)

Description copied from interface: GroupCommunicationService

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

Specified by:

isConsistentWith in interface GroupCommunicationService

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.

getNodeName

public String getNodeName()

Description copied from interface: GroupCommunicationService

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

Specified by:

getNodeName in interface GroupCommunicationService

Returns:

The node name

See Also:

GroupCommunicationService.getClusterNode()

getGroupName

public String getGroupName()

Description copied from interface: GroupCommunicationService

The name of the group with which communication occurs.

Specified by:

getGroupName in interface GroupCommunicationService

Returns:

Name of the current group

getCurrentView

public List<String> getCurrentView()

getCurrentViewId

public long getCurrentViewId()

Description copied from interface: GroupCommunicationService

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.

Specified by:

getCurrentViewId in interface GroupCommunicationService

Returns:

the identifier of the current view

getClusterNodes

public List<ClusterNode> getClusterNodes()

Description copied from interface: GroupCommunicationService

Gets the member nodes that comprise the current group membership.

Specified by:

getClusterNodes in interface GroupCommunicationService

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.

getClusterNode

public ClusterNode getClusterNode()

Description copied from interface: GroupCommunicationService

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

Specified by:

getClusterNode in interface GroupCommunicationService

Returns:

ClusterNode containing the current node name

isCoordinator

public boolean isCoordinator()

Description copied from interface: GroupCommunicationService

Indicates whether this node is the group coordinator.

Specified by:

isCoordinator in interface GroupCommunicationService

Returns:

true if this node is the coordinator, false otherwise

registerRPCHandler

public void registerRPCHandler(String objName,
                      Object subscriber)

Register an object upon which RPCs associated with the given serviceName will be invoked. The partition receives RPC calls from other nodes in the cluster and demultiplexes them, according to a service name, to a particular service. Consequently, each service must first subscribe with a particular service name in the partition. The subscriber does not need to implement any specific interface: the call is handled dynamically through reflection.

Specified by:

registerRPCHandler in interface GroupRpcDispatcher

Parameters:

objName - Name of the subscribing service (demultiplexing key)

subscriber - object to be called when receiving a RPC for its key.

registerRPCHandler

public void registerRPCHandler(String objName,
                      Object subscriber,
                      org.jboss.marshalling.ClassResolver resolver)

Register an object upon which RPCs associated with the given serviceName will be invoked. The partition receives RPC calls from other nodes in the cluster and demultiplexes them, according to a service name, to a particular service. Consequently, each service must first subscribe with a particular service name in the partition. The subscriber does not need to implement any specific interface: the call is handled dynamically through reflection. In cases where the client is using a scoped class resolver, the client will need to provide a reference to the class resolver if the service's RPC calls use custom parameter or response object types. The class resolver will be used to deserialize the RPC and/or response.

Specified by:

registerRPCHandler in interface GroupRpcDispatcher

Parameters:

objName - Name of the subscribing service (demultiplexing key)

subscriber - object to be called when receiving a RPC for its key.

resolver - ClassResolver to be used when marshalling and unmarshalling RPC requests and responses.

registerRPCHandler

public void registerRPCHandler(String serviceName,
                      Object handler,
                      ClassLoader classLoader)

Description copied from interface: GroupRpcDispatcher

Use GroupRpcDispatcher.registerRPCHandler(String, Object, ClassResolver) instead.

Specified by:

registerRPCHandler in interface GroupRpcDispatcher

Parameters:

serviceName - Name of the subscribing service (demultiplexing key)

handler - object to be called when receiving a RPC for its key.

unregisterRPCHandler

public void unregisterRPCHandler(String objName,
                        Object subscriber)

Unregister the service from the partition

Specified by:

unregisterRPCHandler in interface GroupRpcDispatcher

Parameters:

objName - Name of the service key (on which the demultiplexing occurs)

subscriber - The target object that unsubscribes

callMethodOnCluster

public <T> List<T> callMethodOnCluster(String serviceName,
                              String methodName,
                              Object[] args,
                              Class<?>[] types,
                              boolean excludeSelf)
                            throws InterruptedException

Invoke an RPC call on all nodes of the partition/cluster and return their response values as a list. This convenience method is equivalent to GroupRpcDispatcher.callMethodOnCluster(String, String, Object[], Class[], boolean, ResponseFilter, long, boolean) callAsynchMethodOnCluster(serviceName, methodName, args, types, Object.class, excludeSelf, null, methodTimeout, false)} where methodTimeout is the value returned by GroupRpcDispatcher.getMethodCallTimeout().

Specified by:

callMethodOnCluster in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - false if the RPC must also be made on the current node of the partition, true if only on remote nodes

Returns:

an array of responses from nodes that invoked the RPC

Throws:

InterruptedException

callMethodOnCluster

public <T> List<T> callMethodOnCluster(String serviceName,
                              String methodName,
                              Object[] args,
                              Class<?>[] types,
                              boolean excludeSelf,
                              ResponseFilter filter)
                            throws InterruptedException

Invoke a synchronous RPC call on all nodes of the partition/cluster and return their response values as a list. This convenience method is equivalent to GroupRpcDispatcher.callMethodOnCluster(String, String, Object[], Class[], boolean, ResponseFilter, long, boolean) callAsynchMethodOnCluster(serviceName, methodName, args, types, Object.class, excludeSelf, filter, methodTimeout, false)} where methodTimeout is the value returned by GroupRpcDispatcher.getMethodCallTimeout().

Specified by:

callMethodOnCluster in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - false if the RPC must also be made on the current node of the partition, true if only on remote nodes

filter - response filter instance which allows for early termination of the synchronous RPC call. Can be null.

Returns:

an array of responses from remote nodes

Throws:

InterruptedException

callMethodOnCluster

public <T> List<T> callMethodOnCluster(String serviceName,
                              String methodName,
                              Object[] args,
                              Class<?>[] types,
                              boolean excludeSelf,
                              ResponseFilter filter,
                              long methodTimeout,
                              boolean unordered)
                            throws InterruptedException

Invoke an RPC call on all nodes of the partition/cluster and return their response values as a list.

Specified by:

callMethodOnCluster in interface GroupRpcDispatcher

Type Parameters:

T - the expected type of the return values

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - false if the RPC must also be made on the current node of the partition, true if only on remote nodes

filter - response filter instance which allows for early termination of the RPC call once acceptable responses are received. Can be null, in which the call will not return until all nodes have responded.

methodTimeout - max number of ms to wait for response to arrive before returning

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Returns:

a list of responses from remote nodes

Throws:

InterruptedException

callMethodOnCoordinatorNode

public <T> T callMethodOnCoordinatorNode(String serviceName,
                                String methodName,
                                Object[] args,
                                Class<?>[] types,
                                boolean excludeSelf)
                              throws Exception

Calls method on Cluster coordinator node only. The cluster coordinator node is the first node in the current cluster view. This convenience method is equivalent to GroupRpcDispatcher.callMethodOnCoordinatorNode(String, String, Object[], Class[], boolean, long, boolean) callMethodOnCoordinatorNode(serviceName, methodName, args, types, Object.class, excludeSelf, methodTimeout, false)} where methodTimeout is the value returned by GroupRpcDispatcher.getMethodCallTimeout().

Specified by:

callMethodOnCoordinatorNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - true if the RPC should not be made on the current node even if the current node is the coordinator

Returns:

the value returned by the target method

Throws:

Exception

callMethodOnCoordinatorNode

public <T> T callMethodOnCoordinatorNode(String serviceName,
                                String methodName,
                                Object[] args,
                                Class<?>[] types,
                                boolean excludeSelf,
                                long methodTimeout,
                                boolean unordered)
                              throws Exception

Calls method on Cluster coordinator node only. The cluster coordinator node is the first node in the current cluster view.

Specified by:

callMethodOnCoordinatorNode in interface GroupRpcDispatcher

Type Parameters:

T - the expected type of the return value

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - true if the RPC should not be made on the current node even if the current node is the coordinator

methodTimeout - max number of ms to wait for response to arrive before returning

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Returns:

the value returned by the target method

Throws:

Exception

callMethodOnNode

public <T> T callMethodOnNode(String serviceName,
                     String methodName,
                     Object[] args,
                     Class<?>[] types,
                     ClusterNode targetNode)
                   throws Exception

Calls method on target node only. This convenience method is equivalent to GroupRpcDispatcher.callMethodOnNode(String, String, Object[], Class[], long, ClusterNode, boolean) callMethodOnNode(serviceName, methodName, args, types, Object.class, methodTimeout, targetNode, false)} where methodTimeout is the value returned by GroupRpcDispatcher.getMethodCallTimeout().

Specified by:

callMethodOnNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

targetNode - is the target of the call

Returns:

the value returned by the target method

Throws:

Exception

callMethodOnNode

public <T> T callMethodOnNode(String serviceName,
                     String methodName,
                     Object[] args,
                     Class<?>[] types,
                     long methodTimeout,
                     ClusterNode targetNode)
                   throws Exception

Calls method on target node only. This convenience method is equivalent to GroupRpcDispatcher.callMethodOnNode(String, String, Object[], Class[], long, ClusterNode, boolean) callMethodOnNode(serviceName, methodName, args, types, Object.class, methodTimeout, targetNode, false)}.

Specified by:

callMethodOnNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

methodTimeout - max number of ms to wait for response to arrive before returning

targetNode - is the target of the call

Returns:

the value returned by the target method

Throws:

Exception

callMethodOnNode

public <T> T callMethodOnNode(String serviceName,
                     String methodName,
                     Object[] args,
                     Class<?>[] types,
                     long methodTimeout,
                     ClusterNode targetNode,
                     boolean unordered)
                   throws Exception

Calls method synchronously on target node only.

Specified by:

callMethodOnNode in interface GroupRpcDispatcher

Type Parameters:

T - the expected type of the return value

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

methodTimeout - max number of ms to wait for response to arrive before returning

targetNode - is the target of the call

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Returns:

the value returned by the target method

Throws:

Exception

callAsyncMethodOnNode

public void callAsyncMethodOnNode(String serviceName,
                         String methodName,
                         Object[] args,
                         Class<?>[] types,
                         ClusterNode targetNode)
                           throws Exception

Calls method on target node only. The call will return immediately and will not wait for the node to answer. Thus no answer is available. This convenience method is equivalent to GroupRpcDispatcher.callAsyncMethodOnNode(String, String, Object[], Class[], ClusterNode, boolean) callAsynchMethodOnCluster(serviceName, methodName, args, types, methodTimeout, targetNode, false)}.

Specified by:

callAsyncMethodOnNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

targetNode - is the target of the call

Throws:

Exception

callAsyncMethodOnNode

public void callAsyncMethodOnNode(String serviceName,
                         String methodName,
                         Object[] args,
                         Class<?>[] types,
                         ClusterNode targetNode,
                         boolean unordered)
                           throws Exception

Calls method on target node only. The call will return immediately and will not wait for the node to answer. Thus no answer is available.

Specified by:

callAsyncMethodOnNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

targetNode - is the target of the call

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Throws:

Exception

callAsynchMethodOnCluster

public void callAsynchMethodOnCluster(String serviceName,
                             String methodName,
                             Object[] args,
                             Class<?>[] types,
                             boolean excludeSelf)
                               throws InterruptedException

Invoke an RPC call on all nodes of the partition/cluster without waiting for any responses. The call will return immediately after sending a message to the cluster telling nodes to invoke the RPC and will not wait for the nodes to answer. Thus no return values are available. This convenience method is equivalent to callAsynchMethodOnCluster(serviceName, methodName, args, types, excludeSelf, false).

Specified by:

callAsynchMethodOnCluster in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - false if the RPC must also be made on the current node of the partition, true if only on remote nodes

Throws:

InterruptedException

callAsynchMethodOnCluster

public void callAsynchMethodOnCluster(String serviceName,
                             String methodName,
                             Object[] args,
                             Class<?>[] types,
                             boolean excludeSelf,
                             boolean unordered)
                               throws InterruptedException

Invoke an RPC call on all nodes of the partition/cluster without waiting for any responses. The call will return immediately after sending a message to the cluster telling nodes to invoke the RPC and will not wait for the nodes to answer. Thus no return values are available.

Specified by:

callAsynchMethodOnCluster in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - false if the RPC must also be made on the current node of the partition, true if only on remote nodes

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Throws:

InterruptedException

callAsyncMethodOnCoordinatorNode

public void callAsyncMethodOnCoordinatorNode(String serviceName,
                                    String methodName,
                                    Object[] args,
                                    Class<?>[] types,
                                    boolean excludeSelf)
                                      throws Exception

Description copied from interface: GroupRpcDispatcher

Calls method on Cluster coordinator node only. The cluster coordinator node is the first node in the current cluster view. The call will return immediately and will not wait for the node to answer. Thus no answer is available. This convenience method is equivalent to callMethodOnCoordinatorNode(serviceName, methodName, args, types, excludeSelf, false) .

Specified by:

callAsyncMethodOnCoordinatorNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - true if the RPC should not be made on the current node even if the current node is the coordinator

Throws:

Exception

callAsyncMethodOnCoordinatorNode

public void callAsyncMethodOnCoordinatorNode(String serviceName,
                                    String methodName,
                                    Object[] args,
                                    Class<?>[] types,
                                    boolean excludeSelf,
                                    boolean unordered)
                                      throws Exception

Description copied from interface: GroupRpcDispatcher

Calls method on Cluster coordinator node only. The cluster coordinator node is the first node in the current cluster view. The call will return immediately and will not wait for the node to answer. Thus no answer is available.

Specified by:

callAsyncMethodOnCoordinatorNode in interface GroupRpcDispatcher

Parameters:

serviceName - name of the target service name on which calls are invoked

methodName - name of the Java method to be called on remote services

args - array of Java Object representing the set of parameters to be given to the remote method

types - types of the parameters

excludeSelf - true if the RPC should not be made on the current node even if the current node is the coordinator

unordered - true if the HAPartition isn't required to ensure that this RPC is invoked on all nodes in a consistent order with respect to other RPCs originated by the same node

Throws:

Exception

getAllowSynchronousMembershipNotifications

public boolean getAllowSynchronousMembershipNotifications()

setAllowSynchronousMembershipNotifications

public void setAllowSynchronousMembershipNotifications(boolean allowSync)

Sets whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g. JGroups).

Parameters:

allowSync - true if registered listeners that don't implement AsynchHAMembershipExtendedListener or AsynchHAMembershipListener should be notified synchronously of membership changes; false if those listeners can be notified asynchronously. Default is false.

registerGroupMembershipListener

public void registerGroupMembershipListener(GroupMembershipListener listener)

Description copied from interface: GroupMembershipNotifier

Subscribes to receive GroupMembershipListener events.

Specified by:

registerGroupMembershipListener in interface GroupMembershipNotifier

Parameters:

listener - The membership listener object

unregisterGroupMembershipListener

public void unregisterGroupMembershipListener(GroupMembershipListener listener)

Description copied from interface: GroupMembershipNotifier

Unsubscribes from receiving GroupMembershipListener events.

Specified by:

unregisterGroupMembershipListener in interface GroupMembershipNotifier

Parameters:

listener - The listener wishing to unsubscribe

getStateTransferTimeout

public long getStateTransferTimeout()

setStateTransferTimeout

public void setStateTransferTimeout(long timeout)

getServiceState

public Future<SerializableStateTransferResult> getServiceState(String serviceName,
                                                      ClassLoader classloader)

Description copied from interface: GroupStateTransferService

Gets the current service state from an existing member of the group, using the given classloader to deserialize it. Intended to be called by newly joining members of the group.

Specified by:

getServiceState in interface GroupStateTransferService

Parameters:

serviceName - the name of the service

classloader - the ClassLoader to use to deserialize the state when it becomes available. May be null in which case the GroupStateTransferService implementation class' classloader will be used.

Returns:

Future whose get() method will return the service state when it becomes available.

getServiceState

public Future<SerializableStateTransferResult> getServiceState(String serviceName)

Description copied from interface: GroupStateTransferService

Gets the current service state from an existing member of the group. Intended to be called by newly joining members of the group.

Equivalent to getServiceState(serviceName, null).

Specified by:

getServiceState in interface GroupStateTransferService

Parameters:

serviceName - the name of the service

Returns:

Future whose get() method will return the service state when it becomes available.

getServiceStateAsStream

public Future<StreamStateTransferResult> getServiceStateAsStream(String serviceName)

Description copied from interface: GroupStateTransferService

Gets an input stream from which can be read the current service state from an existing member of the group. Intended to be called by newly joining members of the group.

Equivalent to getServiceState(serviceName, null).

Specified by:

getServiceStateAsStream in interface GroupStateTransferService

Parameters:

serviceName - the name of the service

Returns:

Future whose get() method will return the service state when it becomes available.

registerStateTransferProvider

public void registerStateTransferProvider(String serviceName,
                                 StateTransferProvider provider)

Description copied from interface: GroupStateTransferService

Registers the object that can provide state for the service when newly joining group members request it.

Specified by:

registerStateTransferProvider in interface GroupStateTransferService

Parameters:

serviceName - the name of the service

provider - the state provider

unregisterStateTransferProvider

public void unregisterStateTransferProvider(String serviceName)

Description copied from interface: GroupStateTransferService

Unregisters the object that can provide state for the service.

Specified by:

unregisterStateTransferProvider in interface GroupStateTransferService

Parameters:

serviceName - the name of the service

showHistory

public String showHistory()

showHistoryAsXML

public String showHistoryAsXML()

getMaxHistoryLength

public int getMaxHistoryLength()

setMaxHistoryLength

public void setMaxHistoryLength(int maxHistoryLength)

getThreadPool

public Executor getThreadPool()

setThreadPool

public void setThreadPool(Executor threadPool)

getJGroupsVersion

public String getJGroupsVersion()

getChannelFactory

public ChannelFactory getChannelFactory()

setChannelFactory

public void setChannelFactory(ChannelFactory factory)

getChannelStackName

public String getChannelStackName()

setChannelStackName

public void setChannelStackName(String stackName)

getMethodCallTimeout

public long getMethodCallTimeout()

Description copied from interface: GroupRpcDispatcher

Gets the default period, in ms, that the various callMethodOnXXX methods that don't specify a methodTimeout parameter will wait for a response.

Specified by:

getMethodCallTimeout in interface GroupRpcDispatcher

setMethodCallTimeout

public void setMethodCallTimeout(long timeout)

setGroupName

public void setGroupName(String groupName)

setChannel

public void setChannel(org.jgroups.Channel channel)

create

public void create()
            throws Exception

Throws:

Exception

start

public void start()
           throws Exception

Specified by:

start in class AsynchronousService<CoreGroupCommunicationService>

Throws:

Exception

stop

public void stop()

Specified by:

stop in class AsynchronousService<CoreGroupCommunicationService>

destroy

public void destroy()

getState

public org.jboss.as.clustering.impl.CoreGroupCommunicationService.State getState()

createService

protected void createService()
                      throws Exception

Throws:

Exception

startService

protected void startService()
                     throws Exception

Throws:

Exception

stopService

protected void stopService()
                    throws Exception

Throws:

Exception

destroyService

protected void destroyService()

createChannel

protected org.jgroups.Channel createChannel()

getChannel

protected org.jgroups.Channel getChannel()

registerGroupMembershipListener

protected void registerGroupMembershipListener(GroupMembershipListener listener,
                                   boolean sync)

unregisterGroupMembershipListener

protected void unregisterGroupMembershipListener(GroupMembershipListener listener,
                                     boolean sync)

logHistory

protected void logHistory(String pattern,
              Object... args)