net.sf.log4jdbc.sql.jdbcapi

Class PreparedStatementSpy

java.lang.Object

net.sf.log4jdbc.sql.jdbcapi.StatementSpy

net.sf.log4jdbc.sql.jdbcapi.PreparedStatementSpy

All Implemented Interfaces:

AutoCloseable, PreparedStatement, Statement, Wrapper, Spy

Direct Known Subclasses:

CallableStatementSpy

public class PreparedStatementSpy
extends StatementSpy
implements PreparedStatement

Wraps a PreparedStatement and reports method calls, returns and exceptions.

MODIFICATIONS FOR LOG4J2: This class now overrides Statement.getGeneratedKeys() in order to use the convenient method Statement.getGeneratedKeys(String), by providing the String returned by dumpedSql().

Author:

Arthur Blake

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	argTrace holds list of bind variables for tracing
protected RdbmsSpecifics	rdbmsSpecifics RdbmsSpecifics for formatting SQL for the given RDBMS.
protected PreparedStatement	realPreparedStatement The real PreparedStatement that this PreparedStatementSpy wraps.

Fields inherited from class net.sf.log4jdbc.sql.jdbcapi.StatementSpy

connectionSpy, currentBatch, log, realStatement, sql

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Constructor and Description
PreparedStatementSpy(String sql, ConnectionSpy connectionSpy, PreparedStatement realPreparedStatement) Create a PreparedStatementSpy (JDBC 4 version) for logging activity of another PreparedStatement.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBatch()
protected void	argTraceSet(int i, String typeHelper, Object arg) Store an argument (bind variable) into the argTrace list (above) for later dumping.
void	clearParameters()
protected String	dumpedSql()
boolean	execute()
ResultSet	executeQuery()
int	executeUpdate()
String	getClassType() Get the type of class being spied upon.
ResultSet	getGeneratedKeys()
ResultSetMetaData	getMetaData()
ParameterMetaData	getParameterMetaData()
PreparedStatement	getRealPreparedStatement() Get the real PreparedStatement that this PreparedStatementSpy wraps.
protected void	reportAllReturns(String methodCall, String msg) Report (for logging) that a method returned.
void	setArray(int i, Array x)
void	setAsciiStream(int parameterIndex, InputStream x, int length)
void	setBigDecimal(int parameterIndex, BigDecimal x)
void	setBinaryStream(int parameterIndex, InputStream x, int length)
void	setBlob(int i, Blob x)
void	setBoolean(int parameterIndex, boolean x)
void	setByte(int parameterIndex, byte x)
void	setBytes(int parameterIndex, byte[] x)
void	setCharacterStream(int parameterIndex, Reader reader, int length)
void	setClob(int i, Clob x)
void	setDate(int parameterIndex, Date x)
void	setDate(int parameterIndex, Date x, Calendar cal)
void	setDouble(int parameterIndex, double x)
void	setFloat(int parameterIndex, float x)
void	setInt(int parameterIndex, int x)
void	setLong(int parameterIndex, long x)
void	setNull(int parameterIndex, int sqlType)
void	setNull(int paramIndex, int sqlType, String typeName)
void	setObject(int parameterIndex, Object x)
void	setObject(int parameterIndex, Object x, int targetSqlType)
void	setObject(int parameterIndex, Object x, int targetSqlType, int scale)
void	setRef(int i, Ref x)
void	setShort(int parameterIndex, short x)
void	setString(int parameterIndex, String x)
void	setTime(int parameterIndex, Time x)
void	setTime(int parameterIndex, Time x, Calendar cal)
void	setTimestamp(int parameterIndex, Timestamp x)
void	setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
void	setUnicodeStream(int parameterIndex, InputStream x, int length) Deprecated.
void	setURL(int parameterIndex, URL x)

Methods inherited from class net.sf.log4jdbc.sql.jdbcapi.StatementSpy

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getConnectionNumber, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getRealStatement, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, reportException, reportException, reportException, reportReturn, reportReturn, reportReturn, reportReturn, reportReturn, reportReturn, reportReturn, reportReturn, reportReturn, reportSql, reportSqlTiming, reportStatementSql, reportStatementSqlTiming, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.PreparedStatement

