org.tentackle.persist.rmi

Class RemoteDelegateInvocationHandler

java.lang.Object

org.tentackle.persist.rmi.RemoteDelegateInvocationHandler

All Implemented Interfaces:

InvocationHandler

public class RemoteDelegateInvocationHandler
extends Object
implements InvocationHandler

Invocation handler to capture RMI method invocations.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	collectStatistics If true method invocations are counted and measured per method.
boolean	logInvocationDetails If true, args and return values will be logged as well.
boolean	logInvocations If true, all invocations are logged.
static long	logMinDurationMillis Minimum milliseconds a method needs to execute before being logged. 0 to disable.
static int	logMinReturnedCollectionSize Minimum size of returned collection to get logged. 0 to disable.
static String	MDC_SESSION_KEY the mdc session key
static Pattern	mdcFilter Optional filter to log only RMI-calls for certain MappedDiagnosticContexts. If set, statements are only collected for logging if the MDC is valid and the pattern matches the toString-value of the MDC.

Constructor Summary

Constructors

Constructor and Description
RemoteDelegateInvocationHandler(org.tentackle.persist.rmi.RemoteDelegateImpl<?> delegate) Creates an invocation handler for a RemoteDelegate.

Method Summary

Modifier and Type	Method and Description
protected void	cleanupDbAfterException() Cleans up the db after an exception.
protected void	clearMDC() Clears the MDC.
org.tentackle.persist.rmi.RemoteDelegateImpl<?>	getDelegate() Gets the delegate.
protected RemoteException	handleInvocationException(Object proxy, Method method, Object[] args, Throwable cause) Handles an invocation exception. Figures out the real exception cause and throws it, skipping InvocationTargetExceptions.
Object	invoke(Object proxy, Method method, Object[] args)
protected Object	invokeImpl(Object proxy, Method method, Object[] args) Invokes the delegate's method.
protected boolean	isMDCValid() Checks whether the mapped diagnostic context is valid for statistics logging.
protected void	lockDbForThread() Locks the Db for exclusive use by current thread.
protected void	log(Method method, Object[] args, Object retval, Duration duration) Logs the invocation.
protected boolean	needDuration() Returns whether measuring the duration is necessary.
protected void	updateMDC() Updates the MappedDiagnosticContext with the session data.
protected void	updateThreadLocal() Updates the thread local memory.

Methods inherited from class java.lang.Object

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

Field Detail

MDC_SESSION_KEY

public static final String MDC_SESSION_KEY

the mdc session key

See Also:

Constant Field Values

collectStatistics

public static boolean collectStatistics

If true method invocations are counted and measured per method. They can be logged via RemoteDbSession#logStatistics by the client request. For debugging and profiling purposes only.

logInvocations

public boolean logInvocations

If true, all invocations are logged.

logInvocationDetails

public boolean logInvocationDetails

If true, args and return values will be logged as well.

logMinDurationMillis

public static long logMinDurationMillis

Minimum milliseconds a method needs to execute before being logged.
0 to disable.

For analysis and debugging purposes only.

logMinReturnedCollectionSize

public static int logMinReturnedCollectionSize

Minimum size of returned collection to get logged.
0 to disable.

For analysis and debugging purposes only.

mdcFilter

public static Pattern mdcFilter

Optional filter to log only RMI-calls for certain MappedDiagnosticContexts.
If set, statements are only collected for logging if the MDC is valid and the pattern matches the toString-value of the MDC.

Constructor Detail

RemoteDelegateInvocationHandler

public RemoteDelegateInvocationHandler(org.tentackle.persist.rmi.RemoteDelegateImpl<?> delegate)

Creates an invocation handler for a RemoteDelegate.

The invocation handler may be used to intercept remote method invocations. The default implementation just sets the session info into the MappedDiagnosticContext.

Parameters:

delegate - the remote delegate

Method Detail

getDelegate

public org.tentackle.persist.rmi.RemoteDelegateImpl<?> getDelegate()

Gets the delegate.

Returns:

the delegate

updateMDC

protected void updateMDC()

Updates the MappedDiagnosticContext with the session data.

clearMDC

protected void clearMDC()

Clears the MDC.

isMDCValid

protected boolean isMDCValid()

Checks whether the mapped diagnostic context is valid for statistics logging.

Returns:

true if loggable

updateThreadLocal

protected void updateThreadLocal()

Updates the thread local memory.

lockDbForThread

protected void lockDbForThread()

Locks the Db for exclusive use by current thread.

handleInvocationException

protected RemoteException handleInvocationException(Object proxy,
                                                    Method method,
                                                    Object[] args,
                                                    Throwable cause)

Handles an invocation exception.
Figures out the real exception cause and throws it, skipping InvocationTargetExceptions. Furthermore, the exception will be logged in the server's log as well (not just the client).

Parameters:

proxy - the dynamic proxy

method - the method to invoke

args - the method's arguments

cause - the invocation exception

Returns:

the real RemoteException

cleanupDbAfterException

protected void cleanupDbAfterException()

Cleans up the db after an exception.

Invoked from handleInvocationException(java.lang.Object, java.lang.reflect.Method, java.lang.Object[], java.lang.Throwable).

invokeImpl

protected Object invokeImpl(Object proxy,
                            Method method,
                            Object[] args)
                     throws RemoteException

Invokes the delegate's method.

If the invocation failed for some reason the stacktrace is logged.

Parameters:

proxy - the dynamic proxy

method - the method to invoke

args - the method's arguments

Returns:

the method's return value

Throws:

RemoteException - if invocation failed

needDuration

protected boolean needDuration()

Returns whether measuring the duration is necessary.

Returns:

true if duration necessary

log

protected void log(Method method,
                   Object[] args,
                   Object retval,
                   Duration duration)

Logs the invocation.

Parameters:

method - the method executed

args - the method args

retval - the method's return value

duration - the duration when execution was started, null if don't care

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

The default implementation just updates the MDC, invokes the method and logs the invoked method (args and return value)

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable