Top Description Fields Constructors Methods
org.apache.derby.client.am

public Class LogicalConnection

extends Object
implements Connection
Class Inheritance
All Implemented Interfaces
java.sql.Connection, java.lang.AutoCloseable, java.sql.Wrapper
Known Direct Subclasses
org.apache.derby.client.am.CachingLogicalConnection
Imports
java.sql.Array, .Blob, .CallableStatement, .Clob, .Connection, .DatabaseMetaData, .NClob, .PreparedStatement, .SQLClientInfoException, .SQLException, .SQLWarning, .SQLXML, .Savepoint, .Statement, .Struct, java.util.Map, .Properties, java.util.concurrent.Executor, org.apache.derby.client.ClientPooledConnection, org.apache.derby.shared.common.reference.SQLState
A simple delegation wrapper handle for a physical connection.

All methods of the Connection interface are forwarded to the underlying physical connection, except for close() and isClosed(). When a physical connection is wrapped, it is non-null, when the logical connection is closed, the wrapped physical connection is always set to null. Both the finalizer and the close-methods will always set the physical connection to null. After the physical connection has been nulled out, only the PooledConnection instance will maintain a handle to the physical connection.

Field Summary

Modifier and TypeField and Description
private LogicalDatabaseMetaData
logicalDatabaseMetaData

Logical database metadata object created on demand and then cached.

pack-priv ClientConnection
physicalConnection_

Underlying physical connection for this logical connection.

private ClientPooledConnection
pooledConnection_

Constructor Summary

AccessConstructor and Description
public
LogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection)

Method Summary

Modifier and TypeMethod and Description
public void
abort(Executor
The Executor implementation which will be used by abort.
executor)

Implements java.sql.Connection.abort.

Terminates an open connection.
protected final void
checkForNullPhysicalConnection()

Verifies that there is an underlying physical connection for this logical connection.

public synchronized void
clearWarnings()

Implements java.sql.Connection.clearWarnings.

Clears all warnings reported for this Connection object.
public void
close()

Implements java.sql.Connection.close.

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

public synchronized void
commit()

Implements java.sql.Connection.commit.

Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.
public Array
createArrayOf(String
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
typeName, Object[]
the elements that populate the returned object
elements)

Implements java.sql.Connection.createArrayOf.

Factory method for creating Array objects.
public Blob
createBlob()

Implements java.sql.Connection.createBlob.

Constructs an object that implements the Blob interface.
public Clob
createClob()

Implements java.sql.Connection.createClob.

Constructs an object that implements the Clob interface.
public NClob
createNClob()

Implements java.sql.Connection.createNClob.

Constructs an object that implements the NClob interface.
public SQLXML
createSQLXML()

Implements java.sql.Connection.createSQLXML.

Constructs an object that implements the SQLXML interface.
public synchronized Statement
createStatement()

Implements java.sql.Connection.createStatement.

Creates a Statement object for sending SQL statements to the database.
public synchronized Statement
createStatement(int
a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency)

Implements java.sql.Connection.createStatement.

Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
public synchronized Statement
createStatement(int
one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency, int
one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
resultSetHoldability)

Implements java.sql.Connection.createStatement.

Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
public Struct
createStruct(String
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.
typeName, Object[]
the attributes that populate the returned object
attributes)

Implements java.sql.Connection.createStruct.

Factory method for creating Struct objects.
protected void
finalize()

Overrides java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
public synchronized boolean
getAutoCommit()

Implements java.sql.Connection.getAutoCommit.

Retrieves the current auto-commit mode for this Connection object.
public synchronized String
getCatalog()

Implements java.sql.Connection.getCatalog.

Retrieves this Connection object's current catalog name.
public Properties

Returns:

an empty Properties object
getClientInfo()

Implements java.sql.Connection.getClientInfo.

getClientInfo forwards to physicalConnection_.
public String

Returns:

a property value String
getClientInfo(String
a property key to get String
name)

Implements java.sql.Connection.getClientInfo.

getClientInfo forwards to physicalConnection_.
public synchronized int
getHoldability()

Implements java.sql.Connection.getHoldability.

Retrieves the current holdability of ResultSet objects created using this Connection object.
public synchronized DatabaseMetaData

Returns:

A database metadata object.
getMetaData()

Implements java.sql.Connection.getMetaData.

Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.
public int
getNetworkTimeout()

Implements java.sql.Connection.getNetworkTimeout.

Retrieves the number of milliseconds the driver will wait for a database request to complete.
pack-priv final synchronized DatabaseMetaData

Returns:

The metadata object from the underlying physical connection.
getRealMetaDataObject()

Returns the real underlying database metadata object.

public synchronized String
getSchema()

Implements java.sql.Connection.getSchema.

Get the name of the current schema.
public int
getServerVersion()

public int

Returns:

transaction id
getTransactionID()

Returns the client-side transaction id from am.Connection.

public synchronized int
getTransactionIsolation()

Implements java.sql.Connection.getTransactionIsolation.

Retrieves this Connection object's current transaction isolation level.
public synchronized Map<String, Class<?>>
getTypeMap()

Implements java.sql.Connection.getTypeMap.

Retrieves the Map object associated with this Connection object.
public synchronized SQLWarning
getWarnings()

Implements java.sql.Connection.getWarnings.

Retrieves the first warning reported by calls on this Connection object.
public boolean
isClosed()

Implements java.sql.Connection.isClosed.

Retrieves whether this Connection object has been closed.
public synchronized boolean
isReadOnly()

Implements java.sql.Connection.isReadOnly.