setAsciiStream, setAsciiStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setCharacterStream, setCharacterStream, setClob, setClob, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setRowId, setSQLXML

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

argTrace

protected final List<String> argTrace

holds list of bind variables for tracing

realPreparedStatement

protected PreparedStatement realPreparedStatement

The real PreparedStatement that this PreparedStatementSpy wraps.

rdbmsSpecifics

protected RdbmsSpecifics rdbmsSpecifics

RdbmsSpecifics for formatting SQL for the given RDBMS.

Constructor Detail

PreparedStatementSpy

public PreparedStatementSpy(String sql,
                    ConnectionSpy connectionSpy,
                    PreparedStatement realPreparedStatement)

Create a PreparedStatementSpy (JDBC 4 version) for logging activity of another PreparedStatement.

Parameters:

sql - SQL for the prepared statement that is being spied upon.

connectionSpy - ConnectionSpy that was called to produce this PreparedStatement.

realPreparedStatement - The actual PreparedStatement that is being spied upon.

Method Detail

argTraceSet

protected void argTraceSet(int i,
               String typeHelper,
               Object arg)

Store an argument (bind variable) into the argTrace list (above) for later dumping.

Parameters:

i - index of argument being set.

typeHelper - optional additional info about the type that is being set in the arg

arg - argument being bound.

dumpedSql

protected String dumpedSql()

reportAllReturns

protected void reportAllReturns(String methodCall,
                    String msg)

Description copied from class: StatementSpy

Report (for logging) that a method returned. All the other reportReturn methods are conveniance methods that call this method.

Overrides:

reportAllReturns in class StatementSpy

Parameters:

methodCall - description of method call and arguments passed to it that returned.

msg - description of what the return value that was returned. may be an empty String for void return types.

getRealPreparedStatement

public PreparedStatement getRealPreparedStatement()

Get the real PreparedStatement that this PreparedStatementSpy wraps.

Returns:

the real PreparedStatement that this PreparedStatementSpy wraps.

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

Overrides:

getClassType in class StatementSpy

Returns:

a description of the type of class being spied upon.

setTime

public void setTime(int parameterIndex,
           Time x)
             throws SQLException

Specified by:

setTime in interface PreparedStatement

Throws:

SQLException

setTime

public void setTime(int parameterIndex,
           Time x,
           Calendar cal)
             throws SQLException

Specified by:

setTime in interface PreparedStatement

Throws:

SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
                      Reader reader,
                      int length)
                        throws SQLException

Specified by:

setCharacterStream in interface PreparedStatement

Throws:

SQLException

setNull

public void setNull(int parameterIndex,
           int sqlType)
             throws SQLException

Specified by:

setNull in interface PreparedStatement

Throws:

SQLException

setNull

public void setNull(int paramIndex,
           int sqlType,
           String typeName)
             throws SQLException

Specified by:

setNull in interface PreparedStatement

Throws:

SQLException

setRef

public void setRef(int i,
          Ref x)
            throws SQLException

Specified by:

setRef in interface PreparedStatement

Throws:

SQLException

setBoolean

public void setBoolean(int parameterIndex,
              boolean x)
                throws SQLException

Specified by:

setBoolean in interface PreparedStatement

Throws:

SQLException

setBlob

public void setBlob(int i,
           Blob x)
             throws SQLException

Specified by:

setBlob in interface PreparedStatement

Throws:

SQLException

setClob

public void setClob(int i,
           Clob x)
             throws SQLException

Specified by:

setClob in interface PreparedStatement

Throws:

SQLException

setArray

public void setArray(int i,
            Array x)
              throws SQLException

Specified by:

setArray in interface PreparedStatement

Throws:

SQLException

setByte

public void setByte(int parameterIndex,
           byte x)
             throws SQLException

Specified by:

setByte in interface PreparedStatement

Throws:

SQLException

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                    InputStream x,
                    int length)
                      throws SQLException

Deprecated.

Specified by:

setUnicodeStream in interface PreparedStatement

Throws:

SQLException

setShort

public void setShort(int parameterIndex,
            short x)
              throws SQLException

Specified by:

setShort in interface PreparedStatement

Throws:

SQLException

execute

public boolean execute()
                throws SQLException

Specified by:

execute in interface PreparedStatement

Throws:

SQLException

setInt

public void setInt(int parameterIndex,
          int x)
            throws SQLException

Specified by:

setInt in interface PreparedStatement

Throws:

SQLException

setLong

public void setLong(int parameterIndex,
           long x)
             throws SQLException

Specified by:

setLong in interface PreparedStatement

Throws:

SQLException

setFloat

public void setFloat(int parameterIndex,
            float x)
              throws SQLException

Specified by:

setFloat in interface PreparedStatement

Throws:

SQLException

setDouble

public void setDouble(int parameterIndex,
             double x)
               throws SQLException

Specified by:

setDouble in interface PreparedStatement

Throws:

SQLException

setBigDecimal

public void setBigDecimal(int parameterIndex,
                 BigDecimal x)
                   throws SQLException

Specified by:

setBigDecimal in interface PreparedStatement

Throws:

SQLException

setURL

public void setURL(int parameterIndex,
          URL x)
            throws SQLException

Specified by:

setURL in interface PreparedStatement

Throws:

SQLException

setString

public void setString(int parameterIndex,
             String x)
               throws SQLException

Specified by:

setString in interface PreparedStatement

Throws:

SQLException

setBytes

public void setBytes(int parameterIndex,
            byte[] x)
              throws SQLException

Specified by:

setBytes in interface PreparedStatement

Throws:

SQLException

setDate

public void setDate(int parameterIndex,
           Date x)
             throws SQLException

Specified by:

setDate in interface PreparedStatement

Throws:

SQLException

getParameterMetaData

public ParameterMetaData getParameterMetaData()
                                       throws SQLException

Specified by:

getParameterMetaData in interface PreparedStatement

Throws:

SQLException

setDate

public void setDate(int parameterIndex,
           Date x,
           Calendar cal)
             throws SQLException

Specified by:

setDate in interface PreparedStatement

Throws:

SQLException

executeQuery

public ResultSet executeQuery()
                       throws SQLException

Specified by:

executeQuery in interface PreparedStatement

Throws:

SQLException

setObject

public void setObject(int parameterIndex,
             Object x,
             int targetSqlType,
             int scale)
               throws SQLException

Specified by:

setObject in interface PreparedStatement

Throws:

SQLException

setObject

public void setObject(int parameterIndex,
             Object x,
             int targetSqlType)
               throws SQLException

Specified by:

setObject in interface PreparedStatement

Throws:

SQLException

setObject

public void setObject(int parameterIndex,
             Object x)
               throws SQLException

Specified by:

setObject in interface PreparedStatement

Throws:

SQLException

setTimestamp

public void setTimestamp(int parameterIndex,
                Timestamp x)
                  throws SQLException

Specified by:

setTimestamp in interface PreparedStatement

Throws:

SQLException

setTimestamp

public void setTimestamp(int parameterIndex,
                Timestamp x,
                Calendar cal)
                  throws SQLException

Specified by:

setTimestamp in interface PreparedStatement

Throws:

SQLException

executeUpdate

public int executeUpdate()
                  throws SQLException

Specified by:

executeUpdate in interface PreparedStatement

Throws:

SQLException

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Specified by:

getGeneratedKeys in interface Statement

Overrides:

getGeneratedKeys in class StatementSpy

Throws:

SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
                  InputStream x,
                  int length)
                    throws SQLException

Specified by:

setAsciiStream in interface PreparedStatement

Throws:

SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
                   InputStream x,
                   int length)
                     throws SQLException

Specified by:

setBinaryStream in interface PreparedStatement

Throws:

SQLException

clearParameters

public void clearParameters()
                     throws SQLException

Specified by:

clearParameters in interface PreparedStatement

Throws:

SQLException

getMetaData

public ResultSetMetaData getMetaData()
                              throws SQLException

Specified by:

getMetaData in interface PreparedStatement

Throws:

SQLException

addBatch

public void addBatch()
              throws SQLException

Specified by:

addBatch in interface PreparedStatement

Throws:

SQLException