com.cybercom.logging.core

Class EntryExitMethodLogger

java.lang.Object

com.cybercom.logging.core.EntryExitMethodLogger

Direct Known Subclasses:

EjbEntryExitMethodLogger, ProxyEntryExitMethodLogger

public abstract class EntryExitMethodLogger
extends Object

The Class EntryExitMethodLogger logs method entry and exit

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	args
protected MarkerProvider	markerProvider
protected Method	method
protected Object	target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntryExitMethodLogger(MarkerProvider markerProvider, DebugObjectMapper mapper, List<Class<?>> excludedCustomTypes, boolean excludeDefaultTypes, Object target, Method method, Object[] args) Instantiates a new entry exit method logger.

Method Summary

Modifier and Type	Method and Description
protected abstract Object	callRealMethod()
protected String	getTargetName()
protected boolean	isVoidReturned()
Object	logEntryExit() Log entry exit do: 1.

Methods inherited from class java.lang.Object

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

Field Detail

markerProvider

protected MarkerProvider markerProvider

target

protected Object target

method

protected Method method

args

protected Object[] args

Constructor Detail

EntryExitMethodLogger

protected EntryExitMethodLogger(MarkerProvider markerProvider,
                                DebugObjectMapper mapper,
                                List<Class<?>> excludedCustomTypes,
                                boolean excludeDefaultTypes,
                                Object target,
                                Method method,
                                Object[] args)

Instantiates a new entry exit method logger.

Parameters:

markerProvider - the marker provider returns string which can logically connect several method calls. Good candidate is session id which allows grep all methods called within single session Null is accepted.

mapper - the mapper maps classes to their serializers. DebugObjectMapper use Json serializer is used to print object to logs except byte array, when length is logged only (byte array is usually file content and logging content is useless). Mapper can be enhanced by custom serializers

excludedCustomTypes - List of fully qualified name of classes which must NOT be logged. Good candidate is class with private data or huge class

excludeDefaultTypes - Some classes, for example javax.servlet.ServletRequest do not produce useful info when logged If true, those classes are ignored, otherwise are not ignored

target - the target being logged

method - the method being logged

args - the args being logged

Method Detail

logEntryExit

public Object logEntryExit()
                    throws Throwable

Log entry exit do: 1. Log method enty 2. Call method 3. Log method exit or exception if thrown

Returns:

the object

Throws:

Throwable - the throwable

callRealMethod

protected abstract Object callRealMethod()
                                  throws Throwable

Throws:

Throwable

getTargetName

protected String getTargetName()

isVoidReturned

protected boolean isVoidReturned()