Retrieves whether this Connection object is in read-only mode.
public synchronized boolean

Returns:

true if the connection is valid, false otherwise
isValid(int
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.
timeout)

Implements java.sql.Connection.isValid.

Checks if the connection has not been closed and is still valid.
public boolean
isWrapperFor(Class<?>
a Class defining an interface.
interfaces)

Implements java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
public synchronized String
nativeSQL(String
an SQL statement that may contain one or more '?' parameter placeholders
sql)

Implements java.sql.Connection.nativeSQL.

Converts the given SQL statement into the system's native SQL grammar.
protected LogicalDatabaseMetaData

Returns:

A logical database metadata object.
newLogicalDatabaseMetaData()

Returns a newly created logical database metadata object.

pack-priv final void
notifyException(SQLException
the cause of the notification
sqle)

Notifies listeners about exceptions of session level severity or higher.

public synchronized void
nullPhysicalConnection()

public synchronized CallableStatement
prepareCall(String
an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is specified using JDBC call escape syntax.
sql)

Implements java.sql.Connection.prepareCall.

Creates a CallableStatement object for calling database stored procedures.
public synchronized CallableStatement
prepareCall(String
a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
sql, int
a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency)

Implements java.sql.Connection.prepareCall.

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
public synchronized CallableStatement
prepareCall(String
a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
sql, int
one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency, int
one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
resultSetHoldability)

Implements java.sql.Connection.prepareCall.

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
public synchronized PreparedStatement
prepareStatement(String
an SQL statement that may contain one or more '?' IN parameter placeholders
sql)

Implements java.sql.Connection.prepareStatement.

Creates a PreparedStatement object for sending parameterized SQL statements to the database.
public synchronized PreparedStatement
prepareStatement(String
a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
sql, int
a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency)

Implements java.sql.Connection.prepareStatement.

Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
public synchronized PreparedStatement
prepareStatement(String
a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
sql, int
one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetType, int
one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetConcurrency, int
one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
resultSetHoldability)

Implements java.sql.Connection.prepareStatement.

Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
public synchronized PreparedStatement
prepareStatement(String
an SQL statement that may contain one or more '?' IN parameter placeholders
sql, int
a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
autoGeneratedKeys)

Implements java.sql.Connection.prepareStatement.

Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
public synchronized PreparedStatement
prepareStatement(String
an SQL statement that may contain one or more '?' IN parameter placeholders
sql, int[]
an array of column indexes indicating the columns that should be returned from the inserted row or rows
columnIndexes)

Implements java.sql.Connection.prepareStatement.

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
public synchronized PreparedStatement
prepareStatement(String
an SQL statement that may contain one or more '?' IN parameter placeholders
sql, String[]
an array of column names indicating the columns that should be returned from the inserted row or rows
columnNames)

Implements java.sql.Connection.prepareStatement.

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
public synchronized void
releaseSavepoint(Savepoint
the Savepoint object to be removed
savepoint)

Implements java.sql.Connection.releaseSavepoint.

Removes the specified Savepoint and subsequent Savepoint objects from the current transaction.
public synchronized void
rollback()

Implements java.sql.Connection.rollback.

Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object.
public synchronized void
rollback(Savepoint
the Savepoint object to roll back to
savepoint)

Implements java.sql.Connection.rollback.

Undoes all changes made after the given Savepoint object was set.
public synchronized void
setAutoCommit(boolean
true to enable auto-commit mode; false to disable it
autoCommit)

Implements java.sql.Connection.setAutoCommit.

Sets this connection's auto-commit mode to the given state.
public synchronized void
setCatalog(String
the name of a catalog (subspace in this Connection object's database) in which to work
catalog)

Implements java.sql.Connection.setCatalog.

Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.
public void
setClientInfo(Properties
a Properties object with the properties to set
properties)

Implements java.sql.Connection.setClientInfo.

setClientInfo forwards to physicalConnection_.
public void
setClientInfo(String
a property key String
name, String
a property value String
value)

Implements java.sql.Connection.setClientInfo.

setClientInfo forwards to physicalConnection_.
public synchronized void
setHoldability(int
a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
holdability)

Implements java.sql.Connection.setHoldability.

Changes the default holdability of ResultSet objects created using this Connection object to the given holdability.
public void
setNetworkTimeout(Executor
The Executor implementation which will be used by setNetworkTimeout.
executor, int
The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is not timeout for database operations.
milliseconds)

Implements java.sql.Connection.setNetworkTimeout.

Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request.
public synchronized void
setReadOnly(boolean
true enables read-only mode; false disables it
readOnly)

Implements java.sql.Connection.setReadOnly.

Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
public synchronized Savepoint
setSavepoint()

Implements java.sql.Connection.setSavepoint.

Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
public synchronized Savepoint
setSavepoint(String
a String containing the name of the savepoint
name)

Implements java.sql.Connection.setSavepoint.

Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
public synchronized void
setSchema(String
the name of a schema in which to work
schemaName)

Implements java.sql.Connection.setSchema.

Set the default schema for the Connection.
public synchronized void
setTransactionIsolation(int
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.)
level)

Implements java.sql.Connection.setTransactionIsolation.

Attempts to change the transaction isolation level for this Connection object to the one given.
public synchronized void
setTypeMap(Map<K, V>
the java.util.Map object to install as the replacement for this Connection object's default type map
map)

Implements java.sql.Connection.setTypeMap.

Installs the given TypeMap object as the type map for this Connection object.
public <T> T
unwrap(Class<T>
A Class defining an interface that the result must implement.
interfaces)

Implements java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait