Package oracle.jdbc.pool

Interface OracleConnectionCache

All Superinterfaces:

CommonDataSource, DataSource, Wrapper

public interface OracleConnectionCache
extends DataSource

An OracleConnectionCache is an interface one needs to implement if they like to reuse OracleConnectionEventListener and implement their own version of Connection Caching.

By extending DataSource, we would like to leverage the DataSource features such as JNDI and the concept of factory for Connection objects.

Simplifies the design of Cache implementation by shielding the necessity to understand the complexities of JDBC 2.0 Connection pooling 'hooks'. Here are the few basic steps a ConnectionCache class should do to complete the loop:

1) Create a new OracleConnectionEventListener and register the connection Cache as it's argument.

Ex: m_ocel = new OracleConnectionEventListener (this);

2) Register this event listener with new PooledConnections.

Ex: pc.addConnectionEventListener(m_ocel);

3) Deregister the listener when closing the PooledConnection

Ex: pc.removeConnectionEventListener(m_ocel);

Method Summary

Modifier and Type	Method	Description
void	close()	Close the connection cache.
void	closePooledConnection(PooledConnection pc)	Invoked by the ConnectionEventListener when an error occurs on a PooledConnection/LogicalConnection signaling that it is no longer good to be used and can be closed.
void	reusePooledConnection(PooledConnection pc)	Invoked by the ConnectionEventListener instance when Logical connection handles are closed signaling that the PooledConnection can be recycled into the pool for further use.

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder, getParentLogger

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder, getConnection, getConnection, getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

reusePooledConnection

void reusePooledConnection(PooledConnection pc)
                    throws SQLException

Invoked by the ConnectionEventListener instance when Logical connection handles are closed signaling that the PooledConnection can be recycled into the pool for further use.

Parameters:

PooledConnection - The pooled connection object that needs to be recylced.

Throws:

SQLException - error in recycling the PooledConnection.

closePooledConnection

void closePooledConnection(PooledConnection pc)
                    throws SQLException

Invoked by the ConnectionEventListener when an error occurs on a PooledConnection/LogicalConnection signaling that it is no longer good to be used and can be closed.

Parameters:

PooledConnection - The pooled connection object that has to be closed because of an error.

Throws:

SQLException - error in closing the PooledConnection

close

void close()
    throws SQLException

Close the connection cache. All the pooled connections have to be closed.

Throws:

SQLException - if error occurs closing the cache.