org.openmdx.kernel.application.container.spi.sql
Class DatabaseConnection

java.lang.Object
  extended by org.openmdx.kernel.application.container.spi.sql.DatabaseConnection
All Implemented Interfaces:
Connection, Wrapper

public class DatabaseConnection
extends Object
implements Connection

DatabaseConnection


Field Summary
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
DatabaseConnection()
           
 
Method Summary
 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.
 Statement createStatement()
          Creates a Statement object for sending SQL statements to the database.
 Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
           
 boolean getAutoCommit()
          Retrieves the current auto-commit mode for this Connection object.
 String getCatalog()
          Retrieves this Connection object's current catalog name.
 int getHoldability()
           
 DatabaseMetaData getMetaData()
          Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.
 int getTransactionIsolation()
          Retrieves this Connection object's current transaction isolation level
 Map getTypeMap()
           
 SQLWarning getWarnings()
           
 boolean isClosed()
          Retrieves whether this Connection object has been closed.
 boolean isReadOnly()
          Retrieves whether this Connection object is in read-only mode.
 String nativeSQL(String sql)
          Converts the given SQL statement into the system's native SQL grammar.
 CallableStatement prepareCall(String sql)
          Creates a CallableStatement object for calling database stored procedures.
 CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency)
          Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
           
 PreparedStatement prepareStatement(String sql)
          Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)
           
 PreparedStatement prepareStatement(String sql, int[] columnIndexes)
           
 PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
 PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
           
 PreparedStatement prepareStatement(String sql, String[] columnNames)
           
 void releaseSavepoint(Savepoint savepoint)
           
 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)
           
 void setAutoCommit(boolean autoCommit)
          Sets this connection's auto-commit mode to the given state.
 void setCatalog(String catalog)
          Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.
protected  void setDelegate(CloseCallback managedConnection, Connection connection)
          Set the delegate
 void setHoldability(int holdability)
           
 void setReadOnly(boolean readOnly)
          Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
 Savepoint setSavepoint()
           
 Savepoint setSavepoint(String name)
           
 void setTransactionIsolation(int level)
          Attempts to change the transaction isolation level for this Connection object to the one given.
 void setTypeMap(Map map)
          Installs the given TypeMap object as the type map for this Connection object.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.sql.Connection
createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStruct, getClientInfo, getClientInfo, isValid, setClientInfo, setClientInfo
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 

Constructor Detail

DatabaseConnection

public DatabaseConnection()
Method Detail

setDelegate

protected void setDelegate(CloseCallback managedConnection,
                           Connection connection)
Set the delegate

Parameters:
managedConnnection - the JCA managed connection
connnection - the SQL connection

clearWarnings

public void clearWarnings()
                   throws SQLException
Clears all warnings reported for this Connection object.

Specified by:
clearWarnings in interface Connection
Throws:
SQLException - if a database access error occurs

close

public void close()
           throws SQLException
Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Specified by:
close in interface Connection
Throws:
SQLException - if a database access error occurs

commit

public void commit()
            throws SQLException
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.

Specified by:
commit in interface Connection
Throws:
SQLException - if a database access error occurs or this Connection object is in auto-commit mode

createStatement

public Statement createStatement()
                          throws SQLException
Creates a 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.

Specified by:
createStatement in interface Connection
Returns:
new default Statement object
Throws:
SQLException - if a database access error occurs

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
                          throws SQLException
Creates a 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.

Specified by:
createStatement in interface Connection
Parameters:
resultSetType -
resultSetConcurrency -
Returns:
a new default PreparedStatement object containing the pre-compiled SQL statement
Throws:
SQLException - if a database access error occurs

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException
Retrieves the current auto-commit mode for this Connection object.

Specified by:
getAutoCommit in interface Connection
Returns:
the current state of this Connection object's auto-commit mode
Throws:
SQLException - if a database access error occurs

getCatalog

public String getCatalog()
                  throws SQLException
Retrieves this Connection object's current catalog name.

Specified by:
getCatalog in interface Connection
Returns:
the current catalog name or null if there is none
Throws:
SQLException - if a database access error occurs

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException
Retrieves a 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.

Specified by:
getMetaData in interface Connection
Returns:
a DatabaseMetaData object for this Connection object
Throws:
SQLException - if a database access error occurs

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException
Retrieves this Connection object's current transaction isolation level

Specified by:
getTransactionIsolation in interface Connection
Returns:
the current transaction isolation level, which will be one of the following constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, Connection.TRANSACTION_SERIALIZABLE, or Connection.TRANSACTION_NONE.
Throws:
SQLException - if a database access error occurs

getTypeMap

public Map getTypeMap()
               throws SQLException
Specified by:
getTypeMap in interface Connection
Returns:
Throws:
SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException
Specified by:
getWarnings in interface Connection
Returns:
Throws:
SQLException

isClosed

