net.sf.log4jdbc
Class PreparedStatementSpy

java.lang.Object
  net.sf.log4jdbc.StatementSpy
      net.sf.log4jdbc.PreparedStatementSpy

All Implemented Interfaces:

java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper, Spy

Direct Known Subclasses:

CallableStatementSpy

public class PreparedStatementSpy
extends StatementSpy
implements java.sql.PreparedStatement

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

Author:

Arthur Blake

Field Summary

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

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

Method Summary

void	addBatch()
void	clearParameters()
boolean	execute()
java.sql.ResultSet	executeQuery()
int	executeUpdate()
java.lang.String	getClassType() Get the type of class being spied upon.
java.sql.ResultSetMetaData	getMetaData()
java.sql.ParameterMetaData	getParameterMetaData()
java.sql.PreparedStatement	getRealPreparedStatement() Get the real PreparedStatement that this PreparedStatementSpy wraps.
boolean	isWrapperFor(java.lang.Class<?> iface)
void	setArray(int i, java.sql.Array x)
void	setAsciiStream(int parameterIndex, java.io.InputStream x)
void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length)
void	setAsciiStream(int parameterIndex, java.io.InputStream x, long length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(int parameterIndex, java.math.BigDecimal x)
void	setBinaryStream(int parameterIndex, java.io.InputStream x)
void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length)
void	setBinaryStream(int parameterIndex, java.io.InputStream x, long length)
void	setBlob(int i, java.sql.Blob x)
void	setBlob(int parameterIndex, java.io.InputStream inputStream)
void	setBlob(int parameterIndex, java.io.InputStream inputStream, long length)
void	setBoolean(int parameterIndex, boolean x)
void	setByte(int parameterIndex, byte x)
void	setBytes(int parameterIndex, byte[] x)
void	setCharacterStream(int parameterIndex, java.io.Reader reader)
void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length)
void	setCharacterStream(int parameterIndex, java.io.Reader reader, long length)
void	setClob(int i, java.sql.Clob x)
void	setClob(int parameterIndex, java.io.Reader reader)
void	setClob(int parameterIndex, java.io.Reader reader, long length)
void	setDate(int parameterIndex, java.sql.Date x)
void	setDate(int parameterIndex, java.sql.Date x, java.util.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	setNCharacterStream(int parameterIndex, java.io.Reader reader)
void	setNCharacterStream(int parameterIndex, java.io.Reader value, long length)
void	setNClob(int parameterIndex, java.sql.NClob value)
void	setNClob(int parameterIndex, java.io.Reader reader)
void	setNClob(int parameterIndex, java.io.Reader reader, long length)
void	setNString(int parameterIndex, java.lang.String value)
void	setNull(int parameterIndex, int sqlType)
void	setNull(int paramIndex, int sqlType, java.lang.String typeName)
void	setObject(int parameterIndex, java.lang.Object x)
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType)
void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale)
void	setRef(int i, java.sql.Ref x)
void	setRowId(int parameterIndex, java.sql.RowId x)
void	setShort(int parameterIndex, short x)
void	setSQLXML(int parameterIndex, java.sql.SQLXML xmlObject)
void	setString(int parameterIndex, java.lang.String x)
void	setTime(int parameterIndex, java.sql.Time x)
void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x)
void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal)
void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Deprecated.
void	setURL(int parameterIndex, java.net.URL x)
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class net.sf.log4jdbc.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, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Statement

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

Constructor Detail

PreparedStatementSpy

public PreparedStatementSpy(java.lang.String sql,
                            ConnectionSpy connectionSpy,
                            java.sql.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

getRealPreparedStatement

public java.sql.PreparedStatement getRealPreparedStatement()

Get the real PreparedStatement that this PreparedStatementSpy wraps.

Returns:

the real PreparedStatement that this PreparedStatementSpy wraps.

getClassType

public java.lang.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,
                    java.sql.Time x)
             throws java.sql.SQLException

Specified by:

setTime in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

Specified by:

setTime in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws java.sql.SQLException

Specified by:

setNull in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNull

public void setNull(int paramIndex,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException

Specified by:

setNull in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setRef

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

Specified by:

setRef in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBoolean

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

Specified by:

setBoolean in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBlob

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

Specified by:

setBlob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setClob

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

Specified by:

setClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setArray

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

Specified by:

setArray in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setByte

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

Specified by:

setByte in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             java.io.InputStream x,
                             int length)
                      throws java.sql.SQLException

