Class StasiStatement

java.lang.Object

clazzfish.jdbc.internal.StasiStatement

All Implemented Interfaces:

AutoCloseable, Statement, Wrapper

Direct Known Subclasses:

StasiPreparedStatement

public class StasiStatement
extends Object
implements Statement

A simple wrapper for Statement to be able to find resource problems while reading and writing to the database. It allows us also to measure times of SQL statements.

Why the name "Stasi..."? The Stasi was the official state security service of Eastern Germany which controls the people (like NSA in the U.S. or KGB in Russia, see also Wikipedia). The StasiStatement controls the embedded Statement - therefore the name.

Since:

1.4.1 (16.03.2014)

Version:

$Revision: 1.13 $

Author:

oliver

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

Constructors

Constructor	Description
StasiStatement(Statement statement)	Instantiates a new proxy statement.

Method Summary

Modifier and Type	Method	Description
final void	addBatch(String sql)	Adds the batch.
final void	cancel()	Cancel.
final void	clearBatch()	Clear batch.
final void	clearWarnings()	Clear warnings.
void	close()	Close.
final void	closeOnCompletion()	Close on completion.
protected SQLException	enrichedSQLException(ProfileMonitor mon, String sql, SQLException original)	For better error analysis the original SQLException will be enriched with some additional infos.
final boolean	execute(String sql)	Execute.
final boolean	execute(String sql, int autoGeneratedKeys)	Execute.
final boolean	execute(String sql, int[] columnIndexes)	Execute.
final boolean	execute(String sql, String[] columnNames)	Execute.
final int[]	executeBatch()	Execute batch.
final ResultSet	executeQuery(String sql)	Execute query.
final int	executeUpdate(String sql)	Execute update.
final int	executeUpdate(String sql, int autoGeneratedKeys)	Execute update.
final int	executeUpdate(String sql, int[] columnIndexes)	Execute update.
final int	executeUpdate(String sql, String[] columnNames)	Execute update.
static StackTraceElement[]	getCallerStacktrace(Class<?>... ignoredClasses)	Gets the caller stacktrace.
final Connection	getConnection()	Gets the connection.
final int	getFetchDirection()	Gets the fetch direction.
final int	getFetchSize()	Gets the fetch size.
final ResultSet	getGeneratedKeys()	Gets the generated keys.
long	getLargeUpdateCount()	Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.
final int	getMaxFieldSize()	Gets the max field size.
final int	getMaxRows()	Gets the max rows.
final boolean	getMoreResults()	Gets the more results.
final boolean	getMoreResults(int current)	Gets the more results.
final int	getQueryTimeout()	Gets the query timeout.
final ResultSet	getResultSet()	Gets the result set.
final int	getResultSetConcurrency()	Gets the result set concurrency.
final int	getResultSetHoldability()	Gets the result set holdability.
final int	getResultSetType()	Gets the result set type.
protected final Statement	getStatement()	Gets the statement.
final int	getUpdateCount()	Gets the update count.
int	getUpdated()	If an entry was updated with one of the executeUpdate methods this method returns the number of updated entries.
final SQLWarning	getWarnings()	Gets the warnings.
final boolean	isClosed()	Checks if is closed.
final boolean	isCloseOnCompletion()	Checks if is close on completion.
final boolean	isPoolable()	Checks if is poolable.
final boolean	isWrapperFor(Class<?> arg0)	Checks if is wrapper for.
protected int	saveUpdateStatistic(ProfileMonitor mon, String sql, int rc)	Save update statistic.
final void	setCursorName(String name)	Sets the cursor name.
final void	setEscapeProcessing(boolean enable)	Sets the escape processing.
final void	setFetchDirection(int direction)	Sets the fetch direction.
final void	setFetchSize(int rows)	Sets the fetch size.
final void	setMaxFieldSize(int max)	Sets the max field size.
final void	setMaxRows(int max)	Sets the max rows.
final void	setPoolable(boolean poolable)	Sets the poolable.
final void	setQueryTimeout(int seconds)	Sets the query timeout.
String	toString()	To string.
final <T> T	unwrap(Class<T> statementClass)	Unwrap.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Statement

enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, getLargeMaxRows, isSimpleIdentifier, setLargeMaxRows

Constructor Details

StasiStatement

public StasiStatement(Statement statement)

Instantiates a new proxy statement.

Parameters:

statement - the statement

Method Details

getCallerStacktrace

public static StackTraceElement[] getCallerStacktrace(Class<?>... ignoredClasses)

