public class DatabaseConnectionDelegate extends java.lang.Object implements DatabaseConnection
Title: Service Event Fabric Runtime
Description: Database conneciton delegate.
Copyright: Copyright (c) 2014
Company: StreamScape Technologies
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
Modifier and Type | Method and Description |
---|---|
void |
abort(java.util.concurrent.Executor executor) |
void |
clearWarnings()
Clears all warnings reported for this
Connection object. |
void |
close()
Releases this
Connection object's database and JDBC resources
immediately instead of waiting for them to be automatically released. |
void |
commit()
Makes all changes made since the previous
commit/rollback permanent and releases any database locks
currently held by this
Connection object. |
void |
connect()
Connect to the database.
|
Array |
createArrayOf(java.lang.String typeName,
java.lang.Object[] elements)
Factory method for creating Array objects.
|
Blob |
createBlob()
Constructs an object that implements the
Blob interface. |
Clob |
createClob()
Constructs an object that implements the
Clob interface. |
NClob |
createNClob()
Constructs an object that implements the
NClob interface. |
SQLXML |
createSQLXML()
Constructs an object that implements the
SQLXML interface. |
Statement |
createStatement()
Creates a
Statement object for sending
SQL statements to the database. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency)
Creates a
Statement object that will generate
ResultSet objects with the given type and concurrency. |
Statement |
createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a
Statement object that will generate
ResultSet objects with the given type, concurrency,
and holdability. |
Struct |
createStruct(java.lang.String typeName,
java.lang.Object[] attributes)
Factory method for creating Struct objects.
|
void |
disconnect()
Disconnects from the database.
|
void |
forceStateCheck()
Forces connection to check it's current state, e.g.
|
boolean |
getAutoCommit()
Retrieves the current auto-commit mode for this
Connection
object. |
java.lang.String |
getCatalog()
Retrieves this
Connection object's current catalog name. |
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.
|
ExceptionEventListener |
getExceptionEventListener()
Returns the exception advisory listener for this connection.
|
int |
getHoldability()
Retrieves the current holdability of
ResultSet objects
created using this Connection object. |
DatabaseMetaData |
getMetaData()
Retrieves a
DatabaseMetaData object that contains
metadata about the database to which this
Connection object represents a connection. |
java.lang.String |
getName()
Returns the name of this connection.
|
int |
getNetworkTimeout() |
Connection |
getRawConnection()
Returns underlying connection.
|
java.lang.String |
getSchema() |
Logger |
getServiceLogger()
Returns the logger for this connection.
|
ConnectionState |
getState()
Returns the state of this connection.
|
StateNotificationEventListener |
getStateNotificationEventListener()
Returns the state notification advisory listener for this connection.
|
int |
getTransactionIsolation()
Retrieves this
Connection object's current
transaction isolation level. |
java.util.Map |
getTypeMap()
Retrieves the
Map object associated with this
Connection object. |
SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this
Connection object. |
boolean |
isActive()
Returns
true is the current connection is active and connected. |
boolean |
isClosed()
Retrieves whether this
Connection object has been
closed. |
boolean |
isPrimary()
Check if this connection is a primary in a connection group.
|
boolean |
isReadOnly()
Retrieves whether this
Connection
object is in read-only mode. |
boolean |
isValid(int timeout)
Returns true if the connection has not been closed and is still valid.
|
boolean |
isWrapperFor(java.lang.Class iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper
for an object that does.
|
java.lang.String |
nativeSQL(java.lang.String sql)
Converts the given SQL statement into the system's native SQL grammar.
|
CallableStatement |
prepareCall(java.lang.String sql)
Creates a
CallableStatement object for calling
database stored procedures. |
CallableStatement |
prepareCall(java.lang.String sql,
int resultSetType,
int resultSetConcurrency)
Creates a
CallableStatement object that will generate
ResultSet objects with the given type and concurrency. |
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. |
PreparedStatement |
prepareStatement(java.lang.String sql)
Creates a
PreparedStatement object for sending
parameterized SQL statements to the database. |
PreparedStatement |
prepareStatement(java.lang.String sql,
int autoGeneratedKeys)
Creates a default
PreparedStatement object that has
the capability to retrieve auto-generated keys. |
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. |
PreparedStatement |
prepareStatement(java.lang.String sql,
int resultSetType,
int resultSetConcurrency)
Creates a
PreparedStatement object that will generate
ResultSet objects with the given type and concurrency. |
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. |
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 |
raiseException(DatabaseSQLException e)
Raises a user-defined exception for this connection.
|
void |
releaseSavepoint(Savepoint savepoint)
Removes the specified
Savepoint and subsequent Savepoint objects from the current
transaction. |
void |
resume()
Resume a connection.
|
void |
rollback()
Undoes all changes made in the current transaction
and releases any database locks currently held
by this
Connection object. |
void |
rollback(Savepoint savepoint)
Undoes all changes made after the given
Savepoint object
was set. |
void |
setAutoCommit(boolean autoCommit)
Sets this connection's auto-commit mode to the given state.
|
void |
setCatalog(java.lang.String catalog)
Sets the given catalog name in order to select
a subspace of this
Connection object's database
in which to work. |
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 |
setExceptionEventListener(ExceptionEventListener listener)
Sets the exception (advisory) event listener for this connection.
|
void |
setHoldability(int holdability)
Changes the default holdability of
ResultSet objects
created using this Connection object to the given
holdability. |
void |
setNetworkTimeout(java.util.concurrent.Executor executor,
int milliseconds) |
void |
setPrimary(boolean primary)
Sets the connection in a group to be the primary.
|
void |
setReadOnly(boolean readOnly)
Puts this connection in read-only mode as a hint to the driver to enable
database optimizations.
|
Savepoint |
setSavepoint()
Creates an unnamed savepoint in the current transaction and
returns the new
Savepoint object that represents it. |
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 |
setSchema(java.lang.String schema) |
void |
setServiceLogger(Logger logger)
Sets the logger for this connection's critical log events.
|
void |
setStateNotificationEventListener(StateNotificationEventListener listener)
Sets the state notification (advisory) event listener for this connection.
|
void |
setTransactionIsolation(int level)
Attempts to change the transaction isolation level for this
Connection object to the one given. |
void |
setTypeMap(java.util.Map map)
Installs the given
TypeMap object as the type map for
this Connection object. |
void |
suspend()
Suspends a connection.
|
java.lang.Object |
unwrap(java.lang.Class iface)
Returns an object that implements the given interface to allow access to
non-standard methods, or standard methods not exposed by the proxy.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRawConnection
public java.lang.Object unwrap(java.lang.Class iface) throws SQLException
Wrapper
unwrap
recursively on the wrapped object
or a proxy for that result. If the receiver is not a
wrapper and does not implement the interface, then an SQLException
is thrown.unwrap
in interface Wrapper
iface
- A Class defining an interface that the result must implement.SQLException
- If no object found that implements the interfacepublic boolean isWrapperFor(java.lang.Class iface) throws SQLException
Wrapper
isWrapperFor
on the wrapped
object. If this does not implement the interface and is not a wrapper, return false.
This method should be implemented as a low-cost operation compared to unwrap
so that
callers can use this method to avoid expensive unwrap
calls that may fail. If this method
returns true then calling unwrap
with the same argument should succeed.isWrapperFor
in interface Wrapper
iface
- a Class defining an interface.SQLException
- if an error occurs while determining whether this is a wrapper
for an object with the given interface.public Statement createStatement() throws SQLException
Connection
Statement
object for sending
SQL statements to the database.
SQL statements without parameters are normally
executed using Statement
objects. If the same SQL statement
is executed many times, it may be more efficient to use a
PreparedStatement
object.
Result sets created using the returned Statement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
createStatement
in interface Connection
Statement
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic PreparedStatement prepareStatement(java.lang.String sql) throws SQLException
Connection
PreparedStatement
object for sending
parameterized SQL statements to the database.
A 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 SQLException
objects.
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
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholdersPreparedStatement
object containing the
pre-compiled SQL statementSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic CallableStatement prepareCall(java.lang.String sql) throws SQLException
Connection
CallableStatement
object for calling
database stored procedures.
The CallableStatement
object provides
methods for setting up its IN and OUT parameters, and
methods for executing the call to a stored procedure.
Note: This method is optimized for handling stored
procedure call statements. Some drivers may send the call
statement to the database when the method prepareCall
is done; others
may wait until the CallableStatement
object
is executed. This has no
direct effect on users; however, it does affect which method
throws certain SQLExceptions.
Result sets created using the returned CallableStatement
object will by default be type TYPE_FORWARD_ONLY
and have a concurrency level of CONCUR_READ_ONLY
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareCall
in interface Connection
sql
- an SQL statement that may contain one or more '?'
parameter placeholders. Typically this statement is specified using JDBC
call escape syntax.CallableStatement
object containing the
pre-compiled SQL statementSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic java.lang.String nativeSQL(java.lang.String sql) throws SQLException
Connection
nativeSQL
in interface Connection
sql
- an SQL statement that may contain one or more '?'
parameter placeholdersSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic void setAutoCommit(boolean autoCommit) throws SQLException
Connection
commit
or the method rollback
.
By default, new connections are in auto-commit
mode.
The commit occurs when the statement completes. The time when the statement completes depends on the type of SQL Statement:
CallableStatement
objects or for statements that return
multiple results, the statement is complete
when all of the associated result sets have been closed, and all update
counts and output parameters have been retrieved.
NOTE: If this method is called during a transaction and the
auto-commit mode is changed, the transaction is committed. If
setAutoCommit
is called and the auto-commit mode is
not changed, the call is a no-op.
setAutoCommit
in interface Connection
autoCommit
- true
to enable auto-commit mode;
false
to disable itSQLException
- if a database access error occurs,
setAutoCommit(true) is called while participating in a distributed transaction,
or this method is called on a closed connectionConnection.getAutoCommit()
public java.lang.String getName()
DatabaseConnection
JDBC Factory
are unique.getName
in interface DatabaseConnection
public void connect() throws DatabaseSQLException
DatabaseConnection
DatabaseConnection.getState()
to determine when a connection is in
ConnectionState.CONNECTED
state before proceeding.connect
in interface DatabaseConnection
DatabaseSQLException
public boolean getAutoCommit() throws SQLException
Connection
Connection
object.getAutoCommit
in interface Connection
Connection
object's
auto-commit modeSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setAutoCommit(boolean)
public void disconnect() throws DatabaseSQLException
DatabaseConnection
disconnect
in interface DatabaseConnection
DatabaseSQLException
public void commit() throws SQLException
Connection
Connection
object.
This method should be
used only when auto-commit mode has been disabled.commit
in interface Connection
SQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
if this method is called on a closed conection or this
Connection
object is in auto-commit modeConnection.setAutoCommit(boolean)
public void suspend()
DatabaseConnection
suspend
in interface DatabaseConnection
public void resume()
DatabaseConnection
resume
in interface DatabaseConnection
public void forceStateCheck()
DatabaseConnection
forceStateCheck
in interface DatabaseConnection
public void rollback() throws SQLException
Connection
Connection
object. This method should be
used only when auto-commit mode has been disabled.rollback
in interface Connection
SQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection or this
Connection
object is in auto-commit modeConnection.setAutoCommit(boolean)
public boolean isPrimary()
DatabaseConnection
isPrimary
in interface DatabaseConnection
public void setPrimary(boolean primary)
DatabaseConnection
setPrimary
in interface DatabaseConnection
primary
- booleanpublic boolean isActive()
DatabaseConnection
true
is the current connection is active and connected.isActive
in interface DatabaseConnection
public void close() throws SQLException
Connection
Connection
object's database and JDBC resources
immediately instead of waiting for them to be automatically released.
Calling the method close
on a Connection
object that is already closed is a no-op.
It is strongly recommended that an application explicitly
commits or rolls back an active transaction prior to calling the
close
method. If the close
method is called
and there is an active transaction, the results are implementation-defined.
close
in interface Connection
SQLException
- SQLException if a database access error occurspublic void setServiceLogger(Logger logger)
DatabaseConnection
setServiceLogger
in interface DatabaseConnection
logger
- ILoggerpublic Logger getServiceLogger()
DatabaseConnection
null
if one is not set.getServiceLogger
in interface DatabaseConnection
public void setStateNotificationEventListener(StateNotificationEventListener listener)
DatabaseConnection
ConnectionStateChangeAdvisory
event every time a connection state change occurs.setStateNotificationEventListener
in interface DatabaseConnection
listener
- IStateNotificationEventListenerpublic boolean isClosed() throws SQLException
Connection
Connection
object has been
closed. A connection is closed if the method close
has been called on it or if certain fatal errors have occurred.
This method is guaranteed to return true
only when
it is called after the method Connection.close
has
been called.
This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.
isClosed
in interface Connection
true
if this Connection
object
is closed; false
if it is still openSQLException
- if a database access error occurspublic StateNotificationEventListener getStateNotificationEventListener()
DatabaseConnection
null
if a listener is not set.getStateNotificationEventListener
in interface DatabaseConnection
public void setExceptionEventListener(ExceptionEventListener listener)
DatabaseConnection
DatabaseSQLException
event in case of
an exception.setExceptionEventListener
in interface DatabaseConnection
listener
- IExceptionEventListenerpublic ExceptionEventListener getExceptionEventListener()
DatabaseConnection
null
if a listener is not set.getExceptionEventListener
in interface DatabaseConnection
public ConnectionState getState()
DatabaseConnection
getState
in interface DatabaseConnection
public DatabaseMetaData getMetaData() throws SQLException
Connection
DatabaseMetaData
object that contains
metadata about the database to which this
Connection
object represents a connection.
The metadata includes information about the database's
tables, its supported SQL grammar, its stored
procedures, the capabilities of this connection, and so on.getMetaData
in interface Connection
DatabaseMetaData
object for this
Connection
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionpublic void raiseException(DatabaseSQLException e)
DatabaseConnection
raiseException
in interface DatabaseConnection
e
- DatabaseSQLExceptionpublic Connection getRawConnection()
DatabaseConnection
getRawConnection
in interface DatabaseConnection
public void setReadOnly(boolean readOnly) throws SQLException
Connection
Note: This method cannot be called during a transaction.
setReadOnly
in interface Connection
readOnly
- true
enables read-only mode;
false
disables itSQLException
- if a database access error occurs, this
method is called on a closed connection or this
method is called during a transactionpublic boolean isReadOnly() throws SQLException
Connection
Connection
object is in read-only mode.isReadOnly
in interface Connection
true
if this Connection
object
is read-only; false
otherwiseSQLException
- SQLException if a database access error occurs
or this method is called on a closed connectionpublic void setCatalog(java.lang.String catalog) throws SQLException
Connection
Connection
object's database
in which to work.
If the driver does not support catalogs, it will silently ignore this request.
setCatalog
in interface Connection
catalog
- the name of a catalog (subspace in this
Connection
object's database) in which to workSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.getCatalog()
public java.lang.String getCatalog() throws SQLException
Connection
Connection
object's current catalog name.getCatalog
in interface Connection
null
if there is noneSQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setCatalog(java.lang.String)
public void setTransactionIsolation(int level) throws SQLException
Connection
Connection
object to the one given.
The constants defined in the interface Connection
are the possible transaction isolation levels.
Note: If this method is called during a transaction, the result is implementation-defined.
setTransactionIsolation
in interface Connection
level
- one of the following Connection
constants:
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
, or
Connection.TRANSACTION_SERIALIZABLE
.
(Note that Connection.TRANSACTION_NONE
cannot be used
because it specifies that transactions are not supported.)SQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameter is not one of the Connection
constantsDatabaseMetaData.supportsTransactionIsolationLevel(int)
,
Connection.getTransactionIsolation()
public int getTransactionIsolation() throws SQLException
Connection
Connection
object's current
transaction isolation level.getTransactionIsolation
in interface Connection
Connection.TRANSACTION_READ_UNCOMMITTED
,
Connection.TRANSACTION_READ_COMMITTED
,
Connection.TRANSACTION_REPEATABLE_READ
,
Connection.TRANSACTION_SERIALIZABLE
, or
Connection.TRANSACTION_NONE
.SQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setTransactionIsolation(int)
public SQLWarning getWarnings() throws SQLException
Connection
Connection
object. If there is more than one
warning, subsequent warnings will be chained to the first one
and can be retrieved by calling the method
SQLWarning.getNextWarning
on the warning
that was retrieved previously.
This method may not be
called on a closed connection; doing so will cause an
SQLException
to be thrown.
Note: Subsequent warnings will be chained to this SQLWarning.
getWarnings
in interface Connection
SQLWarning
object or null
if there are noneSQLException
- if a database access error occurs or
this method is called on a closed connectionSQLWarning
public void clearWarnings() throws SQLException
Connection
Connection
object.
After a call to this method, the method getWarnings
returns null
until a new warning is
reported for this Connection
object.clearWarnings
in interface Connection
SQLException
- SQLException if a database access error occurs
or this method is called on a closed connectionpublic Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
Connection
Statement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the createStatement
method
above, but it allows the default result set
type and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.createStatement
in interface Connection
resultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
Statement
object that will generate
ResultSet
objects with the given type and
concurrencySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws SQLException
Connection
PreparedStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the prepareStatement
method
above, but it allows the default result set
type and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.prepareStatement
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain one or more '?' IN
parametersresultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
ResultSet
objects with the given type and concurrencySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws SQLException
Connection
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 and concurrency to be overridden.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.prepareCall
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain on or more '?' parametersresultSetType
- a result set type; one of
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency
- a concurrency type; one of
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
CallableStatement
object containing the
pre-compiled SQL statement that will produce ResultSet
objects with the given type and concurrencySQLException
- if a database access error occurs, this method
is called on a closed connection
or the given parameters are not ResultSet
constants indicating type and concurrencySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type and result set concurrency.public java.util.Map getTypeMap() throws SQLException
Connection
Map
object associated with this
Connection
object.
Unless the application has added an entry, the type map returned
will be empty.getTypeMap
in interface Connection
java.util.Map
object associated
with this Connection
objectSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodConnection.setTypeMap(java.util.Map)
public void setTypeMap(java.util.Map map) throws SQLException
Connection
TypeMap
object as the type map for
this Connection
object. The type map will be used for the
custom mapping of SQL structured types and distinct types.setTypeMap
in interface Connection
map
- the java.util.Map
object to install
as the replacement for this Connection
object's default type mapSQLException
- if a database access error occurs, this
method is called on a closed connection or
the given parameter is not a java.util.Map
objectSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodConnection.getTypeMap()
public void setHoldability(int holdability) throws SQLException
Connection
ResultSet
objects
created using this Connection
object to the given
holdability. The default holdability of ResultSet
objects
can be be determined by invoking
DatabaseMetaData.getResultSetHoldability()
.setHoldability
in interface Connection
holdability
- a ResultSet
holdability constant; one of
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access occurs, this method is called
on a closed connection, or the given parameter
is not a ResultSet
constant indicating holdabilitySQLFeatureNotSupportedException
- if the given holdability is not supportedConnection.getHoldability()
,
DatabaseMetaData.getResultSetHoldability()
,
ResultSet
public int getHoldability() throws SQLException
Connection
ResultSet
objects
created using this Connection
object.getHoldability
in interface Connection
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access error occurs
or this method is called on a closed connectionConnection.setHoldability(int)
,
DatabaseMetaData.getResultSetHoldability()
,
ResultSet
public Savepoint setSavepoint() throws SQLException
Connection
Savepoint
object that represents it.
if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
setSavepoint
in interface Connection
Savepoint
objectSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
public Savepoint setSavepoint(java.lang.String name) throws SQLException
Connection
Savepoint
object that represents it.
if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.
setSavepoint
in interface Connection
name
- a String
containing the name of the savepointSavepoint
objectSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
public void rollback(Savepoint savepoint) throws SQLException
Connection
Savepoint
object
was set.
This method should be used only when auto-commit has been disabled.
rollback
in interface Connection
savepoint
- the Savepoint
object to roll back toSQLException
- if a database access error occurs,
this method is called while participating in a distributed transaction,
this method is called on a closed connection,
the Savepoint
object is no longer valid,
or this Connection
object is currently in
auto-commit modeSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodSavepoint
,
Connection.rollback()
public void releaseSavepoint(Savepoint savepoint) throws SQLException
Connection
Savepoint
and subsequent Savepoint
objects from the current
transaction. Any reference to the savepoint after it have been removed
will cause an SQLException
to be thrown.releaseSavepoint
in interface Connection
savepoint
- the Savepoint
object to be removedSQLException
- if a database access error occurs, this
method is called on a closed connection or
the given Savepoint
object is not a valid
savepoint in the current transactionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Connection
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.createStatement
in interface Connection
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
Statement
object that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Connection
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.
prepareStatement
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain one or more '?' IN
parametersresultSetType
- 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
PreparedStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Connection
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.prepareCall
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain on or more '?' parametersresultSetType
- 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
CallableStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdabilitySQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilitySQLFeatureNotSupportedException
- if the JDBC driver does not support
this method or this method is not supported for the specified result
set type, result set holdability and result set concurrency.ResultSet
public PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys) throws SQLException
Connection
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, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
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
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholdersautoGeneratedKeys
- a flag indicating whether auto-generated keys
should be returned; one of
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
PreparedStatement
object, containing the
pre-compiled SQL statement, that will have the capability of
returning auto-generated keysSQLException
- if a database access error occurs, this
method is called on a closed connection
or the given parameter is not a Statement
constant indicating whether auto-generated keys should be
returnedSQLFeatureNotSupportedException
- if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSpublic PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes) throws SQLException
Connection
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. The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
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
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnIndexes
- an array of column indexes indicating the columns
that should be returned from the inserted row or rowsPreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
indexesSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames) throws SQLException
Connection
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.
The driver will ignore the array if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
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
.
The holdability of the created result sets can be determined by
calling Connection.getHoldability()
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnNames
- an array of column names indicating the columns
that should be returned from the inserted row or rowsPreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
namesSQLException
- if a database access error occurs
or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic Clob createClob() throws SQLException
Connection
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
.createClob
in interface Connection
Clob
interfaceSQLException
- 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.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic Blob createBlob() throws SQLException
Connection
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
.createBlob
in interface Connection
Blob
interfaceSQLException
- 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.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic NClob createNClob() throws SQLException
Connection
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
.createNClob
in interface Connection
NClob
interfaceSQLException
- 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.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic SQLXML createSQLXML() throws SQLException
Connection
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.createSQLXML
in interface Connection
SQLXML
interfaceSQLException
- 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.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this data typepublic boolean isValid(int timeout) throws SQLException
Connection
The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.
isValid
in interface Connection
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.
SQLException
- if the value supplied for timeout
is less then 0DatabaseMetaData.getClientInfoProperties()
public void setClientInfo(java.lang.String name, java.lang.String value) throws SQLClientInfoException
Connection
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.
setClientInfo
in interface Connection
name
- The name of the client info property to setvalue
- The value to set the client info property to. If the
value is null, the current value of the specified
property is cleared.
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
public void setClientInfo(java.util.Properties properties) throws SQLClientInfoException
Connection
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.
setClientInfo
in interface Connection
properties
- the list of client info properties to set
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
setClientInfo(String, String)
public java.lang.String getClientInfo(java.lang.String name) throws SQLException
Connection
Applications may use the DatabaseMetaData.getClientInfoProperties
method to determine the client info properties supported by the driver.
getClientInfo
in interface Connection
name
- The name of the client info property to retrieve
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
DatabaseMetaData.getClientInfoProperties()
public java.util.Properties getClientInfo() throws SQLException
Connection
getClientInfo
in interface Connection
Properties
object that contains the name and current value of
each of the client info properties supported by the driver.
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
public Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements) throws SQLException
Connection
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.
createArrayOf
in interface Connection
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 objectSQLException
- 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 connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support this data typepublic Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes) throws SQLException
Connection
createStruct
in interface Connection
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 objectSQLException
- if a database error occurs, the typeName is null or this method is called on a closed connectionSQLFeatureNotSupportedException
- if the JDBC driver does not support this data typepublic void setSchema(java.lang.String schema) throws SQLException
SQLException
public java.lang.String getSchema() throws SQLException
SQLException
public void abort(java.util.concurrent.Executor executor) throws SQLException
SQLException
public void setNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds) throws SQLException
SQLException
public int getNetworkTimeout() throws SQLException
SQLException
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.