atg.service.resourcepool
Class MonitoredConnection

java.lang.Object
  extended by atg.service.resourcepool.MonitoredConnection
All Implemented Interfaces:
java.sql.Connection, java.sql.Wrapper

public class MonitoredConnection
extends java.lang.Object
implements java.sql.Connection

This class is a wrapper for java.sql.Connection. All calls are passed through to an embedded instance of java.sql.Connection.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
MonitoredConnection(java.sql.Connection pWrapped, ApplicationLogging pLog, ConnectionStats pStats, java.lang.String pId)
          Constructs a new wrapper java.sql.Connection wrapper
MonitoredConnection(java.sql.Connection pWrapped, ApplicationLogging pLog, ConnectionStats pStats, java.lang.String pId, java.lang.Integer pMaxFieldSize, java.lang.Integer pMaxRows, java.lang.Integer pQueryTimeout)
          Constructs a new wrapper java.sql.Connection wrapper
 
Method Summary
 void checkConnectionIntegrity()
          Checks to see if this connection has been closed, i.e.
 void clearWarnings()
          Wraps the call to clearWarnings
 void close()
          Wraps the call to close
 void commit()
          Wraps the call to commit
 java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements)
          Factory method for creating Array objects.
 java.sql.Blob createBlob()
          Constructs an object that implements the Blob interface.
 java.sql.Clob createClob()
          Constructs an object that implements the Clob interface.
 java.sql.NClob createNClob()
          Constructs an object that implements the NClob interface.
 java.sql.SQLXML createSQLXML()
          Constructs an object that implements the SQLXML interface.
 java.sql.Statement createStatement()
          Wraps the call to createStatement
 java.sql.Statement createStatement(int p0, int p1)
          Wraps the call to createStatement
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes)
          Factory method for creating Struct objects.
 java.lang.String getActiveQuery()
           
 boolean getAutoCommit()
          Wraps the call to getAutoCommit
 java.lang.String getCatalog()
          Wraps the call to getCatalog
 java.util.Properties getClientInfo()
          Returns a list containing the name and current value of each client info property supported by the driver.
 java.lang.String getClientInfo(java.lang.String name)
          Returns the value of the client info property specified by name.
 java.lang.String getCreationStackTrace()
           
 int getHoldability()
          Retrieves the current holdability of ResultSet objects created using this Connection object.
 java.lang.String getId()
           
 ApplicationLogging getLog()
           
 java.lang.Integer getMaxFieldSize()
           
 java.lang.Integer getMaxRows()
           
 java.sql.DatabaseMetaData getMetaData()
          Wraps the call to getMetaData
 java.lang.Integer getQueryTimeout()
           
 ResourceObject getResourceObject()
           
 ConnectionStats getStats()
           
 int getTransactionIsolation()
          Wraps the call to getTransactionIsolation
 java.util.Map getTypeMap()
          Wraps the call to getTypeMap
 java.sql.SQLWarning getWarnings()
          Wraps the call to getWarnings
 java.sql.Connection getWrapped()
           
 boolean isClosed()
          Wraps the call to isClosed
 boolean isReadOnly()
          Wraps the call to isReadOnly
 boolean isValid(int timeout)
          Returns true if the connection has not been closed and is still valid.
 boolean isWrapperFor(java.lang.Class<?> pInterface)
          Returns true if this class implements the pInterface argument
 java.lang.String nativeSQL(java.lang.String p0)
          Wraps the call to nativeSQL
 java.sql.CallableStatement prepareCall(java.lang.String p0)
          Wraps the call to prepareCall
 java.sql.CallableStatement prepareCall(java.lang.String p0, int p1, int p2)
          Wraps the call to prepareCall
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String p0)
          Wraps the call to prepareStatement
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
          Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
          Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 java.sql.PreparedStatement prepareStatement(java.lang.String p0, int p1, int p2)
          Wraps the call to prepareStatement
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames)
          Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 void releaseSavepoint(java.sql.Savepoint savepoint)
          Removes the given Savepoint object from the current transaction.
 void rollback()
          Wraps the call to rollback
 void rollback(java.sql.Savepoint savepoint)
          Undoes all changes made after the given Savepoint object was set.
 void setActiveQuery(java.lang.String pActiveQuery)
           
 void setAutoCommit(boolean p0)
          Wraps the call to setAutoCommit
 void setCatalog(java.lang.String p0)
          Wraps the call to setCatalog
 void setClientInfo(java.util.Properties properties)
          Sets the value of the connection's client info properties.
 void setClientInfo(java.lang.String name, java.lang.String value)
          Sets the value of the client info property specified by name to the value specified by value.
 void setCreationStackTrace(java.lang.String pStackTrace)
           
 void setHoldability(int holdability)
          Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
 void setId(java.lang.String pId)
           
 void setLog(ApplicationLogging pLog)
           
 void setMaxFieldSize(java.lang.Integer pMaxFieldSize)
           
 void setMaxRows(java.lang.Integer pMaxRows)
           
 void setQueryTimeout(java.lang.Integer pQueryTimeout)
           
 void setReadOnly(boolean p0)
          Wraps the call to setReadOnly
 void setResourceObject(ResourceObject pRobj)
           
 java.sql.Savepoint setSavepoint()
          Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
 java.sql.Savepoint setSavepoint(java.lang.String name)
          Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
 void setStats(ConnectionStats pStats)
           
 void setTransactionIsolation(int p0)
          Wraps the call to setTransactionIsolation
 void setTypeMap(java.util.Map p0)
          Wraps the call to setTypeMap
 void setWrapped(java.sql.Connection pWrapped)
           
