com.prosyst.mprm.backend.rpc

Interface RemoteReference

All Superinterfaces:

RemoteObject

public interface RemoteReference
extends RemoteObject

Represents service reference that allows method invocation of one or more service instances, which are registered in some of mPRM backend hosts (including local). Depending of the whether the RemoteReference refers to a single or multiple service references, a remote reference can be 'unicast' or 'multicast'. Unicast reference is returned by getUniHostReference and getUniRoleReference methods of BackendRPCService. All other methods returns multicast references, even if they refers to a single service. Depending of the method result type multicast reference invocation returns the result of a method call as follows:

• void - returns null
• single object - returns an array of objects, which elements are returned results of referred services.
• array - returns concatenation of the arrays returned by referred services. If some of the services returns null, it is skipped - the same as if it returns zero size array.
• Enumerator - returns Enumerator which returns the elements of the corresponding multiple enumerators as a merged/concatenated sequence.

Method Summary

Modifier and Type	Method and Description
RemoteMethod	getMethod(java.lang.String methodName, java.lang.Class[] argTypes) Returns remote method with a given name and argument types, defined in the object referred by this remote reference.
java.lang.Object	invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args) Performs remote call to the referred service(s).
void	invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, AsyncEnumeratorResultCallback callback) This method is similar to invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, com.prosyst.mprm.backend.rpc.AsyncResultCallback callback) but can be used for calling methods which produce Enumerator results.
void	invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, AsyncResultCallback callback) Performs asynchronous remote call to the referred service(s).
<T> java.util.List<T>	invokeWithTimeout(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, int timeout) Performs remote call to the referred service(s) in parallel.
Enumerator	sortedInvoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, boolean inc) Performs remote call to the referred service(s) and merges the result.
void	sortedInvoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, boolean inc, AsyncEnumeratorResultCallback callback) Represents the asynchronous version of method sortedInvoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, boolean inc).

Methods inherited from interface com.prosyst.mbs.services.pmp.RemoteObject

dispose, getMethod, getMethods

Method Detail

invoke

java.lang.Object invoke(java.lang.String methodName,
                        java.lang.Class[] argTypes,
                        java.lang.Object[] args)
                 throws RPCException

Performs remote call to the referred service(s).

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

Returns:

result of the method invocation. If the result is primitive type it is wrapped with the corresponding java object. If the reference is a multicast reference then this method returns an array of the results returned by the distinct service instances. The type of the array corresponds to the type of the method result.

Throws:

RPCException - if some system level error occurs or if some of the referred services has thrown an exception. If the reference is multicast reference then this exception holds partial result if any (if some of the service instances has returned with success).

invokeWithTimeout

<T> java.util.List<T> invokeWithTimeout(java.lang.String methodName,
                                        java.lang.Class[] argTypes,
                                        java.lang.Object[] args,
                                        int timeout)
                                 throws RPCException

Performs remote call to the referred service(s) in parallel.

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

timeout - timeout for RPC call in seconds.

Returns:

Enumerator from results of the method invocation. If the result is primitive type it is wrapped with the corresponding java object. If the reference is a multicast reference then this method returns an array of the results returned by the distinct service instances. The type of the array corresponds to the type of the method result.

Throws:

RPCException - if some system level error occurs or if some of the referred services has thrown an exception. If the reference is multicast reference then this exception holds partial result if any (if some of the service instances has returned with success).

invoke

void invoke(java.lang.String methodName,
            java.lang.Class[] argTypes,
            java.lang.Object[] args,
            AsyncResultCallback callback)

Performs asynchronous remote call to the referred service(s). Calling of this method returns without blocking until the remote method call is finished. Instead the result will be supplied to the callback argument later (when it becomes available).

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

callback - the call-back instance implemented by the caller application, which will be used by the RCP service to supply the result of the RPC method call.

invoke

void invoke(java.lang.String methodName,
            java.lang.Class[] argTypes,
            java.lang.Object[] args,
            AsyncEnumeratorResultCallback callback)

This method is similar to invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, com.prosyst.mprm.backend.rpc.AsyncResultCallback callback) but can be used for calling methods which produce Enumerator results.

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

callback - the call-back instance implemented by the caller application, which will be used by the RCP service to supply the result of the RPC method call.

sortedInvoke

Enumerator sortedInvoke(java.lang.String methodName,
                        java.lang.Class[] argTypes,
                        java.lang.Object[] args,
                        boolean inc)
                 throws RPCException

Performs remote call to the referred service(s) and merges the result. This method can be invoked only to methods, which returns Enumerator and the elements returned by the Enumerator implements Comparable and are sorted in the same order as specified by the 'inc' argument. This method returns merged Enumerator with elements sorted in the same order.

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

inc - if true than the enumeration is in increasing order, false - decreasing.

Returns:

the merged enumeration.

Throws:

RPCException - if some system level error occurs or if some of the referred services has thrown an exception. If the reference is multicast reference then this exception holds partial result if any (if some of the service instances has returned with success). The partial result is Enumerator object.

sortedInvoke

void sortedInvoke(java.lang.String methodName,
                  java.lang.Class[] argTypes,
                  java.lang.Object[] args,
                  boolean inc,
                  AsyncEnumeratorResultCallback callback)

Represents the asynchronous version of method sortedInvoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, boolean inc). For information about asynchronous calling refer to invoke(java.lang.String methodName, java.lang.Class[] argTypes, java.lang.Object[] args, com.prosyst.mprm.backend.rpc.AsyncEnumeratorResultCallback callback).

Parameters:

methodName - the name of the remote method.

argTypes - classes of the method parameters.

args - actual arguments used for method invocation.

inc - if true than the enumeration is in increasing order, false - decreasing.

getMethod

RemoteMethod getMethod(java.lang.String methodName,
                       java.lang.Class[] argTypes)
                throws RPCException

Returns remote method with a given name and argument types, defined in the object referred by this remote reference.

Parameters:

methodName - the name of the method

argTypes - the types of the method arguments

Returns:

com.prosyst.mbs.services.pmp.RemoteMethod instance which could be used for multiple calls of the corresponding method.

Throws:

RPCException - if there is no such method or a system level error occurs.