Deprecated.

Specified by:

setUnicodeStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setShort

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

Specified by:

setShort in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

execute

public boolean execute()
                throws java.sql.SQLException

Specified by:

execute in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setInt

public void setInt(int parameterIndex,
                   int x)
            throws java.sql.SQLException

Specified by:

setInt in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setLong

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

Specified by:

setLong in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setFloat

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

Specified by:

setFloat in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDouble

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

Specified by:

setDouble in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

Specified by:

setBigDecimal in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setURL

public void setURL(int parameterIndex,
                   java.net.URL x)
            throws java.sql.SQLException

Specified by:

setURL in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setString

public void setString(int parameterIndex,
                      java.lang.String x)
               throws java.sql.SQLException

Specified by:

setString in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBytes

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

Specified by:

setBytes in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDate

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

Specified by:

setDate in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

getParameterMetaData

public java.sql.ParameterMetaData getParameterMetaData()
                                                throws java.sql.SQLException

Specified by:

getParameterMetaData in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setRowId

public void setRowId(int parameterIndex,
                     java.sql.RowId x)
              throws java.sql.SQLException

Specified by:

setRowId in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNString

public void setNString(int parameterIndex,
                       java.lang.String value)
                throws java.sql.SQLException

Specified by:

setNString in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
                                java.io.Reader value,
                                long length)
                         throws java.sql.SQLException

Specified by:

setNCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNClob

public void setNClob(int parameterIndex,
                     java.sql.NClob value)
              throws java.sql.SQLException

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setClob

public void setClob(int parameterIndex,
                    java.io.Reader reader,
                    long length)
             throws java.sql.SQLException

Specified by:

setClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBlob

public void setBlob(int parameterIndex,
                    java.io.InputStream inputStream,
                    long length)
             throws java.sql.SQLException

Specified by:

setBlob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNClob

public void setNClob(int parameterIndex,
                     java.io.Reader reader,
                     long length)
              throws java.sql.SQLException

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setSQLXML

public void setSQLXML(int parameterIndex,
                      java.sql.SQLXML xmlObject)
               throws java.sql.SQLException

Specified by:

setSQLXML in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

Specified by:

setDate in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException

Specified by:

executeQuery in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           java.io.InputStream x,
                           long length)
                    throws java.sql.SQLException

Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the Java input stream that contains the ASCII parameter value

length - the number of bytes in the stream

Throws:

java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

Since:

1.6

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            java.io.InputStream x,
                            long length)
                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               java.io.Reader reader,
                               long length)
                        throws java.sql.SQLException

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           java.io.InputStream x)
                    throws java.sql.SQLException

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            java.io.InputStream x)
                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               java.io.Reader reader)
                        throws java.sql.SQLException

Specified by:

setCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(int parameterIndex,
                                java.io.Reader reader)
                         throws java.sql.SQLException

Specified by:

setNCharacterStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setClob

public void setClob(int parameterIndex,
                    java.io.Reader reader)
             throws java.sql.SQLException

Specified by:

setClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBlob

public void setBlob(int parameterIndex,
                    java.io.InputStream inputStream)
             throws java.sql.SQLException

Specified by:

setBlob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setNClob

public void setNClob(int parameterIndex,
                     java.io.Reader reader)
              throws java.sql.SQLException

Specified by:

setNClob in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x)
               throws java.sql.SQLException

Specified by:

setObject in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setTimestamp

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

Specified by:

setTimestamp in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException

Specified by:

setTimestamp in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Specified by:

executeUpdate in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException

Specified by:

setAsciiStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

clearParameters

public void clearParameters()
                     throws java.sql.SQLException

Specified by:

clearParameters in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

getMetaData

public java.sql.ResultSetMetaData getMetaData()
                                       throws java.sql.SQLException

Specified by:

getMetaData in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

addBatch

public void addBatch()
              throws java.sql.SQLException

Specified by:

addBatch in interface java.sql.PreparedStatement

Throws:

java.sql.SQLException

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
         throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Overrides:

unwrap in class StatementSpy

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Overrides:

isWrapperFor in class StatementSpy

Throws:

java.sql.SQLException