net.sf.log4jdbc.sql.jdbcapi

Class DataSourceSpy

java.lang.Object

net.sf.log4jdbc.sql.jdbcapi.DataSourceSpy

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource, Spy

public class DataSourceSpy
extends Object
implements DataSource, Spy

A proxy datasource that can be used to wrap a real data source allowing log4jdbc to do its work on the real data source. Inspired by http://groups.google.com/group/log4jdbc/browse_thread/thread/0706611d1b85e210 This can be useful in a Spring context. Imagine your spring context includes this datasource definition

You can get log4jdbc to work on this using the following config changes

Author:

tim.azzopardi Log4jdbcProxyDataSource.java, Mathieu Seppey renamed and modified

Constructor Summary

Constructors

Constructor and Description
DataSourceSpy(DataSource realDataSource) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getClassType() Get the type of class being spied upon.
Connection	getConnection()
Connection	getConnection(String username, String password)
Integer	getConnectionNumber() Get the connection number.
SpyLogDelegator	getLogDelegator() Get the SpyLogDelegator that are used by all resources obtained starting from this DataSource (Connections, ResultSets, ...).
int	getLoginTimeout()
PrintWriter	getLogWriter()
protected void	reportException(String methodCall, SQLException exception) Report to the logger all exceptions which have to be reported by this class
void	setLogDelegator(SpyLogDelegator spyLogDelegator) Set a custom SpyLogDelegator to be used by all resources provided by this DataSource, rather than the default SpyLogDelegator returned by SpyLogFactory#getSpyLogDelegator().
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getParentLogger

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

DataSourceSpy

public DataSourceSpy(DataSource realDataSource)

Constructor

Parameters:

realDataSource - the real DataSource

Method Detail

getLogDelegator

public SpyLogDelegator getLogDelegator()

Get the SpyLogDelegator that are used by all resources obtained starting from this DataSource (Connections, ResultSets, ...).

Returns:

The SpyLogDelegator currently used by this DataSource.

setLogDelegator

public void setLogDelegator(SpyLogDelegator spyLogDelegator)

Set a custom SpyLogDelegator to be used by all resources provided by this DataSource, rather than the default SpyLogDelegator returned by SpyLogFactory#getSpyLogDelegator().

Parameters:

spyLogDelegator - The SpyLogDelegator to be used by all resources obtained starting from this DataSource (Connections, ResultSets, ...).

reportException

protected void reportException(String methodCall,
                   SQLException exception)

Report to the logger all exceptions which have to be reported by this class

Parameters:

methodCall - the method which threw an exception

exception - the thrown exception

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
                       String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface CommonDataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface CommonDataSource

Throws:

SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Throws:

SQLException

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Specified by:

setLogWriter in interface CommonDataSource

Throws:

SQLException

getClassType

public String getClassType()

Description copied from interface: Spy

Get the type of class being spied upon. For example, "Statement", "ResultSet", etc.

Specified by:

getClassType in interface Spy

Returns:

a description of the type of class being spied upon.

getConnectionNumber

public Integer getConnectionNumber()

Description copied from interface: Spy

Get the connection number. In general, this is used to track which underlying connection is being used from the database. The number will be incremented each time a new Connection is retrieved from the real underlying jdbc driver. This is useful for debugging and tracking down problems with connection pooling.

Specified by:

getConnectionNumber in interface Spy

Returns:

the connection instance number.