org.jboss.as.clustering

Interface GroupRpcDispatcher

All Superinterfaces:

GroupCommunicationService

All Known Implementing Classes:

CoreGroupCommunicationService

public interface GroupRpcDispatcher
extends GroupCommunicationService

Provide Remote Procedure Call services to a set of nodes that share a common group communication infrastructure.

Version:

$Revision: 104233 $

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
void	registerRPCHandler(String serviceName, Object handler) Register an object upon which RPCs associated with the given serviceName will be invoked.
void	registerRPCHandler(String serviceName, Object handler, ClassLoader classLoader) Deprecated.
void	registerRPCHandler(String serviceName, Object handler, org.jboss.marshalling.ClassResolver resolver) Register an object upon which RPCs associated with the given serviceName will be invoked.
void	unregisterRPCHandler(String serviceName, Object subscriber) Unregister the service from the partition

Methods inherited from interface org.jboss.as.clustering.GroupCommunicationService

getClusterNode, getClusterNodes, getCurrentViewId, getGroupName, getNodeName, isConsistentWith, isCoordinator

Method Detail

getMethodCallTimeout

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.

registerRPCHandler

void registerRPCHandler(String serviceName,
                      Object handler)

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.

Parameters:

serviceName - Name of the subscribing service (demultiplexing key)

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

registerRPCHandler

@Deprecated
void registerRPCHandler(String serviceName,
                                 Object handler,
                                 ClassLoader classLoader)

Deprecated.

Use registerRPCHandler(String, Object, ClassResolver) instead.

Parameters:

serviceName - Name of the subscribing service (demultiplexing key)

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

classloader - ClassLoader to be used when marshalling and unmarshalling RPC requests and responses.

registerRPCHandler

void registerRPCHandler(String serviceName,
                      Object handler,
                      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.

Parameters:

serviceName - Name of the subscribing service (demultiplexing key)

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

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

unregisterRPCHandler

void unregisterRPCHandler(String serviceName,
                        Object subscriber)

Unregister the service from the partition

Parameters:

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

subscriber - The target object that unsubscribes

callMethodOnCluster

<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 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 getMethodCallTimeout().

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

<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 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 getMethodCallTimeout().

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

<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.

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

callAsynchMethodOnCluster

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).

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

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.

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

callMethodOnCoordinatorNode

<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 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 getMethodCallTimeout().

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

<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.

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

<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 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 getMethodCallTimeout().

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

<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 callMethodOnNode(String, String, Object[], Class[], long, ClusterNode, boolean) callMethodOnNode(serviceName, methodName, args, types, Object.class, methodTimeout, targetNode, false)}.

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

<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.

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

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 callAsyncMethodOnNode(String, String, Object[], Class[], ClusterNode, boolean) callAsynchMethodOnCluster(serviceName, methodName, args, types, methodTimeout, targetNode, false)}.

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

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.

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

callAsyncMethodOnCoordinatorNode

void callAsyncMethodOnCoordinatorNode(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. 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) .

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

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

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.

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