Package org.apache.derby.client
Class ClientPooledConnection
java.lang.Object
org.apache.derby.client.ClientPooledConnection
- All Implemented Interfaces:
PooledConnection
- Direct Known Subclasses:
ClientXAConnection
A physical connection to a data source, to be used for creating logical
connections to the same data source.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
The number of iterators going through the list of connection event listeners at the current time.private ArrayList
<ConnectionEventListener> List ofConnectionEventListener
s.private LogicalConnection
The logical connection using the physical connection.protected LogWriter
(package private) NetXAConnection
private boolean
Tells if this pooled connection is newly created.(package private) ClientConnection
protected int
Resource manager identifier.private final JDBCStatementCache
The statement cache for the underlying physical connection.private final CopyOnWriteArrayList
<StatementEventListener> List of statement event listeners. -
Constructor Summary
ConstructorsConstructorDescriptionClientPooledConnection
(BasicClientDataSource40 ds, LogWriter logWriter, String user, String password) Constructor for non-XA pooled connections.ClientPooledConnection
(BasicClientDataSource40 ds, LogWriter logWriter, String user, String password, int rmId) Constructor for XA pooled connections only. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Registers a StatementEventListener with this PooledConnection object.void
close()
Closes the physical connection to the data source and frees all associated resources.private void
Creates a new logical connection by performing all the required steps to be able to reuse the physical connection.protected void
finalize()
private void
fireConnectionEventListeners
(SqlException exception) Fire all theConnectionEventListener
s registered.Creates a logical connection.void
informListeners
(SqlException exception) Inform listeners that an error has occured on the connection, if the error severity is high enough.boolean
Tells is statement pooling is enabled or not.void
Used byLogicalConnection.close
in some circumstances when it disassociates itself from the pooled connection.void
onStatementClose
(PreparedStatement statement) Raise the statementClosed event for all the listeners when the corresponding events occurs.void
onStatementErrorOccurred
(PreparedStatement statement, SQLException sqle) Raise the statementErrorOccurred event for all the listeners when the corresponding events occurs.void
Inform listeners that the logical connection has been closed and that the physical connection is ready for reuse.void
void
Removes the specified previously registered listener object from the list of components that would be informed of events with a PreparedStatement object.
-
Field Details
-
newPC_
private boolean newPC_Tells if this pooled connection is newly created. -
listeners_
List ofConnectionEventListener
s. Nevernull
. -
eventIterators
private int eventIteratorsThe number of iterators going through the list of connection event listeners at the current time. Only one thread may be iterating over the list at any time (because of synchronization), but a single thread may have multiple iterators if for instance an event listener performs database calls that trigger a new event. -
physicalConnection_
ClientConnection physicalConnection_ -
netXAPhysicalConnection_
NetXAConnection netXAPhysicalConnection_ -
statementCache
The statement cache for the underlying physical connection.This will be
null
if statement caching is disabled (default). -
logicalConnection_
The logical connection using the physical connection. -
logWriter_
-
rmId_
protected int rmId_Resource manager identifier. -
statementEventListeners
List of statement event listeners. The list is copied on each write, ensuring that it can be safely iterated over even if other threads or the listeners fired in the same thread add or remove listeners.
-
-
Constructor Details
-
ClientPooledConnection
public ClientPooledConnection(BasicClientDataSource40 ds, LogWriter logWriter, String user, String password) throws SQLException Constructor for non-XA pooled connections.Using standard Java APIs, a CPDS is passed in. Arguments for user/password overrides anything on the data source.
- Parameters:
ds
- data source creating this pooled connectionlogWriter
- destination for log messagesuser
- user namepassword
- user password- Throws:
SQLException
- if creating the pooled connection fails due problems in the database, or problems communicating with the database
-
ClientPooledConnection
public ClientPooledConnection(BasicClientDataSource40 ds, LogWriter logWriter, String user, String password, int rmId) throws SQLException Constructor for XA pooled connections only.Using standard Java APIs, a CPDS is passed in. Arguments for user/password overrides anything on the data source.
- Parameters:
ds
- data source creating this pooled connectionlogWriter
- destination for log messagesuser
- user namepassword
- user passwordrmId
- resource manager id- Throws:
SQLException
- if creating the pooled connection fails due problems in the database, or problems communicating with the database
-
-
Method Details
-
isStatementPoolingEnabled
public boolean isStatementPoolingEnabled()Tells is statement pooling is enabled or not.- Returns:
true
if enabled,false
if disabled.
-
finalize
-
close
Closes the physical connection to the data source and frees all associated resources.- Specified by:
close
in interfacePooledConnection
- Throws:
SQLException
- if closing the connection causes an error. Note that this connection can still be considered closed even if an error occurs.
-
getConnection
Creates a logical connection.This is the standard API for getting a logical connection handle for a pooled connection. No "resettable" properties are passed, so user, password, and all other properties may not change.
- Specified by:
getConnection
in interfacePooledConnection
- Throws:
SQLException
- if creating a new logical connection fails
-
createLogicalConnection
Creates a new logical connection by performing all the required steps to be able to reuse the physical connection.- Throws:
SqlException
- if there is no physical connection, or if any error occurs when recycling the physical connection or closing/craeting the logical connection
-
addConnectionEventListener
- Specified by:
addConnectionEventListener
in interfacePooledConnection
-
removeConnectionEventListener
- Specified by:
removeConnectionEventListener
in interfacePooledConnection
-
recycleConnection
public void recycleConnection()Inform listeners that the logical connection has been closed and that the physical connection is ready for reuse.Not public, but needs to be visible to am.LogicalConnection
-
informListeners
Inform listeners that an error has occured on the connection, if the error severity is high enough.Not public, but needs to be visible to am.LogicalConnection
- Parameters:
exception
- the exception that occurred on the connection
-
fireConnectionEventListeners
Fire all theConnectionEventListener
s registered. Callers must synchronize onthis
to prevent others from modifying the list of listeners.- Parameters:
exception
- the exception that caused the event, ornull
if it is a close event
-
nullLogicalConnection
public void nullLogicalConnection()Used byLogicalConnection.close
in some circumstances when it disassociates itself from the pooled connection. -
addStatementEventListener
Registers a StatementEventListener with this PooledConnection object. Components that wish to be informed of events associated with the PreparedStatement object created by this PooledConnection like the close or error occurred event can register a StatementEventListener with this PooledConnection object.- Specified by:
addStatementEventListener
in interfacePooledConnection
- Parameters:
listener
- A component that implements the StatementEventListener interface and wants to be notified of Statement closed or or Statement error occurred events
-
removeStatementEventListener
Removes the specified previously registered listener object from the list of components that would be informed of events with a PreparedStatement object.- Specified by:
removeStatementEventListener
in interfacePooledConnection
- Parameters:
listener
- The previously registered event listener that needs to be removed from the list of components
-
onStatementClose
Raise the statementClosed event for all the listeners when the corresponding events occurs.- Parameters:
statement
- The PreparedStatement that was closed
-
onStatementErrorOccurred
Raise the statementErrorOccurred event for all the listeners when the corresponding events occurs.- Parameters:
statement
- The PreparedStatement on which error occurredsqle
- The SQLException associated with the error that caused the invalidation of the PreparedStatements
-