<T> T
unwrap(java.lang.Class<T> pInterface)
          Returns an object that implements the given interface
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

MonitoredConnection

public MonitoredConnection(java.sql.Connection pWrapped,
                           ApplicationLogging pLog,
                           ConnectionStats pStats,
                           java.lang.String pId)
Constructs a new wrapper java.sql.Connection wrapper

Parameters:
pWrapped - the instance being wrapped
pLog - the ApplicationLogging to which output should be sent. SQL statements are logged as info, the actual arguments and result set values are logged as debug. If null, then no logging is sent.
pStats - the object that receives notifications about connection statistics, such as the number of statements executed. If null, then no notifications are sent.
pId - an identifier for the connection, used when logging.

MonitoredConnection

public MonitoredConnection(java.sql.Connection pWrapped,
                           ApplicationLogging pLog,
                           ConnectionStats pStats,
                           java.lang.String pId,
                           java.lang.Integer pMaxFieldSize,
                           java.lang.Integer pMaxRows,
                           java.lang.Integer pQueryTimeout)
Constructs a new wrapper java.sql.Connection wrapper

Parameters:
pWrapped - the instance being wrapped
pLog - the ApplicationLogging to which output should be sent. SQL statements are logged as info, the actual arguments and result set values are logged as debug. If null, then no logging is sent.
pStats - the object that receives notifications about connection statistics, such as the number of statements executed. If null, then no notifications are sent.
pId - an identifier for the connection, used when logging.
pMaxFieldSize - if not null then set on every Statement created
pMaxRow - if not null then set on every Statement created
pQueryTimeout - if not null then set on every Statement created
Method Detail

getResourceObject

public ResourceObject getResourceObject()

setResourceObject

public void setResourceObject(ResourceObject pRobj)

getWrapped

public java.sql.Connection getWrapped()

setWrapped

public void setWrapped(java.sql.Connection pWrapped)

getLog

public ApplicationLogging getLog()

setLog

public void setLog(ApplicationLogging pLog)

getStats

public ConnectionStats getStats()

setStats

public void setStats(ConnectionStats pStats)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String pId)

getMaxFieldSize

public java.lang.Integer getMaxFieldSize()

setMaxFieldSize

public void setMaxFieldSize(java.lang.Integer pMaxFieldSize)

getMaxRows

public java.lang.Integer getMaxRows()

setMaxRows

public void setMaxRows(java.lang.Integer pMaxRows)

getQueryTimeout

public java.lang.Integer getQueryTimeout()

setQueryTimeout

public void setQueryTimeout(java.lang.Integer pQueryTimeout)

getCreationStackTrace

public java.lang.String getCreationStackTrace()

setCreationStackTrace

public void setCreationStackTrace(java.lang.String pStackTrace)

getActiveQuery

public java.lang.String getActiveQuery()

setActiveQuery

public void setActiveQuery(java.lang.String pActiveQuery)

checkConnectionIntegrity

public void checkConnectionIntegrity()
                              throws java.sql.SQLException
Checks to see if this connection has been closed, i.e. is the underlying resource null. If the resource is null, an exception is thrown.

Throws:
java.sql.SQLException

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
Wraps the call to createStatement

Specified by:
createStatement in interface java.sql.Connection
Throws:
java.sql.SQLException

createStatement

public java.sql.Statement createStatement(int p0,
                                          int p1)
                                   throws java.sql.SQLException
Wraps the call to createStatement

Specified by:
createStatement in interface java.sql.Connection
Throws:
java.sql.SQLException

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String p0)
                                            throws java.sql.SQLException
Wraps the call to prepareStatement

Specified by:
prepareStatement in interface java.sql.Connection
Throws:
java.sql.SQLException

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String p0,
                                                   int p1,
                                                   int p2)
                                            throws java.sql.SQLException
