Class LogicalConnection

java.lang.Object

org.apache.derby.client.am.LogicalConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

Direct Known Subclasses:

CachingLogicalConnection

public class LogicalConnection
extends Object
implements Connection

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

Fields

Modifier and Type	Field	Description
private LogicalDatabaseMetaData	logicalDatabaseMetaData	Logical database metadata object created on demand and then cached.
(package private) ClientConnection	physicalConnection_	Underlying physical connection for this logical connection.
private ClientPooledConnection	pooledConnection_

Fields inherited from interface Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
LogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection)

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
protected final void	checkForNullPhysicalConnection()	Verifies that there is an underlying physical connection for this logical connection.
void	clearWarnings()
void	close()
void	closeWithoutRecyclingToPool()
void	commit()
Array	createArrayOf(String typeName, Object[] elements)	/////////////////////////////////////////////////////////////////
Blob	createBlob()
Clob	createClob()
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement()
Statement	createStatement(int resultSetType, int resultSetConcurrency)
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Struct	createStruct(String typeName, Object[] attributes)
protected void	finalize()
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()	getClientInfo forwards to physicalConnection_.
String	getClientInfo(String name)	getClientInfo forwards to physicalConnection_.
int	getHoldability()
DatabaseMetaData	getMetaData()	Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.
int	getNetworkTimeout()
(package private) final DatabaseMetaData	getRealMetaDataObject()	Returns the real underlying database metadata object.
String	getSchema()	Get the name of the current schema.
int	getServerVersion()
int	getTransactionID()	Returns the client-side transaction id from am.Connection.
int	getTransactionIsolation()
Map<String,Class<?>>	getTypeMap()
SQLWarning	getWarnings()
boolean	isClosed()
boolean	isReadOnly()
boolean	isValid(int timeout)	Checks if the connection has not been closed and is still valid.
boolean	isWrapperFor(Class<?> interfaces)
String	nativeSQL(String sql)
protected LogicalDatabaseMetaData	newLogicalDatabaseMetaData()	Returns a newly created logical database metadata object.
(package private) final void	notifyException(SQLException sqle)	Notifies listeners about exceptions of session level severity or higher.
void	nullPhysicalConnection()
CallableStatement	prepareCall(String sql)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql)
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql, String[] columnNames)
void	releaseSavepoint(Savepoint savepoint)
void	rollback()
void	rollback(Savepoint savepoint)
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(String name, String value)	setClientInfo forwards to physicalConnection_.
void	setClientInfo(Properties properties)	setClientInfo forwards to physicalConnection_.
void	setHoldability(int holdability)
void	setNetworkTimeout(Executor executor, int milliseconds)
void	setReadOnly(boolean readOnly)
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schemaName)	Set the default schema for the Connection.
void	setTransactionIsolation(int level)
void	setTypeMap(Map map)
<T> T	unwrap(Class<T> interfaces)

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Connection

beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Field Details

physicalConnection_

ClientConnection physicalConnection_

Underlying physical connection for this logical connection.

Set to null when this logical connection is closed.

pooledConnection_

private ClientPooledConnection pooledConnection_

logicalDatabaseMetaData

private LogicalDatabaseMetaData logicalDatabaseMetaData

Logical database metadata object created on demand and then cached. The lifetime of the metadata object is the same as this logical connection, in the sense that it will raise exceptions on method invocations after the logical connection has been closed.

Constructor Details

LogicalConnection

public LogicalConnection(ClientConnection physicalConnection,
 ClientPooledConnection pooledConnection)
                  throws SqlException

Throws:

SqlException

Method Details

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

nullPhysicalConnection

public void nullPhysicalConnection()

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

closeWithoutRecyclingToPool

public void closeWithoutRecyclingToPool()
                                 throws SqlException

Throws:

SqlException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

checkForNullPhysicalConnection

protected final void checkForNullPhysicalConnection()
                                             throws SQLException

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

