net.ttddyy.dsproxy.listener

Class TracingMethodListener

java.lang.Object

net.ttddyy.dsproxy.listener.TracingMethodListener

All Implemented Interfaces:

MethodExecutionListener

public class TracingMethodListener
extends Object
implements MethodExecutionListener

Log all JDBC API interaction. To log interaction with ResultSet, proxying result set needs to be enabled.

Since:

1.4.4

Author:

Tadaya Tsuyukubo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TracingMethodListener.TracingCondition Functional interface to decide whether to perform tracing.
static interface	TracingMethodListener.TracingMessageConsumer Functional interface to consume log message.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	parameterDisplayLength
protected TracingMethodListener.TracingCondition	tracingCondition
protected TracingMethodListener.TracingMessageConsumer	tracingMessageConsumer

Fields inherited from interface net.ttddyy.dsproxy.listener.MethodExecutionListener

DEFAULT

Constructor Summary

Constructors

Constructor and Description
TracingMethodListener()

Method Summary

Modifier and Type	Method and Description
void	afterMethod(MethodExecutionContext executionContext)
void	beforeMethod(MethodExecutionContext executionContext)
protected String	constructMessage(long seq, Throwable thrown, long execTime, String connectionId, Class<?> targetClass, Method method, String args) Construct a message to log.
protected String	getArguments(Object[] args) Convert method parameters to a string.
protected String	getDisplayParameter(String parameter) Construct parameter value to display.
protected String	getParameterAsString(Object arg) Convert single parameter to String.
protected String	getSingleArgDisplayParameter(String parameter) Construct display string for parameter.
protected String	getSingleArgParameterAsString(Object arg) Convert single parameter to String.
TracingMethodListener.TracingCondition	getTracingCondition()
TracingMethodListener.TracingMessageConsumer	getTracingMessageConsumer()
protected void	logMessage(String message) log message Default implementation delegates to consumer that writes out to console.
void	setParameterDisplayLength(int parameterDisplayLength)
void	setTracingCondition(TracingMethodListener.TracingCondition tracingCondition)
void	setTracingMessageConsumer(TracingMethodListener.TracingMessageConsumer tracingMessageConsumer)

Methods inherited from class java.lang.Object

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

Field Detail

parameterDisplayLength

protected int parameterDisplayLength

tracingCondition

protected TracingMethodListener.TracingCondition tracingCondition

tracingMessageConsumer

protected TracingMethodListener.TracingMessageConsumer tracingMessageConsumer

Constructor Detail

TracingMethodListener

public TracingMethodListener()

Method Detail

beforeMethod

public void beforeMethod(MethodExecutionContext executionContext)

Specified by:

beforeMethod in interface MethodExecutionListener

afterMethod

public void afterMethod(MethodExecutionContext executionContext)

Specified by:

afterMethod in interface MethodExecutionListener

getArguments

protected String getArguments(Object[] args)

Convert method parameters to a string.

Parameters:

args - argument for the invoked method

Returns:

message string

getSingleArgParameterAsString

protected String getSingleArgParameterAsString(Object arg)

Convert single parameter to String. This method is called when invoked method takes single argument.

Parameters:

arg - method parameter

Returns:

string representation

getSingleArgDisplayParameter

protected String getSingleArgDisplayParameter(String parameter)

Construct display string for parameter. This method is called when invoked method takes single argument.

Parameters:

parameter - parameter value as string

Returns:

parameter value to display

getParameterAsString

protected String getParameterAsString(Object arg)

Convert single parameter to String. This method is called when invoked method takes multiple arguments.

Parameters:

arg - method parameter

Returns:

string representation

getDisplayParameter

protected String getDisplayParameter(String parameter)

Construct parameter value to display. This method is called when invoked method takes multiple arguments. Default implementation truncate the parameter string if it is too long.

Parameters:

parameter - parameter value as string

Returns:

parameter value to display

constructMessage

protected String constructMessage(long seq,
                                  Throwable thrown,
                                  long execTime,
                                  String connectionId,
                                  Class<?> targetClass,
                                  Method method,
                                  String args)

Construct a message to log.

Parameters:

seq - sequence number

thrown - thrown exception

execTime - time took to perform the method

connectionId - connection id

targetClass - invoked class

method - invoked method

args - method arguments(parameters)

Returns:

message to log

logMessage

protected void logMessage(String message)

log message Default implementation delegates to consumer that writes out to console.

Parameters:

message - message to log

setParameterDisplayLength

public void setParameterDisplayLength(int parameterDisplayLength)

getTracingCondition

public TracingMethodListener.TracingCondition getTracingCondition()

setTracingCondition

public void setTracingCondition(TracingMethodListener.TracingCondition tracingCondition)

getTracingMessageConsumer

public TracingMethodListener.TracingMessageConsumer getTracingMessageConsumer()

setTracingMessageConsumer

public void setTracingMessageConsumer(TracingMethodListener.TracingMessageConsumer tracingMessageConsumer)