org.apache.avalon.excalibur.datasource

Class AbstractJdbcConnection

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.avalon.excalibur.datasource.AbstractJdbcConnection

All Implemented Interfaces:

java.lang.reflect.InvocationHandler, PoolSettable, ProxiedJdbcConnection, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.LogEnabled

Direct Known Subclasses:

Jdbc3Connection, JdbcConnection

public class AbstractJdbcConnection
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements PoolSettable, org.apache.avalon.framework.activity.Disposable, ProxiedJdbcConnection

The Connection object used in conjunction with the JdbcDataSource object.

Since:

4.1

Version:

CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:14 $

Author:

Avalon Development Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractJdbcConnection.ProxiedObject

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List	m_allocatedStatements Contains Statements created on the original jdbc connection between a JdbcDataSource.getConnection() and Connection.close().
protected java.sql.Connection	m_connection
protected boolean	m_encounteredError Flag to keep track of whether or not an error has been thrown since the last time the DB was pinged.
protected long	m_lastUsed
private static java.util.Map	m_methods
protected org.apache.avalon.excalibur.pool.Pool	m_pool
private java.lang.Object	m_proxy
protected int	m_testAge The maximum time since a connection was last used before it will be pinged.
protected java.sql.SQLException	m_testException
protected java.sql.PreparedStatement	m_testStatement

Constructor Summary

Constructors

Constructor and Description
AbstractJdbcConnection(java.sql.Connection connection, boolean oradb) Deprecated. Use the version with keepAlive specified
AbstractJdbcConnection(java.sql.Connection connection, java.lang.String keepAlive)
AbstractJdbcConnection(java.sql.Connection connection, java.lang.String keepAlive, int keepAliveAge)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearAllocatedStatements() Closes statements that were registered and removes all statements from the list of allocated ones.
void	close()
void	dispose()
void	enableLogging(org.apache.avalon.framework.logger.Logger log)
boolean	equals(java.lang.Object obj)
java.sql.Connection	getConnection()
void	initialize()
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
boolean	isClosed()
void	recycle()
protected void	registerAllocatedStatement(java.sql.Statement stmt) Adds the statement to the list of this connection.
void	setPool(org.apache.avalon.excalibur.pool.Pool pool) Set the pool that will be used to recycle.
void	setProxiedConnection(java.lang.Object proxy)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

m_connection

protected java.sql.Connection m_connection

m_proxy

private java.lang.Object m_proxy

m_pool

protected org.apache.avalon.excalibur.pool.Pool m_pool

m_encounteredError

protected boolean m_encounteredError

Flag to keep track of whether or not an error has been thrown since the last time the DB was pinged.

m_testAge

protected int m_testAge

The maximum time since a connection was last used before it will be pinged.

m_testStatement

protected java.sql.PreparedStatement m_testStatement

m_testException

protected java.sql.SQLException m_testException

m_lastUsed

protected long m_lastUsed

m_methods

private static final java.util.Map m_methods

m_allocatedStatements

private final java.util.List m_allocatedStatements

Contains Statements created on the original jdbc connection between a JdbcDataSource.getConnection() and Connection.close(). The statements are registered using registerAllocatedStatement(java.sql.Statement) and deallocated in close(). LinkedList was chosen because access to elements is sequential through Iterator and the number of elements is not known in advance. Synchronization is done on the Link instance itself.

Constructor Detail

AbstractJdbcConnection

public AbstractJdbcConnection(java.sql.Connection connection,
                      boolean oradb)

Deprecated. Use the version with keepAlive specified

AbstractJdbcConnection

public AbstractJdbcConnection(java.sql.Connection connection,
                      java.lang.String keepAlive)

Parameters:

connection - a driver specific JDBC connection to be wrapped.

keepAlive - a query which will be used to check the statis of the connection after it has been idle. A null value will cause the keep alive feature to be disabled.

AbstractJdbcConnection

public AbstractJdbcConnection(java.sql.Connection connection,
                      java.lang.String keepAlive,
                      int keepAliveAge)

Parameters:

connection - a driver specific JDBC connection to be wrapped.

keepAlive - a query which will be used to check the status of the connection after it has been idle. A null value will cause the keep alive feature to be disabled.

keepAliveAge - the maximum age in milliseconds since a connection was last used before it must be pinged using the keepAlive query. Ignored if keepAlive is null.

Method Detail

initialize

public void initialize()

enableLogging

public void enableLogging(org.apache.avalon.framework.logger.Logger log)

Specified by:

enableLogging in interface org.apache.avalon.framework.logger.LogEnabled

Overrides:

enableLogging in class org.apache.avalon.framework.logger.AbstractLogEnabled

setPool

public void setPool(org.apache.avalon.excalibur.pool.Pool pool)

Description copied from interface: PoolSettable

Set the pool that will be used to recycle.

Specified by:

setPool in interface PoolSettable

recycle

public void recycle()

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

setProxiedConnection

public void setProxiedConnection(java.lang.Object proxy)

Specified by:

setProxiedConnection in interface ProxiedJdbcConnection

getConnection

public java.sql.Connection getConnection()

Specified by:

getConnection in interface ProxiedJdbcConnection

isClosed

public boolean isClosed()
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

close

public void close()
           throws java.sql.SQLException

Throws:

java.sql.SQLException

clearAllocatedStatements

protected void clearAllocatedStatements()
                                 throws java.sql.SQLException

Closes statements that were registered and removes all statements from the list of allocated ones. If any statement fails to properly close, the rest of the statements is ignored. But the registration list if cleared in any case.

Holds m_allocatedStatements locked the whole time. This should not be a problem because connections are inherently single threaded objects and any attempt to use them from a different thread while it is being closed is a violation of the contract.

Throws:

java.sql.SQLException - of the first Statement.close()

registerAllocatedStatement

protected void registerAllocatedStatement(java.sql.Statement stmt)

Adds the statement to the list of this connection. Used by subclasses to ensure release of statements when connection is logically terminated and returned to the pool.

dispose

public void dispose()

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

invoke

public java.lang.Object invoke(java.lang.Object proxy,
                      java.lang.reflect.Method method,
                      java.lang.Object[] args)
                        throws java.lang.Throwable

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

java.lang.Throwable