net.sf.log4jdbc.log.slf4j

Class Slf4jSpyLogDelegator

java.lang.Object

net.sf.log4jdbc.log.slf4j.Slf4jSpyLogDelegator

All Implemented Interfaces:

SpyLogDelegator

public class Slf4jSpyLogDelegator
extends Object
implements SpyLogDelegator

Delegates JDBC spy logging events to the the Simple Logging Facade for Java (slf4j).

Modifications for log4j2:

• Modification of the signature of the method connectionOpened(Spy) into connectionOpened(Spy, long), to accept a parameter execTime, defining the time elapsed to open the connection in ms. This new method simply delegates to the formerly existing method, now private, so that the behavior of the slf4j logger is not modified. See SpyLogDelegator for more details.
• Modification of the signature of the method connectionClosed(Spy) into connectionClosed(Spy, long), to accept a parameter execTime, defining the time elapsed to open the connection in ms. This new method simply delegates to the formerly existing method, now private, so that the behavior of the slf4j logger is not modified. See SpyLogDelegator for more details.

Author:

Arthur Blake, Frederic Bastian, Mathieu Seppey

Constructor Summary

Constructors

Constructor and Description
Slf4jSpyLogDelegator() Create a SpyLogDelegator specific to the Simple Logging Facade for Java (slf4j).

Method Summary

Methods

Modifier and Type	Method and Description
void	connectionAborted(Spy spy, long execTime) Called whenever a connection spy is aborted.
void	connectionClosed(Spy spy, long execTime) Called whenever a connection spy is closed.
void	connectionOpened(Spy spy, long execTime) Called whenever a new connection spy is created.
void	constructorReturned(Spy spy, String constructionInfo) Called when a spied upon object is constructed.
void	debug(String msg) Log a Setup and/or administrative log message for log4jdbc.
void	exceptionOccured(Spy spy, String methodCall, Exception e, String sql, long execTime) Called when a spied upon method throws an Exception.
boolean	isJdbcLoggingEnabled() Determine if any of the 5 log4jdbc spy loggers are turned on (jdbc.audit | jdbc.resultset | jdbc.sqlonly | jdbc.sqltiming | jdbc.connection)
boolean	isResultSetCollectionEnabled() Determine whether the logger is expecting results sets to be collected
boolean	isResultSetCollectionEnabledWithUnreadValueFillIn() Determine whether the logger is expecting results sets to be collected AND any unread result set values read explicitly
void	methodReturned(Spy spy, String methodCall, String returnMsg) Called when spied upon method call returns.
void	resultSetCollected(ResultSetCollector resultSetCollector) Called whenever result set has been collected.
void	sqlOccurred(Spy spy, String methodCall, String sql) Special call that is called only for JDBC method calls that contain SQL.
void	sqlTimingOccurred(Spy spy, long execTime, String methodCall, String sql) Special call that is called only for JDBC method calls that contain SQL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Slf4jSpyLogDelegator

public Slf4jSpyLogDelegator()

Create a SpyLogDelegator specific to the Simple Logging Facade for Java (slf4j).

Method Detail

isJdbcLoggingEnabled

public boolean isJdbcLoggingEnabled()

Determine if any of the 5 log4jdbc spy loggers are turned on (jdbc.audit | jdbc.resultset | jdbc.sqlonly | jdbc.sqltiming | jdbc.connection)

Specified by:

isJdbcLoggingEnabled in interface SpyLogDelegator

Returns:

true if any of the 5 spy jdbc/sql loggers are enabled at debug info or error level.

exceptionOccured

public void exceptionOccured(Spy spy,
                    String methodCall,
                    Exception e,
                    String sql,
                    long execTime)

Description copied from interface: SpyLogDelegator

Called when a spied upon method throws an Exception.

Specified by:

exceptionOccured in interface SpyLogDelegator

Parameters:

spy - the Spy wrapping the class that threw an Exception.

methodCall - a description of the name and call parameters of the method generated the Exception.

e - the Exception that was thrown.

sql - optional sql that occured just before the exception occured.

execTime - optional amount of time that passed before an exception was thrown when sql was being executed. caller should pass -1 if not used

methodReturned

public void methodReturned(Spy spy,
                  String methodCall,
                  String returnMsg)

Description copied from interface: SpyLogDelegator

Called when spied upon method call returns.

Specified by:

methodReturned in interface SpyLogDelegator

Parameters:

spy - the Spy wrapping the class that called the method that returned.

methodCall - a description of the name and call parameters of the method that returned.

returnMsg - return value converted to a String for integral types, or String representation for Object return types this will be null for void return types.

constructorReturned

public void constructorReturned(Spy spy,
                       String constructionInfo)

Description copied from interface: SpyLogDelegator

Called when a spied upon object is constructed.

Specified by:

constructorReturned in interface SpyLogDelegator

Parameters:

spy - the Spy wrapping the class that called the method that returned.

constructionInfo - information about the object construction

sqlOccurred

public void sqlOccurred(Spy spy,
               String methodCall,
               String sql)

Description copied from interface: SpyLogDelegator

Special call that is called only for JDBC method calls that contain SQL.

Specified by:

sqlOccurred in interface SpyLogDelegator

Parameters:

spy - the Spy wrapping the class where the SQL occurred.

methodCall - a description of the name and call parameters of the method that generated the SQL.

sql - sql that occurred.

sqlTimingOccurred

public void sqlTimingOccurred(Spy spy,
                     long execTime,
                     String methodCall,
                     String sql)

Special call that is called only for JDBC method calls that contain SQL.

Specified by:

sqlTimingOccurred in interface SpyLogDelegator

Parameters:

spy - the Spy wrapping the class where the SQL occurred.

execTime - how long it took the SQL to run, in milliseconds.

methodCall - a description of the name and call parameters of the method that generated the SQL.

sql - SQL that occurred.

debug

public void debug(String msg)

Description copied from interface: SpyLogDelegator

Log a Setup and/or administrative log message for log4jdbc.

Specified by:

debug in interface SpyLogDelegator

Parameters:

msg - message to log.

connectionOpened

public void connectionOpened(Spy spy,
                    long execTime)

Description copied from interface: SpyLogDelegator

Called whenever a new connection spy is created.

Specified by:

connectionOpened in interface SpyLogDelegator

Parameters:

spy - ConnectionSpy that was created.

execTime - A long defining the time elapsed to open the connection in ms (useful information, as a connection might take some time to be opened sometimes). Caller should pass -1 if not used or unknown.

connectionClosed

public void connectionClosed(Spy spy,
                    long execTime)

Description copied from interface: SpyLogDelegator

Called whenever a connection spy is closed.

Specified by:

connectionClosed in interface SpyLogDelegator

Parameters:

spy - ConnectionSpy that was closed.

execTime - A long defining the time elapsed to close the connection in ms (useful information, as a connection might take some time to be closed sometimes). Caller should pass -1 if not used or unknown.

connectionAborted

public void connectionAborted(Spy spy,
                     long execTime)

Description copied from interface: SpyLogDelegator

Called whenever a connection spy is aborted.

Specified by:

connectionAborted in interface SpyLogDelegator

Parameters:

spy - ConnectionSpy that was aborted.

execTime - A long defining the time elapsed to abort the connection in ms (useful information, as a connection might take some time to be aborted sometimes). Caller should pass -1 if not used or unknown.

isResultSetCollectionEnabled

public boolean isResultSetCollectionEnabled()

Description copied from interface: SpyLogDelegator

Determine whether the logger is expecting results sets to be collected

Specified by:

isResultSetCollectionEnabled in interface SpyLogDelegator

Returns:

true if the logger is expecting results sets to be collected

isResultSetCollectionEnabledWithUnreadValueFillIn

public boolean isResultSetCollectionEnabledWithUnreadValueFillIn()

Description copied from interface: SpyLogDelegator

Determine whether the logger is expecting results sets to be collected AND any unread result set values read explicitly

Specified by:

isResultSetCollectionEnabledWithUnreadValueFillIn in interface SpyLogDelegator

Returns:

true if the logger is expecting results sets to be collected

resultSetCollected

public void resultSetCollected(ResultSetCollector resultSetCollector)

Description copied from interface: SpyLogDelegator

Called whenever result set has been collected. This method will be actually called when the next() method of the spied ResultSet return false meaning that its end is reached. It will be also called if the ResultSet is closed.

Specified by:

resultSetCollected in interface SpyLogDelegator

See Also:

ResultSetSpy, DefaultResultSetCollector