Gets the caller stacktrace. To find the real caller we ignore the first 3 elements from the stacktrace because this is e.g. the method Thread.getStackTrace() which is not relevant here.

Parameters:

ignoredClasses - the ignored classes

Returns:

the caller stacktrace

getUpdated

public int getUpdated()

If an entry was updated with one of the executeUpdate methods this method returns the number of updated entries. Otherwise 0,

Returns:

the number of updated entries (or 0)

Since:

1.6.3

getStatement

protected final Statement getStatement()

Gets the statement.

Returns:

the statement

addBatch

public final void addBatch(String sql)
                    throws SQLException

Adds the batch.

Specified by:

addBatch in interface Statement

Parameters:

sql - the sql

Throws:

SQLException - the SQL exception

See Also:

• Statement.addBatch(String)

cancel

public final void cancel()
                  throws SQLException

Cancel.

Specified by:

cancel in interface Statement

Throws:

SQLException - the sQL exception

See Also:

• Statement.cancel()

clearBatch

public final void clearBatch()
                      throws SQLException

Clear batch.

Specified by:

clearBatch in interface Statement

Throws:

SQLException - the sQL exception

See Also:

• Statement.clearBatch()

clearWarnings

public final void clearWarnings()
                         throws SQLException

Clear warnings.

Specified by:

clearWarnings in interface Statement

Throws:

SQLException - the sQL exception

See Also:

• Statement.clearWarnings()

close

public void close()
           throws SQLException

Close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Throws:

SQLException - the sQL exception

See Also:

• Statement.close()

execute

public final boolean execute(String sql,
 int autoGeneratedKeys)
                      throws SQLException

Execute.

Specified by:

execute in interface Statement

Parameters:

sql - the sql

autoGeneratedKeys - the auto generated keys

Returns:

true, if successful

Throws:

SQLException - the sQL exception

See Also:

• Statement.execute(String, int)

execute

public final boolean execute(String sql,
 int[] columnIndexes)
                      throws SQLException

Execute.

Specified by:

execute in interface Statement

Parameters:

sql - the sql

columnIndexes - the column indexes

Returns:

true, if successful

Throws:

SQLException - the sQL exception

See Also:

• Statement.execute(String, int[])

execute

public final boolean execute(String sql,
 String[] columnNames)
                      throws SQLException

Execute.

Specified by:

execute in interface Statement

Parameters:

sql - the sql

columnNames - the column names

Returns:

true, if successful

Throws:

SQLException - the sQL exception

See Also:

• Statement.execute(String, String[])

execute

public final boolean execute(String sql)
                      throws SQLException

Execute.

Specified by:

execute in interface Statement

Parameters:

sql - the sql

Returns:

true, if successful

Throws:

SQLException - the sQL exception

See Also:

• Statement.execute(String)

executeBatch

public final int[] executeBatch()
                         throws SQLException

Execute batch.

Specified by:

executeBatch in interface Statement

Returns:

the int[]

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeBatch()

executeQuery

public final ResultSet executeQuery(String sql)
                             throws SQLException

Execute query.

Specified by:

executeQuery in interface Statement

Parameters:

sql - the sql

Returns:

the result set

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeQuery(String)

executeUpdate

public final int executeUpdate(String sql,
 int autoGeneratedKeys)
                        throws SQLException

Execute update.

Specified by:

executeUpdate in interface Statement

Parameters:

sql - the sql

autoGeneratedKeys - the auto generated keys

Returns:

the int

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeUpdate(String, int)

executeUpdate

public final int executeUpdate(String sql,
 int[] columnIndexes)
                        throws SQLException

Execute update.

Specified by:

executeUpdate in interface Statement

Parameters:

sql - the sql

columnIndexes - the column indexes

Returns:

the int

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeUpdate(String, int[])

executeUpdate

public final int executeUpdate(String sql,
 String[] columnNames)
                        throws SQLException

Execute update.

Specified by:

executeUpdate in interface Statement

Parameters:

sql - the sql

columnNames - the column names

Returns:

the int

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeUpdate(String, String[])

executeUpdate

public final int executeUpdate(String sql)
                        throws SQLException

Execute update.

Specified by:

executeUpdate in interface Statement

Parameters:

sql - the sql

Returns:

the int

Throws:

SQLException - the sQL exception

See Also:

• Statement.executeUpdate(String)

saveUpdateStatistic

protected int saveUpdateStatistic(ProfileMonitor mon,
 String sql,
 int rc)

Save update statistic.

Parameters:

mon - the monitor for the statistic

sql - the sql

rc - the return code (= number of updated entries)

Returns:

the same as rc

enrichedSQLException

protected SQLException enrichedSQLException(ProfileMonitor mon,
 String sql,
 SQLException original)

For better error analysis the original SQLException will be enriched with some additional infos.

Parameters:

mon - the mon

sql - the sql

original - the original

Returns:

the sQL exception

getConnection

public final Connection getConnection()
                               throws SQLException

Gets the connection.

Specified by:

getConnection in interface Statement

Returns:

the connection

Throws:

SQLException - the sQL exception

See Also:

• Statement.getConnection()

getFetchDirection

public final int getFetchDirection()
                            throws SQLException

Gets the fetch direction.

Specified by:

getFetchDirection in interface Statement

Returns:

the fetch direction

Throws:

SQLException - the sQL exception

See Also:

• Statement.getFetchDirection()

getFetchSize

public final int getFetchSize()
                       throws SQLException

Gets the fetch size.

Specified by:

getFetchSize in interface Statement

Returns:

the fetch size

Throws:

SQLException - the sQL exception

See Also:

• Statement.getFetchSize()

getGeneratedKeys

public final ResultSet getGeneratedKeys()
                                 throws SQLException

Gets the generated keys.

Specified by:

getGeneratedKeys in interface Statement

Returns:

the generated keys

Throws:

SQLException - the sQL exception

See Also:

• Statement.getGeneratedKeys()

getMaxFieldSize

public final int getMaxFieldSize()
                          throws SQLException

Gets the max field size.

Specified by:

getMaxFieldSize in interface Statement

Returns:

the max field size

Throws:

SQLException - the sQL exception

See Also:

• Statement.getMaxFieldSize()

getMaxRows

public final int getMaxRows()
                     throws SQLException

Gets the max rows.

Specified by:

getMaxRows in interface Statement

Returns:

the max rows

Throws:

SQLException - the sQL exception

See Also:

• Statement.getMaxRows()

getMoreResults

public final boolean getMoreResults()
                             throws SQLException

Gets the more results.

Specified by:

getMoreResults in interface Statement

Returns:

the more results

Throws:

SQLException - the sQL exception

See Also:

• Statement.getMoreResults()

getMoreResults

public final boolean getMoreResults(int current)
                             throws SQLException

Gets the more results.

Specified by:

getMoreResults in interface Statement

Parameters:

current - the current

Returns:

the more results

Throws:

SQLException - the sQL exception

See Also:

• Statement.getMoreResults(int)

getQueryTimeout

public final int getQueryTimeout()
                          throws SQLException

Gets the query timeout.

Specified by:

getQueryTimeout in interface Statement

Returns:

the query timeout

Throws:

SQLException - the sQL exception

See Also:

• Statement.getQueryTimeout()

getResultSet

public final ResultSet getResultSet()
                             throws SQLException

Gets the result set.

Specified by:

getResultSet in interface Statement

Returns:

the result set

Throws:

SQLException - the sQL exception

See Also:

• Statement.getResultSet()

getResultSetConcurrency

public final int getResultSetConcurrency()
                                  throws SQLException

Gets the result set concurrency.

Specified by:

getResultSetConcurrency in interface Statement

Returns:

the result set concurrency

Throws:

SQLException - the sQL exception

See Also:

• Statement.getResultSetConcurrency()

getResultSetHoldability

public final int getResultSetHoldability()
                                  throws SQLException

Gets the result set holdability.

Specified by:

getResultSetHoldability in interface Statement

Returns:

the result set holdability

Throws:

SQLException - the sQL exception

See Also:

• Statement.getResultSetHoldability()

getResultSetType

public final int getResultSetType()
                           throws SQLException

Gets the result set type.

Specified by:

getResultSetType in interface Statement

Returns:

the result set type

Throws:

SQLException - the sQL exception

See Also:

• Statement.getResultSetType()

getUpdateCount

public final int getUpdateCount()

Gets the update count. This method works always - wether the statemnt was closed or not.

Specified by:

getUpdateCount in interface Statement

Returns:

the update count

See Also:

• Statement.getUpdateCount()

getWarnings

public final SQLWarning getWarnings()
                             throws SQLException

Gets the warnings.

Specified by:

getWarnings in interface Statement

Returns:

the warnings

Throws:

SQLException - the sQL exception

See Also:

• Statement.getWarnings()

isClosed

public final boolean isClosed()
                       throws SQLException

Checks if is closed.

Specified by:

isClosed in interface Statement

Returns:

true, if is closed

Throws:

SQLException - the sQL exception

See Also:

• Statement.isClosed()

isPoolable

public final boolean isPoolable()
                         throws SQLException