If the physical connection has been nulled out it means that this logical connection has been closed.

Throws:

SQLException - if this logical connection has been closed

notifyException

final void notifyException(SQLException sqle)

Notifies listeners about exceptions of session level severity or higher.

The exception, even if the severity is sufficiently high, is ignored if the underlying physical connection has been nulled out. Otherwise a connectionErrorOccurred-event is sent to all the registered listeners.

Parameters:

sqle - the cause of the notification

createStatement

public Statement createStatement()
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

commit

public void commit()
            throws SQLException

Specified by:

commit in interface Connection

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

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 database metadata object is logical in the sense that it has the same lifetime as the logical connection. If the logical connection is closed, the underlying physical connection will not be accessed to obtain metadata, even if it is still open. Also, the reference to the logical connection instead of the underlying physical connection will be returned by LogicalDatabaseMetaData.getConnection().

Specified by:

getMetaData in interface Connection

Returns:

A database metadata object.

Throws:

SQLException - if an error occurs

newLogicalDatabaseMetaData

protected LogicalDatabaseMetaData newLogicalDatabaseMetaData()
                                                      throws SQLException

Returns a newly created logical database metadata object.

Subclasses should override this method to return an instance of the correct implementation class of the logical metadata object.

Returns:

A logical database metadata object.

Throws:

SQLException

getRealMetaDataObject

final DatabaseMetaData getRealMetaDataObject()
                                      throws SQLException

Returns the real underlying database metadata object.

Returns:

The metadata object from the underlying physical connection.

Throws:

SQLException - if the logical connection has been closed

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

setTypeMap

public void setTypeMap(Map map)
                throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

getHoldability

public int getHoldability()
                   throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

getTransactionID

public int getTransactionID()

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

NOTE: This method was added for testing purposes. Avoid use in production code if possible.

getServerVersion

public int getServerVersion()

createArrayOf

public Array createArrayOf(String typeName,
 Object[] elements)
                    throws SQLException

/////////////////////////////////////////////////////////////////

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStruct

public Struct createStruct(String typeName,
 Object[] attributes)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

getClientInfo

public Properties getClientInfo()
                         throws SQLException

getClientInfo forwards to physicalConnection_. getClientInfo always returns an empty Properties object since Derby doesn't support ClientInfoProperties.

Specified by:

getClientInfo in interface Connection

Returns:

an empty Properties object

Throws:

SQLException - if an error occurs

getClientInfo

public String getClientInfo(String name)
                     throws SQLException

getClientInfo forwards to physicalConnection_. Always returns a null String since Derby does not support ClientInfoProperties.

Specified by:

getClientInfo in interface Connection

Parameters:

name - a property key to get String

Returns:

a property value String

Throws:

SQLException - if an error occurs

isValid

public boolean isValid(int timeout)
                throws SQLException

Checks if the connection has not been closed and is still valid. The validity is checked by running a simple query against the database.

Specified by:

isValid in interface Connection

Parameters:

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

Returns:

true if the connection is valid, false otherwise

Throws:

SQLException - if the call on the physical connection throws an exception.

isWrapperFor

public boolean isWrapperFor(Class<?> interfaces)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

setClientInfo forwards to physicalConnection_.

Specified by:

setClientInfo in interface Connection

Parameters:

properties - a Properties object with the properties to set

Throws:

SQLClientInfoException - if an error occurs

setClientInfo

public void setClientInfo(String name,
 String value)
                   throws SQLClientInfoException

setClientInfo forwards to physicalConnection_.

Specified by:

setClientInfo in interface Connection

Parameters:

name - a property key String

value - a property value String

Throws:

SQLClientInfoException - if an error occurs

unwrap

public <T> T unwrap(Class<T> interfaces)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Get the name of the current schema.

Specified by:

getSchema in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schemaName)
               throws SQLException

Set the default schema for the Connection.

Specified by:

setSchema in interface Connection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
 int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException