org.firebirdsql.jdbc
Class AbstractConnection

java.lang.Object
  extended byorg.firebirdsql.jdbc.AbstractConnection
All Implemented Interfaces:
java.sql.Connection, FirebirdConnection

public abstract class AbstractConnection
extends java.lang.Object
implements FirebirdConnection

The class AbstractConnection is a handle to a FBManagedConnection.

Version:
1.0
Author:
David Jencks

Field Summary
protected  FBManagedConnection mc
           
 
Fields inherited from interface org.firebirdsql.jdbc.FirebirdConnection
TPB_CONCURRENCY, TPB_CONSISTENCY, TPB_NO_REC_VERSION, TPB_NOWAIT, TPB_READ, TPB_READ_COMMITTED, TPB_REC_VERSION, TPB_WAIT, TPB_WRITE
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
AbstractConnection(FBManagedConnection mc)
           
 
Method Summary
protected  void addWarning(java.sql.SQLWarning warning)
           
 void checkEndTransaction()
           
 void checkEndTransaction(boolean commit)
           
 void clearWarnings()
          Clears all warnings reported for this Connection object.
 void close()
          Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.
 void closeBlob(isc_blob_handle blob)
           
 void closeStatement(isc_stmt_handle stmt, boolean deallocate)
           
 void commit()
          Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
 FirebirdBlob createBlob()
          This non- interface method is included so you can actually get a blob object to use to write new data into a blob field without needing a preexisting blob to modify.
 isc_blob_handle createBlobHandle(boolean segmented)
           
 java.sql.Statement createStatement()
          Creates a Statement object for sending SQL statements to the database.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.ResultSet doQuery(java.lang.String sql, java.util.List params, java.util.HashMap statements)
           
 void ensureInTransaction()
          The ensureInTransaction method starts a local transaction if a transaction is not associated with this connection.
 void executeStatement(isc_stmt_handle stmt, boolean sendOutSqlda)
           
 void fetch(isc_stmt_handle stmt, int fetchSize)
           
protected  void finalize()
           
 isc_stmt_handle getAllocatedStatement()
           
 boolean getAutoCommit()
          Gets the current auto-commit state.
 java.lang.Integer getBlobBufferLength()
           
 byte[] getBlobSegment(isc_blob_handle blob, int len)
           
 java.lang.String getCatalog()
          Returns the Connection's current catalog name.
 DatabaseParameterBuffer getDatabaseParameterBuffer()
          Get database parameter buffer for this connection.
 int getDatabaseProductMajorVersion()
           
 int getDatabaseProductMinorVersion()
           
 java.lang.String getDatabaseProductName()
           
 java.lang.String getDatabaseProductVersion()
           
 GDS getInternalAPIHandler()
          Get Firebird API handler (sockets/native/embeded/etc)
 isc_db_handle getIscDBHandle()
          Get connection handle for direct Firebird API access
 java.lang.String getIscEncoding()
          Get current ISC encoding.
 java.lang.String getJavaEncoding()
           
 FBLocalTransaction getLocalTransaction()
           
 java.lang.String getMappingPath()
           
 java.sql.DatabaseMetaData getMetaData()
          Gets the metadata regarding this connection's database.
 void getSqlCounts(isc_stmt_handle stmt)
           
 int getTransactionIsolation()
          Gets this Connection's current transaction isolation level.
 java.util.Map getTypeMap()
          Gets the type map object associated with this connection.
 java.sql.SQLWarning getWarnings()
          Returns the first warning reported by calls on this Connection.
 boolean inTransaction()
           
 boolean isClosed()
          Tests to see if a Connection is closed.
 boolean isReadOnly()
          Tests to see if the connection is in read-only mode.
 java.lang.String nativeSQL(java.lang.String sql)
          Converts the given SQL statement into the system's native SQL grammar.
 isc_blob_handle openBlobHandle(long blob_id, boolean segmented)
           
 java.sql.CallableStatement prepareCall(java.lang.String sql)
          Creates a CallableStatement object for calling database stored procedures.
 java.sql.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.
 void prepareSQL(isc_stmt_handle stmt, java.lang.String sql, boolean describeBind)
           
 java.sql.PreparedStatement prepareStatement(java.lang.String sql)
          Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 java.sql.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.
 void putBlobSegment(isc_blob_handle blob, byte[] buf)
           
 void registerStatement(AbstractStatement fbStatement)
           
 void rollback()
          Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection.
 void setAutoCommit(boolean autoCommit)
          Sets this connection's auto-commit mode.
 void setCatalog(java.lang.String catalog)
          Sets a catalog name in order to select a subspace of this Connection's database in which to work.
 void setCursorName(isc_stmt_handle stmt, java.lang.String cursorName)
           
 void setManagedConnection(FBManagedConnection mc)
           
 void setReadOnly(boolean readOnly)
          Puts this connection in read-only mode as a hint to enable database optimizations.
 void setTransactionIsolation(int level)
          Attempts to change the transaction isolation level to the one given.
 void setTransactionParameters(int isolationLevel, int[] parameters)
          Set transaction parameters for the specified isolation level.
 void setTypeMap(java.util.Map map)
          Installs the given type map as the type map for this connection.
 boolean willEndTransaction()
          The willEndTransaction method determines if the current transaction should be automatically ended when the current statement executes.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.sql.Connection