Checks if is poolable.

Specified by:

isPoolable in interface Statement

Returns:

true, if is poolable

Throws:

SQLException - the sQL exception

See Also:

• Statement.isPoolable()

isWrapperFor

public final boolean isWrapperFor(Class<?> arg0)
                           throws SQLException

Checks if is wrapper for.

Specified by:

isWrapperFor in interface Wrapper

Parameters:

arg0 - the arg0

Returns:

true, if is wrapper for

Throws:

SQLException - the sQL exception

See Also:

• Wrapper.isWrapperFor(Class)

setCursorName

public final void setCursorName(String name)
                         throws SQLException

Sets the cursor name.

Specified by:

setCursorName in interface Statement

Parameters:

name - the new cursor name

Throws:

SQLException - the sQL exception

See Also:

• Statement.setCursorName(String)

setEscapeProcessing

public final void setEscapeProcessing(boolean enable)
                               throws SQLException

Sets the escape processing.

Specified by:

setEscapeProcessing in interface Statement

Parameters:

enable - the new escape processing

Throws:

SQLException - the sQL exception

See Also:

• Statement.setEscapeProcessing(boolean)

setFetchDirection

public final void setFetchDirection(int direction)
                             throws SQLException

Sets the fetch direction.

Specified by:

setFetchDirection in interface Statement

Parameters:

direction - the new fetch direction

Throws:

SQLException - the sQL exception

See Also:

• Statement.setFetchDirection(int)

setFetchSize

public final void setFetchSize(int rows)
                        throws SQLException

Sets the fetch size.

Specified by:

setFetchSize in interface Statement

Parameters:

rows - the new fetch size

Throws:

SQLException - the sQL exception

See Also:

• Statement.setFetchSize(int)

setMaxFieldSize

public final void setMaxFieldSize(int max)
                           throws SQLException

Sets the max field size.

Specified by:

setMaxFieldSize in interface Statement

Parameters:

max - the new max field size

Throws:

SQLException - the sQL exception

See Also:

• Statement.setMaxFieldSize(int)

setMaxRows

public final void setMaxRows(int max)
                      throws SQLException

Sets the max rows.

Specified by:

setMaxRows in interface Statement

Parameters:

max - the new max rows

Throws:

SQLException - the sQL exception

See Also:

• Statement.setMaxRows(int)

setPoolable

public final void setPoolable(boolean poolable)
                       throws SQLException

Sets the poolable.

Specified by:

setPoolable in interface Statement

Parameters:

poolable - the new poolable

Throws:

SQLException - the sQL exception

See Also:

• Statement.setPoolable(boolean)

setQueryTimeout

public final void setQueryTimeout(int seconds)
                           throws SQLException

Sets the query timeout.

Specified by:

setQueryTimeout in interface Statement

Parameters:

seconds - the new query timeout

Throws:

SQLException - the sQL exception

See Also:

• Statement.setQueryTimeout(int)

unwrap

public final <T> T unwrap(Class<T> statementClass)
                   throws SQLException

Unwrap.

Specified by:

unwrap in interface Wrapper

Type Parameters:

T - the generic type

Parameters:

statementClass - the unwrapped statement class

Returns:

the t

Throws:

SQLException - the sQL exception

See Also:

• Wrapper.unwrap(Class)

closeOnCompletion

public final void closeOnCompletion()
                             throws SQLException

Close on completion. This method is not required for Java 6 and below but for Java 7. To be compatible with Java 6 this method has no implementation.

Specified by:

closeOnCompletion in interface Statement

Throws:

SQLException - the SQL exception

Since:

Java 7

isCloseOnCompletion

public final boolean isCloseOnCompletion()
                                  throws SQLException

Checks if is close on completion. This method is not required for Java 6 and below but for Java 7. To be compatible with Java 6 this method has no implementation.

Specified by:

isCloseOnCompletion in interface Statement

Returns:

true, if is close on completion

Throws:

SQLException - the SQL exception

Since:

Java 7

getLargeUpdateCount

public long getLargeUpdateCount()
                         throws SQLException

Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned. This method should be called only once per result.

This method should be used when the returned row count may exceed Integer.MAX_VALUE.

Specified by:

getLargeUpdateCount in interface Statement

Returns:

the current result as an update count; -1 if the current result is a ResultSet object or there are no more results

Throws:

SQLException - if a database access error occurs or this method is called on a closed Statement

Since:

Java 8

See Also:

• execute(java.lang.String, int)

toString

public String toString()

To string.

Overrides:

toString in class Object

Returns:

the string

See Also:

• Object.toString()