Package org.jboss.jca.adapters.jdbc

Class WrappedStatement

java.lang.Object

org.jboss.jca.adapters.jdbc.JBossWrapper

org.jboss.jca.adapters.jdbc.WrappedStatement

All Implemented Interfaces:

Serializable, AutoCloseable, Statement, Wrapper, StatementAccess

Direct Known Subclasses:

WrappedPreparedStatement, WrappedStatementJDK7, WrappedStatementJDK8

public abstract class WrappedStatement
extends JBossWrapper
implements Statement, StatementAccess

A wrapper for a statement.

Author:

David Jencks, Adrian Brock, Jesper Pedersen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static Integer	defaultFetchSize	Default fetch size
protected boolean	doLocking	Do locking
protected String	jndiName	The jndi name
protected boolean	spy	Spy functionality
protected static org.jboss.logging.Logger	spyLogger	The spy logger
protected String	spyLoggingCategory	The spy logging category

Fields inherited from class org.jboss.jca.adapters.jdbc.JBossWrapper

bundle

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

Modifier	Constructor	Description
	WrappedStatement(WrappedConnection lc, Statement s, boolean spy, String jndiName, boolean doLocking)	Constructor
protected	WrappedStatement(WrappedConnection lc, Statement s, boolean spy, String jndiName, boolean doLocking, String spyLoggingCategory)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addBatch(String sql)
void	cancel()
protected void	checkConfiguredQueryTimeout()	Check configured query timeout
protected SQLException	checkException(Throwable t)	Check exception
protected void	checkState()	Check state
protected void	checkTransaction()	Check transaction
protected void	checkTransactionActive()	Check if transaction is active
void	clearBatch()
void	clearWarnings()
void	close()
void	closeOnCompletion()
protected void	closeResultSets()	Close result sets
boolean	execute(String sql)
boolean	execute(String sql, int autoGeneratedKeys)
boolean	execute(String sql, int[] columnIndexes)
boolean	execute(String sql, String[] columnNames)
int[]	executeBatch()
ResultSet	executeQuery(String sql)
int	executeUpdate(String sql)
int	executeUpdate(String sql, int autoGeneratedKeys)
int	executeUpdate(String sql, int[] columnIndexes)
int	executeUpdate(String sql, String[] columnNames)
Connection	getConnection()
int	getFetchDirection()
int	getFetchSize()
ResultSet	getGeneratedKeys()
int	getMaxFieldSize()
int	getMaxRows()
boolean	getMoreResults()
boolean	getMoreResults(int current)
int	getQueryTimeout()
ResultSet	getResultSet()
int	getResultSetConcurrency()
int	getResultSetHoldability()
int	getResultSetType()
Statement	getUnderlyingStatement()	Get the underlying statement
int	getUpdateCount()
SQLWarning	getWarnings()
protected Statement	getWrappedObject()	Get the wrapped statement
protected void	internalClose()	Close
boolean	isClosed()
boolean	isCloseOnCompletion()
boolean	isPoolable()
protected void	lock()	Lock connection
protected ResultSet	registerResultSet(ResultSet resultSet)	Register a result set
void	setCursorName(String name)
void	setEscapeProcessing(boolean enable)
void	setFetchDirection(int direction)
void	setFetchSize(int rows)
void	setMaxFieldSize(int max)
void	setMaxRows(int max)
void	setPoolable(boolean poolable)
void	setQueryTimeout(int timeout)
protected void	unlock()	Unlock connection
protected void	unregisterResultSet(WrappedResultSet resultSet)	Unregister a result set
protected abstract WrappedResultSet	wrapResultSet(ResultSet resultSet, boolean spy, String jndiName, boolean doLocking)	Wrap the result set

Methods inherited from class org.jboss.jca.adapters.jdbc.JBossWrapper

isWrapperFor, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Statement

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

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

spyLogger

protected static org.jboss.logging.Logger spyLogger

The spy logger

spy

protected final boolean spy

Spy functionality

jndiName

protected final String jndiName

The jndi name

spyLoggingCategory

protected final String spyLoggingCategory

The spy logging category

defaultFetchSize

protected static Integer defaultFetchSize

Default fetch size

doLocking

protected final boolean doLocking

Do locking

Constructor Detail

WrappedStatement

public WrappedStatement(WrappedConnection lc,
                        Statement s,
                        boolean spy,
                        String jndiName,
                        boolean doLocking)

Constructor

Parameters:

lc - The connection

s - The statement

spy - The spy value

jndiName - The jndi name

doLocking - Do locking

WrappedStatement

protected WrappedStatement(WrappedConnection lc,
                           Statement s,
                           boolean spy,
                           String jndiName,
                           boolean doLocking,
                           String spyLoggingCategory)

Constructor

Parameters:

lc - The connection

s - The statement

spy - The spy value

jndiName - The jndi name

doLocking - Do locking

spyLoggingCategory - The spy logging category

Method Detail

lock

protected void lock()
             throws SQLException

Lock connection

Throws:

SQLException - Thrown if an error occurs

unlock

protected void unlock()

Unlock connection

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

execute

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

Specified by:

execute in interface Statement

Throws:

SQLException

execute

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

Specified by:

execute in interface Statement

Throws:

SQLException

execute

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

Specified by:

execute in interface Statement

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface Statement

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Statement

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Statement

Throws:

SQLException

executeQuery

public ResultSet executeQuery(String sql)
                       throws SQLException

Specified by:

executeQuery in interface Statement

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

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

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

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

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

executeUpdate

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

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

getMaxFieldSize

public int getMaxFieldSize()
                    throws SQLException

Specified by:

getMaxFieldSize in interface Statement

Throws:

SQLException

setMaxFieldSize

public void setMaxFieldSize(int max)
                     throws SQLException

Specified by:

setMaxFieldSize in interface Statement

Throws:

SQLException

getMaxRows

public int getMaxRows()
               throws SQLException

Specified by:

getMaxRows in interface Statement

Throws:

SQLException

setMaxRows

public void setMaxRows(int max)
                throws SQLException

Specified by:

setMaxRows in interface Statement

Throws:

SQLException

setEscapeProcessing

public void setEscapeProcessing(boolean enable)
                         throws SQLException

Specified by:

setEscapeProcessing in interface Statement

Throws:

SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws SQLException

Specified by:

getQueryTimeout in interface Statement

Throws:

SQLException

setQueryTimeout

public void setQueryTimeout(int timeout)
                     throws SQLException

Specified by:

setQueryTimeout in interface Statement

Throws:

SQLException

cancel

public void cancel()
            throws SQLException

Specified by:

cancel in interface Statement

Throws:

SQLException

setCursorName

public void setCursorName(String name)
                   throws SQLException

Specified by:

setCursorName in interface Statement

Throws:

SQLException

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Specified by:

getResultSet in interface Statement

Throws:

SQLException

getUpdateCount

public int getUpdateCount()
                   throws SQLException

Specified by:

getUpdateCount in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults()
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults(int current)
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

setFetchDirection

public void setFetchDirection(int direction)
                       throws SQLException

Specified by:

setFetchDirection in interface Statement

Throws:

SQLException

getFetchDirection

public int getFetchDirection()
                      throws SQLException

Specified by:

getFetchDirection in interface Statement

Throws:

SQLException

setFetchSize

public void setFetchSize(int rows)
                  throws SQLException

Specified by:

setFetchSize in interface Statement

Throws:

SQLException

getFetchSize

public int getFetchSize()
                 throws SQLException

Specified by:

getFetchSize in interface Statement

Throws:

SQLException

getResultSetConcurrency

public int getResultSetConcurrency()
                            throws SQLException

Specified by:

getResultSetConcurrency in interface Statement

Throws:

SQLException

getResultSetType

public int getResultSetType()
                     throws SQLException

Specified by:

getResultSetType in interface Statement

Throws:

SQLException

addBatch

public void addBatch(String sql)
              throws SQLException

Specified by:

addBatch in interface Statement

Throws:

SQLException

clearBatch

public void clearBatch()
                throws SQLException

Specified by:

clearBatch in interface Statement

Throws:

SQLException

executeBatch

public int[] executeBatch()
                   throws SQLException

Specified by:

executeBatch in interface Statement

Throws:

SQLException

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException

Specified by:

getGeneratedKeys in interface Statement

Throws:

SQLException

getResultSetHoldability

public int getResultSetHoldability()
                            throws SQLException

Specified by:

getResultSetHoldability in interface Statement

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Statement

Throws:

SQLException

isPoolable

public boolean isPoolable()
                   throws SQLException

Specified by:

isPoolable in interface Statement

Throws:

SQLException

setPoolable

public void setPoolable(boolean poolable)
                 throws SQLException

Specified by:

setPoolable in interface Statement

Throws:

SQLException

closeOnCompletion

public void closeOnCompletion()
                       throws SQLException

Specified by:

closeOnCompletion in interface Statement

Throws:

SQLException

isCloseOnCompletion

public boolean isCloseOnCompletion()
                            throws SQLException

Specified by:

isCloseOnCompletion in interface Statement

Throws:

SQLException

getUnderlyingStatement

public Statement getUnderlyingStatement()
                                 throws SQLException

Get the underlying statement

Specified by:

getUnderlyingStatement in interface StatementAccess

Returns:

the underlying statement

Throws:

SQLException - when already closed

getWrappedObject

protected Statement getWrappedObject()
                              throws SQLException

Get the wrapped statement

Overrides:

getWrappedObject in class JBossWrapper

Returns:

The result

Throws:

SQLException - Thrown if an error occurs

checkException

protected SQLException checkException(Throwable t)
                               throws SQLException

Check exception

Parameters:

t - The throwable

Returns:

The result

Throws:

SQLException - Thrown if an error occurs

checkTransaction

protected void checkTransaction()
                         throws SQLException

Check transaction

Throws:

SQLException - Thrown if an error occurs

checkConfiguredQueryTimeout

protected void checkConfiguredQueryTimeout()
                                    throws SQLException

Check configured query timeout

Throws:

SQLException - Thrown if an error occurs

checkTransactionActive

protected void checkTransactionActive()
                               throws SQLException

Check if transaction is active

Throws:

SQLException - Thrown if an error occurs

internalClose

protected void internalClose()
                      throws SQLException

Close

Throws:

SQLException - Thrown if an error occurs

checkState

protected void checkState()
                   throws SQLException

Check state

Throws:

SQLException - Thrown if an error occurs

wrapResultSet

protected abstract WrappedResultSet wrapResultSet(ResultSet resultSet,
                                                  boolean spy,
                                                  String jndiName,
                                                  boolean doLocking)

Wrap the result set

Parameters:

resultSet - The result set

spy - The spy value

jndiName - The jndi name

doLocking - Do locking

Returns:

The result

registerResultSet

protected ResultSet registerResultSet(ResultSet resultSet)

Register a result set

Parameters:

resultSet - The result set

Returns:

The result

unregisterResultSet

protected void unregisterResultSet(WrappedResultSet resultSet)

Unregister a result set

Parameters:

resultSet - The result set

closeResultSets

protected void closeResultSets()

Close result sets