public boolean isClosed()
                 throws SQLException
Retrieves whether this 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.

Specified by:
isClosed in interface Connection
Returns:
true if this Connection object is closed; false if it is still open
Throws:
SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly()
                   throws SQLException
Retrieves whether this Connection object is in read-only mode.

Specified by:
isReadOnly in interface Connection
Returns:
true if this Connection object is read-only; false otherwise
Throws:
SQLException - if a database access error occurs

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException
Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it. This method returns the native form of the statement that the driver would have sent.

Specified by:
nativeSQL in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders
Returns:
the native form of this statement
Throws:
SQLException - if a database access error occurs

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException
Creates a 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.

Specified by:
prepareCall in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape s tring.
Returns:
a new default CallableStatement object containing the pre-compiled SQL statement
Throws:
SQLException - if a database access error occurs

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws 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 and concurrency to be overridden.

Specified by:
prepareCall in interface Connection
Parameters:
sql -
resultSetType -
resultSetConcurrency -
Returns:
a new CallableStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
SQLException - if a database access error occurs

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException
Creates a 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.

Specified by:
prepareStatement in interface Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:
new default PreparedStatement object containing the pre-compiled SQL statement
Throws:
SQLException - if a database access error occurs

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException
Creates a 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.

Specified by:
prepareStatement in interface Connection
Parameters:
sql -
resultSetType -
resultSetConcurrency -
Returns:
a new PreparedStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
SQLException - if a database access error occurs

rollback

public void rollback()
              throws SQLException
Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.

Specified by:
rollback in interface Connection
Throws:
SQLException - if a database access error occurs or this Connection object is in auto-commit mode

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException
Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet object, the statement completes when the last row of the ResultSet object has been retrieved or the ResultSet object has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases, the commit occurs when all results and output parameter values have been retrieved.

Specified by:
setAutoCommit in interface Connection
Parameters:
autoCommit -
Throws:
SQLException - if a database access error occurs

setCatalog

public void setCatalog(String catalog)
                throws SQLException
Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.

If the driver does not support catalogs, it will silently ignore this request.

Specified by:
setCatalog in interface Connection
Parameters:
catalog -
Throws:
SQLException - if a database access error occurs

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException
Puts this connection in read-only mode as a hint to the driver to enable database optimizations.

Specified by:
setReadOnly in interface Connection
Parameters:
readOnly -
Throws:
SQLException - if a database access error occurs

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException
Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

Specified by:
setTransactionIsolation in interface Connection
Parameters:
level -
Throws:
SQLException - if a database access error occurs

setTypeMap

public void setTypeMap(Map map)
                throws SQLException
Installs the given TypeMap object as the type map for this Connection object. The type map will be used for the custom mapping of SQL s tructured types and distinct types.

Specified by:
setTypeMap in interface Connection
Parameters:
map -
Throws:
SQLException - if a database access error occurs

toString

public String toString()
Overrides:
toString in class Object

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
                          throws SQLException
Specified by:
createStatement in interface Connection
Parameters:
resultSetType -
resultSetConcurrency -
resultSetHoldability -
Returns:
Throws:
SQLException

getHoldability

public int getHoldability()
                   throws SQLException
Specified by:
getHoldability in interface Connection
Returns:
Throws:
SQLException

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException
Specified by:
prepareCall in interface Connection
Parameters:
sql -
resultSetType -
resultSetConcurrency -
resultSetHoldability -
Returns:
Throws:
SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException
Specified by:
prepareStatement in interface Connection
Parameters:
sql -
autoGeneratedKeys -
Returns:
Throws:
SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws SQLException
Specified by:
prepareStatement in interface Connection
Parameters:
sql -
resultSetType -
resultSetConcurrency -
resultSetHoldability -
Returns:
Throws:
SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int[] columnIndexes)
                                   throws SQLException
Specified by:
prepareStatement in interface Connection
Parameters:
sql -
columnIndexes -
Returns:
Throws:
SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
                                   throws SQLException
Specified by:
prepareStatement in interface Connection
Parameters:
sql -
columnNames -
Returns:
Throws:
SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException
Specified by:
releaseSavepoint in interface Connection
Parameters:
savepoint -
Throws:
SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException
Specified by:
rollback in interface Connection
Parameters:
savepoint -
Throws:
SQLException

setHoldability

public void setHoldability(int holdability)
                    throws SQLException
Specified by:
setHoldability in interface Connection
Parameters:
holdability -
Throws:
SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException
Specified by:
setSavepoint in interface Connection
Returns:
Throws:
SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException
Specified by:
setSavepoint in interface Connection
Parameters:
name -
Returns:
Throws:
SQLException


This software is published under the BSD license. Copyright © 2003-2007, OMEX AG, Switzerland, All rights reserved. Use is subject to license terms.