createStatement, getHoldability, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, setHoldability, setSavepoint, setSavepoint
 

Field Detail

mc

protected FBManagedConnection mc
Constructor Detail

AbstractConnection

public AbstractConnection(FBManagedConnection mc)
Method Detail

setManagedConnection

public void setManagedConnection(FBManagedConnection mc)

getIscDBHandle

public isc_db_handle getIscDBHandle()
                             throws GDSException
Get connection handle for direct Firebird API access

Returns:
internal handle for connection
Throws:
GDSException - if handle needed to be created and creation failed

getInternalAPIHandler

public GDS getInternalAPIHandler()
Get Firebird API handler (sockets/native/embeded/etc)

Returns:
handler object for internal API calls

getDatabaseParameterBuffer

public DatabaseParameterBuffer getDatabaseParameterBuffer()
Get database parameter buffer for this connection.

Returns:
instance of DatabaseParameterBuffer.

setTransactionParameters

public void setTransactionParameters(int isolationLevel,
                                     int[] parameters)
                              throws java.sql.SQLException
Description copied from interface: FirebirdConnection
Set transaction parameters for the specified isolation level. They will take effect only on the newly started transaction.

Specified by:
setTransactionParameters in interface FirebirdConnection
Parameters:
isolationLevel - JDBC isolation level.
parameters - array of TPB parameters, see all TPB_* constants.
Throws:
java.sql.SQLException - if specified transaction parameters cannot be set.

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.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 is more efficient to use a PreparedStatement object.

Result sets created using the returned Statement object will by default have forward-only type and read-only concurrency.

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

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.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.

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 is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.

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

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.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.

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 will have forward-only type and read-only concurrency, by default.

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

nativeSQL

public java.lang.String nativeSQL(java.lang.String sql)
                           throws java.sql.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 java.sql.Connection
Parameters:
sql - a SQL statement that may contain one or more '?' parameter placeholders
Returns:
the native form of this statement
Throws:
java.sql.SQLException - if a database access error occurs

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws java.sql.SQLException
Sets this connection's auto-commit mode. 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, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet 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 java.sql.Connection
Parameters:
autoCommit - true enables auto-commit; false disables auto-commit.
Throws:
java.sql.SQLException - if a database access error occurs

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
Gets the current auto-commit state.

Specified by:
getAutoCommit in interface java.sql.Connection
Returns:
the current state of auto-commit mode
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

commit

public void commit()
            throws java.sql.SQLException
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. This method should be used only when auto-commit mode has been disabled.

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

rollback

