Class LogicalConnection
- java.lang.Object
-
- org.apache.derby.client.am.LogicalConnection
-
- All Implemented Interfaces:
java.lang.AutoCloseable,java.sql.Connection,java.sql.Wrapper
- Direct Known Subclasses:
CachingLogicalConnection
public class LogicalConnection extends java.lang.Object implements java.sql.ConnectionA simple delegation wrapper handle for a physical connection.All methods of the
Connectioninterface are forwarded to the underlying physical connection, except forclose()andisClosed(). When a physical connection is wrapped, it is non-null, when the logical connection is closed, the wrapped physical connection is always set tonull. Both the finalizer and theclose-methods will always set the physical connection tonull. After the physical connection has been nulled out, only thePooledConnectioninstance will maintain a handle to the physical connection.
-
-
Field Summary
Fields Modifier and Type Field Description private LogicalDatabaseMetaDatalogicalDatabaseMetaDataLogical database metadata object created on demand and then cached.(package private) ClientConnectionphysicalConnection_Underlying physical connection for this logical connection.private ClientPooledConnectionpooledConnection_
-
Constructor Summary
Constructors Constructor Description LogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidabort(java.util.concurrent.Executor executor)protected voidcheckForNullPhysicalConnection()Verifies that there is an underlying physical connection for this logical connection.voidclearWarnings()voidclose()voidcloseWithoutRecyclingToPool()voidcommit()java.sql.ArraycreateArrayOf(java.lang.String typeName, java.lang.Object[] elements)java.sql.BlobcreateBlob()java.sql.ClobcreateClob()java.sql.NClobcreateNClob()java.sql.SQLXMLcreateSQLXML()java.sql.StatementcreateStatement()java.sql.StatementcreateStatement(int resultSetType, int resultSetConcurrency)java.sql.StatementcreateStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)java.sql.StructcreateStruct(java.lang.String typeName, java.lang.Object[] attributes)protected voidfinalize()booleangetAutoCommit()java.lang.StringgetCatalog()java.util.PropertiesgetClientInfo()getClientInfoforwards tophysicalConnection_.java.lang.StringgetClientInfo(java.lang.String name)getClientInfoforwards tophysicalConnection_.intgetHoldability()java.sql.DatabaseMetaDatagetMetaData()Retrieves aDatabaseMetaDataobject that contains metadata about the database to which thisConnectionobject represents a connection.intgetNetworkTimeout()(package private) java.sql.DatabaseMetaDatagetRealMetaDataObject()Returns the real underlying database metadata object.java.lang.StringgetSchema()Get the name of the current schema.intgetServerVersion()intgetTransactionID()Returns the client-side transaction id from am.Connection.intgetTransactionIsolation()java.util.Map<java.lang.String,java.lang.Class<?>>getTypeMap()java.sql.SQLWarninggetWarnings()booleanisClosed()booleanisReadOnly()booleanisValid(int timeout)Checks if the connection has not been closed and is still valid.booleanisWrapperFor(java.lang.Class<?> interfaces)java.lang.StringnativeSQL(java.lang.String sql)protected LogicalDatabaseMetaDatanewLogicalDatabaseMetaData()Returns a newly created logical database metadata object.(package private) voidnotifyException(java.sql.SQLException sqle)Notifies listeners about exceptions of session level severity or higher.voidnullPhysicalConnection()java.sql.CallableStatementprepareCall(java.lang.String sql)java.sql.CallableStatementprepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)java.sql.CallableStatementprepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)java.sql.PreparedStatementprepareStatement(java.lang.String sql)java.sql.PreparedStatementprepareStatement(java.lang.String sql, int autoGeneratedKeys)java.sql.PreparedStatementprepareStatement(java.lang.String sql, int[] columnIndexes)java.sql.PreparedStatementprepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)java.sql.PreparedStatementprepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)java.sql.PreparedStatementprepareStatement(java.lang.String sql, java.lang.String[] columnNames)voidreleaseSavepoint(java.sql.Savepoint savepoint)voidrollback()voidrollback(java.sql.Savepoint savepoint)voidsetAutoCommit(boolean autoCommit)voidsetCatalog(java.lang.String catalog)voidsetClientInfo(java.lang.String name, java.lang.String value)setClientInfoforwards tophysicalConnection_.voidsetClientInfo(java.util.Properties properties)setClientInfoforwards tophysicalConnection_.voidsetHoldability(int holdability)voidsetNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds)voidsetReadOnly(boolean readOnly)java.sql.SavepointsetSavepoint()java.sql.SavepointsetSavepoint(java.lang.String name)voidsetSchema(java.lang.String schemaName)Set the default schema for the Connection.voidsetTransactionIsolation(int level)voidsetTypeMap(java.util.Map map)<T> Tunwrap(java.lang.Class<T> interfaces)
-
-
-
Field Detail
-
physicalConnection_
ClientConnection physicalConnection_
Underlying physical connection for this logical connection.Set to
nullwhen 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 Detail
-
LogicalConnection
public LogicalConnection(ClientConnection physicalConnection, ClientPooledConnection pooledConnection) throws SqlException
- Throws:
SqlException
-
-
Method Detail
-
finalize
protected void finalize() throws java.lang.Throwable- Overrides:
finalizein classjava.lang.Object- Throws:
java.lang.Throwable
-
nullPhysicalConnection
public void nullPhysicalConnection()
-
close
public void close() throws java.sql.SQLException- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
closeWithoutRecyclingToPool
public void closeWithoutRecyclingToPool() throws SqlException- Throws:
SqlException
-
isClosed
public boolean isClosed() throws java.sql.SQLException- Specified by:
isClosedin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
checkForNullPhysicalConnection
protected final void checkForNullPhysicalConnection() throws java.sql.SQLExceptionVerifies 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:
java.sql.SQLException- if this logical connection has been closed
-
notifyException
final void notifyException(java.sql.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 java.sql.Statement createStatement() throws java.sql.SQLException- Specified by:
createStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql) throws java.sql.SQLException- Specified by:
prepareCallin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
nativeSQL
public java.lang.String nativeSQL(java.lang.String sql) throws java.sql.SQLException- Specified by:
nativeSQLin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setAutoCommit
public void setAutoCommit(boolean autoCommit) throws java.sql.SQLException- Specified by:
setAutoCommitin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getAutoCommit
public boolean getAutoCommit() throws java.sql.SQLException- Specified by:
getAutoCommitin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
commit
public void commit() throws java.sql.SQLException- Specified by:
commitin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
rollback
public void rollback() throws java.sql.SQLException- Specified by:
rollbackin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setTransactionIsolation
public void setTransactionIsolation(int level) throws java.sql.SQLException- Specified by:
setTransactionIsolationin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getTransactionIsolation
public int getTransactionIsolation() throws java.sql.SQLException- Specified by:
getTransactionIsolationin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getWarnings
public java.sql.SQLWarning getWarnings() throws java.sql.SQLException- Specified by:
getWarningsin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
clearWarnings
public void clearWarnings() throws java.sql.SQLException- Specified by:
clearWarningsin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getMetaData
public java.sql.DatabaseMetaData getMetaData() throws java.sql.SQLExceptionRetrieves aDatabaseMetaDataobject that contains metadata about the database to which thisConnectionobject 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:
getMetaDatain interfacejava.sql.Connection- Returns:
- A database metadata object.
- Throws:
java.sql.SQLException- if an error occurs
-
newLogicalDatabaseMetaData
protected LogicalDatabaseMetaData newLogicalDatabaseMetaData() throws java.sql.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:
java.sql.SQLException
-
getRealMetaDataObject
final java.sql.DatabaseMetaData getRealMetaDataObject() throws java.sql.SQLExceptionReturns the real underlying database metadata object.- Returns:
- The metadata object from the underlying physical connection.
- Throws:
java.sql.SQLException- if the logical connection has been closed
-
setReadOnly
public void setReadOnly(boolean readOnly) throws java.sql.SQLException- Specified by:
setReadOnlyin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
isReadOnly
public boolean isReadOnly() throws java.sql.SQLException- Specified by:
isReadOnlyin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setCatalog
public void setCatalog(java.lang.String catalog) throws java.sql.SQLException- Specified by:
setCatalogin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getCatalog
public java.lang.String getCatalog() throws java.sql.SQLException- Specified by:
getCatalogin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createStatement
public java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency) throws java.sql.SQLException- Specified by:
createStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency) throws java.sql.SQLException- Specified by:
prepareCallin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getTypeMap
public java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap() throws java.sql.SQLException- Specified by:
getTypeMapin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setTypeMap
public void setTypeMap(java.util.Map map) throws java.sql.SQLException- Specified by:
setTypeMapin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createStatement
public java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLException- Specified by:
createStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareCall
public java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLException- Specified by:
prepareCallin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
prepareStatement
public java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException- Specified by:
prepareStatementin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setHoldability
public void setHoldability(int holdability) throws java.sql.SQLException- Specified by:
setHoldabilityin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getHoldability
public int getHoldability() throws java.sql.SQLException- Specified by:
getHoldabilityin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setSavepoint
public java.sql.Savepoint setSavepoint() throws java.sql.SQLException- Specified by:
setSavepointin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setSavepoint
public java.sql.Savepoint setSavepoint(java.lang.String name) throws java.sql.SQLException- Specified by:
setSavepointin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
rollback
public void rollback(java.sql.Savepoint savepoint) throws java.sql.SQLException- Specified by:
rollbackin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
releaseSavepoint
public void releaseSavepoint(java.sql.Savepoint savepoint) throws java.sql.SQLException- Specified by:
releaseSavepointin interfacejava.sql.Connection- Throws:
java.sql.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 java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements) throws java.sql.SQLException- Specified by:
createArrayOfin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createBlob
public java.sql.Blob createBlob() throws java.sql.SQLException- Specified by:
createBlobin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createClob
public java.sql.Clob createClob() throws java.sql.SQLException- Specified by:
createClobin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createNClob
public java.sql.NClob createNClob() throws java.sql.SQLException- Specified by:
createNClobin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createSQLXML
public java.sql.SQLXML createSQLXML() throws java.sql.SQLException- Specified by:
createSQLXMLin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
createStruct
public java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes) throws java.sql.SQLException- Specified by:
createStructin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getClientInfo
public java.util.Properties getClientInfo() throws java.sql.SQLExceptiongetClientInfoforwards tophysicalConnection_.getClientInfoalways returns an emptyPropertiesobject since Derby doesn't support ClientInfoProperties.- Specified by:
getClientInfoin interfacejava.sql.Connection- Returns:
- an empty
Propertiesobject - Throws:
java.sql.SQLException- if an error occurs
-
getClientInfo
public java.lang.String getClientInfo(java.lang.String name) throws java.sql.SQLExceptiongetClientInfoforwards tophysicalConnection_. Always returns anull Stringsince Derby does not support ClientInfoProperties.- Specified by:
getClientInfoin interfacejava.sql.Connection- Parameters:
name- a property key to getString- Returns:
- a property value
String - Throws:
java.sql.SQLException- if an error occurs
-
isValid
public boolean isValid(int timeout) throws java.sql.SQLExceptionChecks 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:
isValidin interfacejava.sql.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:
java.sql.SQLException- if the call on the physical connection throws an exception.
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> interfaces) throws java.sql.SQLException- Specified by:
isWrapperForin interfacejava.sql.Wrapper- Throws:
java.sql.SQLException
-
setClientInfo
public void setClientInfo(java.util.Properties properties) throws java.sql.SQLClientInfoExceptionsetClientInfoforwards tophysicalConnection_.- Specified by:
setClientInfoin interfacejava.sql.Connection- Parameters:
properties- aPropertiesobject with the properties to set- Throws:
java.sql.SQLClientInfoException- if an error occurs
-
setClientInfo
public void setClientInfo(java.lang.String name, java.lang.String value) throws java.sql.SQLClientInfoExceptionsetClientInfoforwards tophysicalConnection_.- Specified by:
setClientInfoin interfacejava.sql.Connection- Parameters:
name- a property keyStringvalue- a property valueString- Throws:
java.sql.SQLClientInfoException- if an error occurs
-
unwrap
public <T> T unwrap(java.lang.Class<T> interfaces) throws java.sql.SQLException- Specified by:
unwrapin interfacejava.sql.Wrapper- Throws:
java.sql.SQLException
-
getSchema
public java.lang.String getSchema() throws java.sql.SQLExceptionGet the name of the current schema.- Specified by:
getSchemain interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setSchema
public void setSchema(java.lang.String schemaName) throws java.sql.SQLExceptionSet the default schema for the Connection.- Specified by:
setSchemain interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
abort
public void abort(java.util.concurrent.Executor executor) throws java.sql.SQLException- Specified by:
abortin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
getNetworkTimeout
public int getNetworkTimeout() throws java.sql.SQLException- Specified by:
getNetworkTimeoutin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
setNetworkTimeout
public void setNetworkTimeout(java.util.concurrent.Executor executor, int milliseconds) throws java.sql.SQLException- Specified by:
setNetworkTimeoutin interfacejava.sql.Connection- Throws:
java.sql.SQLException
-
-