Wraps the call to prepareStatement

Specified by:
prepareStatement in interface java.sql.Connection
Throws:
java.sql.SQLException

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String p0)
                                       throws java.sql.SQLException
Wraps the call to prepareCall

Specified by:
prepareCall in interface java.sql.Connection
Throws:
java.sql.SQLException

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String p0,
                                              int p1,
                                              int p2)
                                       throws java.sql.SQLException
Wraps the call to prepareCall

Specified by:
prepareCall in interface java.sql.Connection
Throws:
java.sql.SQLException

nativeSQL

public java.lang.String nativeSQL(java.lang.String p0)
                           throws java.sql.SQLException
Wraps the call to nativeSQL

Specified by:
nativeSQL in interface java.sql.Connection
Throws:
java.sql.SQLException

setAutoCommit

public void setAutoCommit(boolean p0)
                   throws java.sql.SQLException
Wraps the call to setAutoCommit

Specified by:
setAutoCommit in interface java.sql.Connection
Throws:
java.sql.SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
Wraps the call to getAutoCommit

Specified by:
getAutoCommit in interface java.sql.Connection
Throws:
java.sql.SQLException

commit

public void commit()
            throws java.sql.SQLException
Wraps the call to commit

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException

rollback

public void rollback()
              throws java.sql.SQLException
Wraps the call to rollback

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException

close

public void close()
           throws java.sql.SQLException
Wraps the call to close

Specified by:
close in interface java.sql.Connection
Throws:
java.sql.SQLException

isClosed

public boolean isClosed()
                 throws java.sql.SQLException
Wraps the call to isClosed

Specified by:
isClosed in interface java.sql.Connection
Throws:
java.sql.SQLException

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
Wraps the call to getMetaData

Specified by:
getMetaData in interface java.sql.Connection
Throws:
java.sql.SQLException

setTypeMap

public void setTypeMap(java.util.Map p0)
                throws java.sql.SQLException
Wraps the call to setTypeMap

Specified by:
setTypeMap in interface java.sql.Connection
Throws:
java.sql.SQLException

getTypeMap

public java.util.Map getTypeMap()
                         throws java.sql.SQLException
Wraps the call to getTypeMap

Specified by:
getTypeMap in interface java.sql.Connection
Throws:
java.sql.SQLException

setReadOnly

public void setReadOnly(boolean p0)
                 throws java.sql.SQLException
Wraps the call to setReadOnly

Specified by:
setReadOnly in interface java.sql.Connection
Throws:
java.sql.SQLException

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Wraps the call to isReadOnly

Specified by:
isReadOnly in interface java.sql.Connection
Throws:
java.sql.SQLException

setCatalog

public void setCatalog(java.lang.String p0)
                throws java.sql.SQLException
Wraps the call to setCatalog

Specified by:
setCatalog in interface java.sql.Connection
Throws:
java.sql.SQLException

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
Wraps the call to getCatalog

Specified by:
getCatalog in interface java.sql.Connection
Throws:
java.sql.SQLException

setTransactionIsolation

public void setTransactionIsolation(int p0)
                             throws java.sql.SQLException
Wraps the call to setTransactionIsolation

Specified by:
setTransactionIsolation in interface java.sql.Connection
Throws:
java.sql.SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
Wraps the call to getTransactionIsolation

Specified by:
getTransactionIsolation in interface java.sql.Connection
Throws:
java.sql.SQLException

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
Wraps the call to getWarnings

Specified by:
getWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
Wraps the call to clearWarnings

Specified by:
clearWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException

setHoldability

public void setHoldability(int holdability)
                    throws java.sql.SQLException
Changes the holdability of ResultSet objects created using this Connection object to the given holdability.

Specified by:
setHoldability in interface java.sql.Connection
Parameters:
holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - if a database access occurs, the given parameter is not a ResultSet constant indicating holdability, or the given holdability is not supported
Since:
1.4
See Also:
getHoldability(), ResultSet

getHoldability

public int getHoldability()
                   throws java.sql.SQLException
Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:
getHoldability in interface java.sql.Connection
Returns:
the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - if a database access occurs
Since:
1.4
See Also:
setHoldability(int), ResultSet

setSavepoint

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface java.sql.Connection
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException
Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

Specified by:
setSavepoint in interface java.sql.Connection
Parameters:
name - a String containing the name of the savepoint
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException
Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

Specified by:
rollback in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to roll back to
Throws:
java.sql.SQLException - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
Since:
1.4
See Also:
Savepoint, rollback()

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException
Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:
releaseSavepoint in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to be removed
Throws:
java.sql.SQLException - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction
Since:
1.4

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException
Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
Since:
1.4
See Also:
ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more ? IN parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
Since:
1.4
See Also:
ResultSet

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException
Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
Since:
1.4
See Also:
ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException
Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
Throws:
java.sql.SQLException - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException
Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
Throws:
java.sql.SQLException - if a database access error occurs
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException
Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
Throws:
java.sql.SQLException - if a database access error occurs
Since:
1.4

createClob

public java.sql.Clob createClob()
                         throws java.sql.SQLException
Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Specified by:
createClob in interface java.sql.Connection
Returns:
An object that implements the Clob interface
Throws:
java.sql.SQLException - if an object that implements the Clob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createBlob

public java.sql.Blob createBlob()
                         throws java.sql.SQLException
Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Specified by:
createBlob in interface java.sql.Connection
Returns:
An object that implements the Blob interface
Throws:
java.sql.SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createNClob

public java.sql.NClob createNClob()
                           throws java.sql.SQLException
Constructs an object that implements the NClob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the NClob interface may be used to add data to the NClob.

Specified by:
createNClob in interface java.sql.Connection
Returns:
An object that implements the NClob interface
Throws:
java.sql.SQLException - if an object that implements the NClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createSQLXML

public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException
Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXmlStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

Specified by:
createSQLXML in interface java.sql.Connection
Returns:
An object that implements the SQLXML interface
Throws:
java.sql.SQLException - if an object that implements the SQLXML interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

isValid

public boolean isValid(int timeout)
                throws java.sql.SQLException
Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.

The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.

Specified by:
isValid in interface java.sql.Connection
Parameters:
timeout - - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

Returns:
true if the connection is valid, false otherwise
Throws:
java.sql.SQLException - if the value supplied for timeout is less then 0
Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

setClientInfo

public void setClientInfo(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException
Sets the value of the client info property specified by name to the value specified by value.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property.

The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.

The driver shall generate a warning if the client info name specified is not recognized by the driver.

If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a SQLClientInfoException. If the driver generates a SQLClientInfoException, the value specified was not set on the connection.

The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to set
value - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.

Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection

Since:
1.6

setClientInfo

public void setClientInfo(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException
Sets the value of the connection's client info properties. The Properties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. See setClientInfo (String, String) for more information.

If an error occurs in setting any of the client info properties, a SQLClientInfoException is thrown. The SQLClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
properties - the list of client info properties to set

Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection

Since:
1.6

See Also:
setClientInfo(String, String)

getClientInfo

public java.lang.String getClientInfo(java.lang.String name)
                               throws java.sql.SQLException
Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Specified by:
getClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to retrieve

Returns:
The value of the client info property specified

Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection

Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

getClientInfo

public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException
Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.

Specified by:
getClientInfo in interface java.sql.Connection
Returns:
A Properties object that contains the name and current value of each of the client info properties supported by the driver.

Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection

Since:
1.6

createArrayOf

public java.sql.Array createArrayOf(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException
Factory method for creating Array objects.

Note: When createArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether the Array object is an array of that primitive data type or an array of Object.

Note: The JDBC driver is responsible for mapping the elements Object array to the default JDBC SQL type defined in java.sql.Types for the given class of Object. The default mapping is specified in Appendix B of the JDBC specification. If the resulting JDBC type is not the appropriate type for the given typeName then it is implementation defined whether an SQLException is thrown or the driver supports the resulting conversion.

Specified by:
createArrayOf in interface java.sql.Connection
Parameters:
typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned by Array.getBaseTypeName
elements - the elements that populate the returned object
Returns:
an Array object whose elements map to the specified SQL type
Throws:
java.sql.SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createStruct

public java.sql.Struct createStruct(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException
Factory method for creating Struct objects.

Specified by:
createStruct in interface java.sql.Connection
Parameters:
typeName - the SQL type name of the SQL structured type that this Struct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned by Struct.getSQLTypeName.
attributes - the attributes that populate the returned object
Returns:
a Struct object that maps to the given SQL type and is populated with the given attributes
Throws:
java.sql.SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> pInterface)
                     throws java.sql.SQLException
Returns true if this class implements the pInterface argument

Specified by:
isWrapperFor in interface java.sql.Wrapper
Parameters:
pInterface - the interface to test
Returns:
true of this instance implements the interface, false otherwise
Throws:
java.sql.SQLException - if there's an error determining whether this is a wrapper for the interface
Since:
1.6

unwrap

public <T> T unwrap(java.lang.Class<T> pInterface)
         throws java.sql.SQLException
Returns an object that implements the given interface

Specified by:
unwrap in interface java.sql.Wrapper
Parameters:
pInterface - the interface of the object to return
Throws:
java.sql.SQLException - if no object is found that implements the given interface
Since:
1.6