public void rollback()
              throws java.sql.SQLException
Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto- commit has been disabled.

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
setAutoCommit(boolean)

close

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

Note: A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.

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

isClosed

public boolean isClosed()
Tests to see if a Connection is closed.

Specified by:
isClosed in interface java.sql.Connection
Returns:
true if the connection is closed; false if it's still open

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
Gets the metadata regarding this connection's database. A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object.

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

setReadOnly

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

Note: This method cannot be called while in the middle of a transaction.

Specified by:
setReadOnly in interface java.sql.Connection
Parameters:
readOnly - true enables read-only mode; false disables read-only mode.
Throws:
java.sql.SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Tests to see if the connection is in read-only mode.

Specified by:
isReadOnly in interface java.sql.Connection
Returns:
true if connection is read-only and false otherwise
Throws:
java.sql.SQLException - if a database access error occurs

setCatalog

public void setCatalog(java.lang.String catalog)
                throws java.sql.SQLException
Sets a catalog name in order to select a subspace of this Connection's database in which to work. If the driver does not support catalogs, it will silently ignore this request.

Specified by:
setCatalog in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
Returns the Connection's current catalog name.

Specified by:
getCatalog in interface java.sql.Connection
Returns:
the current catalog name or null
Throws:
java.sql.SQLException - if a database access error occurs

setTransactionIsolation

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

Calling this method will commit any current transaction.

Specified by:
setTransactionIsolation in interface java.sql.Connection
Parameters:
level - one of the TRANSACTION_* isolation values with the exception of TRANSACTION_NONE; some databases may not support other values
Throws:
java.sql.SQLException - if a database access error occurs
See Also:
DatabaseMetaData.supportsTransactionIsolationLevel(int)

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
Gets this Connection's current transaction isolation level.

Specified by:
getTransactionIsolation in interface java.sql.Connection
Returns:
the current TRANSACTION_* mode value
Throws:
java.sql.SQLException - if a database access error occurs

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
Returns the first warning reported by calls on this Connection.

Note: Subsequent warnings will be chained to this SQLWarning.

Specified by:
getWarnings in interface java.sql.Connection
Returns:
the first SQLWarning or null
Throws:
java.sql.SQLException - if a database access error occurs

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection.

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

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException
Creates a 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 result set concurrency type to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - a result set type; see ResultSet.TYPE_XXX
resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
Returns:
a new Statement object
Throws:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.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 result set concurrency type to be overridden.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
resultSetType - a result set type; see ResultSet.TYPE_XXX
resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
Returns:
a new PreparedStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

prepareCall

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

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
resultSetType - a result set type; see ResultSet.TYPE_XXX
resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
Returns:
a new CallableStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getTypeMap

public java.util.Map getTypeMap()
                         throws java.sql.SQLException
Gets the type map object associated with this connection. Unless the application has added an entry to the type map, the map returned will be empty.

Specified by:
getTypeMap in interface java.sql.Connection
Returns:
the java.util.Map object associated with this Connection object
Throws:
java.sql.SQLException
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

setTypeMap

public void setTypeMap(java.util.Map map)
                throws java.sql.SQLException
Installs the given type map as the type map for this connection. The type map will be used for the custom mapping of SQL structured types and distinct types.

Specified by:
setTypeMap in interface java.sql.Connection
Parameters:
map - the java.util.Map object to install as the replacement for this Connection object's default type map
Throws:
java.sql.SQLException
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getLocalTransaction

public FBLocalTransaction getLocalTransaction()

createBlob

public FirebirdBlob createBlob()
                        throws java.sql.SQLException
This non- interface method is included so you can actually get a blob object to use to write new data into a blob field without needing a preexisting blob to modify.

Specified by:
createBlob in interface FirebirdConnection
Returns:
instance of FirebirdBlob.
Throws:
java.sql.SQLException - if something went wrong.

inTransaction

public boolean inTransaction()

getIscEncoding

