net.sf.log4jdbc.log

Interface SpyLogDelegator

All Known Implementing Classes:

Log4j2SpyLogDelegator, Slf4jSpyLogDelegator

public interface SpyLogDelegator

Delegates Spy events to a logger. This interface is used for all logging activity used by log4jdbc and hides the specific implementation of any given logging system from log4jdbc.

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 information can be generated when a ConnectionSpy has been acquired through the use of DriverSpy (through a DriverManager), see DriverSpy#connect(String, Properties). It cannot be generated when a ConnectionSpy has been directly instantiated (by providing an already instantiated Connection to the constructor ConnectionSpy(Connection); Nevertheless, new constructors for ConnectionSpy, accepting the execution time to open the connection, can be used).
• Modification of the signature of the method connectionClosed(Spy) into connectionClosed(Spy, long), to accept a parameter execTime, defining the time elapsed to close the connection in ms. This execution time can always be computed by ConnectionSpy#close().
• Slf4jSpyLogDelegator has been modified accordingly.

Author:

Arthur Blake, Frederic Bastian, Mathieu Seppey

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 jdbc or sql loggers are turned on.
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) Similar to sqlOccured, but reported after SQL executes and used to report timing stats on the SQL

Method Detail

isJdbcLoggingEnabled

boolean isJdbcLoggingEnabled()

Determine if any of the jdbc or sql loggers are turned on.

Returns:

true if any of the jdbc or sql loggers are enabled at error level or higher.

exceptionOccured

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

Called when a spied upon method throws an Exception.

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

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

Called when spied upon method call returns.

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

void constructorReturned(Spy spy,
                       String constructionInfo)

Called when a spied upon object is constructed.

Parameters:

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

constructionInfo - information about the object construction

sqlOccurred

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

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

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

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

Similar to sqlOccured, but reported after SQL executes and used to report timing stats on the SQL

Parameters:

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

execTime - how long it took the sql to run, in msec.

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

sql - sql that occurred.

connectionOpened

void connectionOpened(Spy spy,
                    long execTime)

Called whenever a new connection spy is created.

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

void connectionClosed(Spy spy,
                    long execTime)

Called whenever a connection spy is closed.

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

void connectionAborted(Spy spy,
                     long execTime)

Called whenever a connection spy is aborted.

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.

debug

void debug(String msg)

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

Parameters:

msg - message to log.

isResultSetCollectionEnabled

boolean isResultSetCollectionEnabled()

Determine whether the logger is expecting results sets to be collected

Returns:

true if the logger is expecting results sets to be collected

isResultSetCollectionEnabledWithUnreadValueFillIn

boolean isResultSetCollectionEnabledWithUnreadValueFillIn()

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

Returns:

true if the logger is expecting results sets to be collected

resultSetCollected

void resultSetCollected(ResultSetCollector resultSetCollector)

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.

See Also:

ResultSetSpy, DefaultResultSetCollector