agilermi.core

Class RMIRegistry.MethodAnnotationRegistry

java.lang.Object

agilermi.core.RMIRegistry.MethodAnnotationRegistry

Enclosing class:

RMIRegistry

public static class RMIRegistry.MethodAnnotationRegistry
extends java.lang.Object

The method register marks remote methods to be executed according the preferred invocation policies. For example, it allows to mark a method to be invoked asynchronously.

Author:

Salvatore Giampa'

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends java.lang.Exception>	getMethodAlternativeRemoteException(java.lang.reflect.Method method) Get the exception class alternative to RemoteException for the specified method.
int	getMethodCacheTimeout(java.lang.reflect.Method method) Gets the caching timeout of the specified method.
boolean	isMethodAsynch(java.lang.reflect.Method method) Returns the asynchronous status of a remote method.
boolean	isMethodSuppressingFaults(java.lang.reflect.Method method) Gets the fault suppressing flag of a method.
void	resetMethodAlternativeRemoteException(java.lang.reflect.Method method) Resets the alternative remote exception class for the specified method.
void	resetMethodAsynch(java.lang.reflect.Method method) Resets the asynchronous status of a method, that means: if the method is annotated with RMIAsynch annotation, it is set as asynchronous, as synchronous otherwise.
void	resetMethodCachedDefault(java.lang.reflect.Method method) Resets the cache timeout for the specified method.
void	resetMethodRemoteFaultsSuppression(java.lang.reflect.Method method) Resets the remote invocation faults suppression flag of the specified method.
void	setMethodAlternativeRemoteException(java.lang.reflect.Method method, java.lang.Class<? extends java.lang.Exception> exceptionClass) Set the exception class alternative to RemoteException for the specified method.
void	setMethodAsynch(java.lang.reflect.Method method, boolean set) Flags a method as asynchronous or not.
void	setMethodCached(java.lang.reflect.Method method, int cacheTimeout) Sets the cache timeout for the specified method.
void	setMethodRemoteFaultsSuppression(java.lang.reflect.Method method, boolean set) Flags the specified method to suppress the remote invocation faults.

Methods inherited from class java.lang.Object

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

Method Detail

isMethodAsynch

public boolean isMethodAsynch(java.lang.reflect.Method method)

Returns the asynchronous status of a remote method.
See setMethodAsynch(Method, boolean) for more details.

Parameters:

method - the remote method

Returns:

true if the method is flagged as asynchronous AND its return type is void.

See Also:

setMethodAsynch(Method, boolean), resetMethodAsynch(Method), RMIAsynch

setMethodAsynch

public void setMethodAsynch(java.lang.reflect.Method method,
                            boolean set)

Flags a method as asynchronous or not. An asynchronous method, when called on an RMI stub, don't wait for remote execution end. A method can be flagged as asynchronous if and only if its return type is void.

Setting a method as asynchronous at runtime through this method is equivalent to annotate the same method with the RMIAsynch annotation at compilation time.

Parameters:

method - the remote method

set - true if the method should be asynchronous, false otherwise.

See Also:

isMethodAsynch(Method), resetMethodAsynch(Method), RMIAsynch

resetMethodAsynch

public void resetMethodAsynch(java.lang.reflect.Method method)

Resets the asynchronous status of a method, that means: if the method is annotated with RMIAsynch annotation, it is set as asynchronous, as synchronous otherwise.

Parameters:

method - the remote method

See Also:

isMethodAsynch(Method), setMethodAsynch(Method, boolean), RMIAsynch

isMethodSuppressingFaults

public boolean isMethodSuppressingFaults(java.lang.reflect.Method method)

Gets the fault suppressing flag of a method.

Parameters:

method - the remote method

Returns:

true if remote invocation faults are suppressed for the specified method, false otherwise

See Also:

RMISuppressFaults, setMethodRemoteFaultsSuppression(Method, boolean), resetMethodRemoteFaultsSuppression(Method)

setMethodRemoteFaultsSuppression

public void setMethodRemoteFaultsSuppression(java.lang.reflect.Method method,
                                             boolean set)

Flags the specified method to suppress the remote invocation faults. If a method is flagged for remote invocation faults, it only returns default values, without throwing exception, when a remote invocation fault happens.
See RMISuppressFaults for more details.

Parameters:

method - the remote method

set - true if the method must suppress remote invocation faults, false otherwise

See Also:

RMISuppressFaults, isMethodSuppressingFaults(Method), resetMethodRemoteFaultsSuppression(Method)

resetMethodRemoteFaultsSuppression

public void resetMethodRemoteFaultsSuppression(java.lang.reflect.Method method)

Resets the remote invocation faults suppression flag of the specified method. If the method is annotated with RMISuppressFaults, the suppression will be activated, deactivated otherwise.

Parameters:

method - the remote method

See Also:

RMISuppressFaults, setMethodRemoteFaultsSuppression(Method, boolean), isMethodSuppressingFaults(Method)

getMethodCacheTimeout

public int getMethodCacheTimeout(java.lang.reflect.Method method)

Gets the caching timeout of the specified method.

Parameters:

method - the remote method

Returns:

the cache timeout in milliseconds

See Also:

RMICached, setMethodCached(Method, int), resetMethodCachedDefault(Method)

setMethodCached

public void setMethodCached(java.lang.reflect.Method method,
                            int cacheTimeout)

Sets the cache timeout for the specified method.
See RMICached for more details.

Parameters:

method - the remote method

cacheTimeout - the cache timeout in milliseconds

See Also:

RMICached, getMethodCacheTimeout(Method), resetMethodCachedDefault(Method)

resetMethodCachedDefault

public void resetMethodCachedDefault(java.lang.reflect.Method method)

Resets the cache timeout for the specified method. If the method is annotated with the RMICached annotation, it will be cached, not cached otherwise.

Parameters:

method - the remote method

See Also:

RMICached, getMethodCacheTimeout(Method), setMethodCached(Method, int)

getMethodAlternativeRemoteException

public java.lang.Class<? extends java.lang.Exception> getMethodAlternativeRemoteException(java.lang.reflect.Method method)

Get the exception class alternative to RemoteException for the specified method.

Parameters:

method - the remote method

Returns:

the execption class that replaces the RemoteException on faults

See Also:

RMIRemoteExceptionAlternative, setMethodAlternativeRemoteException(Method, Class), resetMethodAlternativeRemoteException(Method)

setMethodAlternativeRemoteException

public void setMethodAlternativeRemoteException(java.lang.reflect.Method method,
                                                java.lang.Class<? extends java.lang.Exception> exceptionClass)

Set the exception class alternative to RemoteException for the specified method.
See RMIRemoteExceptionAlternative for more details.

Parameters:

method - the remote method

exceptionClass - the alternative exception class

See Also:

RMIRemoteExceptionAlternative, getMethodAlternativeRemoteException(Method), resetMethodAlternativeRemoteException(Method)

resetMethodAlternativeRemoteException

public void resetMethodAlternativeRemoteException(java.lang.reflect.Method method)

Resets the alternative remote exception class for the specified method. If the method is annotated with RMIRemoteExceptionAlternative, it will throw the exception specified in the annotation, the RemoteException otherwise.

Parameters:

method - the remote method

See Also:

RMIRemoteExceptionAlternative, getMethodAlternativeRemoteException(Method), setMethodAlternativeRemoteException(Method, Class)