public java.lang.String getIscEncoding()
Description copied from interface: FirebirdConnection
Get current ISC encoding.

Specified by:
getIscEncoding in interface FirebirdConnection
Returns:
current ISC encoding.

ensureInTransaction

public void ensureInTransaction()
                         throws java.sql.SQLException
The ensureInTransaction method starts a local transaction if a transaction is not associated with this connection.

Returns:
a boolean value, true if transaction was started.
Throws:
java.sql.SQLException

willEndTransaction

public boolean willEndTransaction()
                           throws java.sql.SQLException
The willEndTransaction method determines if the current transaction should be automatically ended when the current statement executes. for use in jca contexts, autocommit is always true, and autoTransaction is true if the current transaction was started automatically. Using jdbc transaction control, if autocommit is false, transactions are started automatically but not ended automatically.

Returns:
a boolean value
Throws:
java.sql.SQLException

checkEndTransaction

public void checkEndTransaction()
                         throws java.sql.SQLException
Throws:
java.sql.SQLException

checkEndTransaction

public void checkEndTransaction(boolean commit)
                         throws java.sql.SQLException
Throws:
java.sql.SQLException

addWarning

protected void addWarning(java.sql.SQLWarning warning)

getAllocatedStatement

public isc_stmt_handle getAllocatedStatement()
                                      throws GDSException
Throws:
GDSException

executeStatement

public void executeStatement(isc_stmt_handle stmt,
                             boolean sendOutSqlda)
                      throws GDSException
Throws:
GDSException

closeStatement

public void closeStatement(isc_stmt_handle stmt,
                           boolean deallocate)
                    throws GDSException
Throws:
GDSException

prepareSQL

public void prepareSQL(isc_stmt_handle stmt,
                       java.lang.String sql,
                       boolean describeBind)
                throws GDSException,
                       java.sql.SQLException
Throws:
GDSException
java.sql.SQLException

registerStatement

public void registerStatement(AbstractStatement fbStatement)

fetch

public void fetch(isc_stmt_handle stmt,
                  int fetchSize)
           throws GDSException
Throws:
GDSException

setCursorName

public void setCursorName(isc_stmt_handle stmt,
                          java.lang.String cursorName)
                   throws GDSException
Throws:
GDSException

getSqlCounts

public void getSqlCounts(isc_stmt_handle stmt)
                  throws GDSException
Throws:
GDSException

getDatabaseProductName

public java.lang.String getDatabaseProductName()

getDatabaseProductVersion

public java.lang.String getDatabaseProductVersion()

getDatabaseProductMajorVersion

public int getDatabaseProductMajorVersion()

getDatabaseProductMinorVersion

public int getDatabaseProductMinorVersion()

getBlobBufferLength

public java.lang.Integer getBlobBufferLength()

openBlobHandle

public isc_blob_handle openBlobHandle(long blob_id,
                                      boolean segmented)
                               throws GDSException
Throws:
GDSException

getBlobSegment

public byte[] getBlobSegment(isc_blob_handle blob,
                             int len)
                      throws GDSException
Throws:
GDSException

closeBlob

public void closeBlob(isc_blob_handle blob)
               throws GDSException
Throws:
GDSException

createBlobHandle

public isc_blob_handle createBlobHandle(boolean segmented)
                                 throws GDSException
Throws:
GDSException

putBlobSegment

public void putBlobSegment(isc_blob_handle blob,
                           byte[] buf)
                    throws GDSException
Throws:
GDSException

getJavaEncoding

public java.lang.String getJavaEncoding()

getMappingPath

public java.lang.String getMappingPath()

doQuery

public java.sql.ResultSet doQuery(java.lang.String sql,
                                  java.util.List params,
                                  java.util.HashMap statements)
                           throws java.sql.SQLException
Throws:
java.sql.SQLException

finalize

protected void finalize()
                 throws java.lang.Throwable
Throws:
java.lang.Throwable


Copyright © 2001 David Jencks and other authors. All rights reserved.