com.atomikos.datasource.pool

Class AbstractXPooledConnection<ConnectionType>

java.lang.Object

com.atomikos.datasource.pool.AbstractXPooledConnection<ConnectionType>

All Implemented Interfaces:

XPooledConnection<ConnectionType>

public abstract class AbstractXPooledConnection<ConnectionType>
extends Object
implements XPooledConnection<ConnectionType>

Abstract superclass with generic support for XPooledConnection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXPooledConnection(ConnectionPoolProperties props)

Method Summary

Modifier and Type	Method and Description
boolean	canBeRecycledForCallingThread() Can the connection be recycled (if not available) for the calling thread?
ConnectionType	createConnectionProxy() Create a disposable connection object that acts a controller for the pooled connection.
void	destroy() Destroy the pooled connection by closing the underlying physical connection.
protected abstract ConnectionType	doCreateConnectionProxy()
protected abstract void	doDestroy()
protected void	fireOnXPooledConnectionTerminated()
protected int	getBorrowConnectionTimeout()
long	getCreationTime() Get the moment when the connection was created.
protected ConnectionType	getCurrentConnectionProxy()
protected int	getDefaultIsolationLevel()
long	getLastTimeAcquired() Get the last time the connection was acquired.
long	getLastTimeReleased() Get the last time the connection was released, i.e.
protected String	getTestQuery()
boolean	markAsBeingAcquiredIfAvailable() Attempt to claim this connection for use.
protected boolean	maxLifetimeExceeded()
void	registerXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)
protected abstract void	testUnderlyingConnection()
void	unregisterXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)
protected void	updateLastTimeReleased()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atomikos.datasource.pool.XPooledConnection

isAvailable, isErroneous

Constructor Detail

AbstractXPooledConnection

protected AbstractXPooledConnection(ConnectionPoolProperties props)

Method Detail

getLastTimeAcquired

public long getLastTimeAcquired()

Description copied from interface: XPooledConnection

Get the last time the connection was acquired.

Specified by:

getLastTimeAcquired in interface XPooledConnection<ConnectionType>

Returns:

getLastTimeReleased

public long getLastTimeReleased()

Description copied from interface: XPooledConnection

Get the last time the connection was released, i.e. the last time when it has become available.

Specified by:

getLastTimeReleased in interface XPooledConnection<ConnectionType>

Returns:

createConnectionProxy

public ConnectionType createConnectionProxy()
                                     throws CreateConnectionException

Description copied from interface: XPooledConnection

Create a disposable connection object that acts a controller for the pooled connection. What exactly a connection object is depends on the implementation. Calling this method will also clear any flags set by markAsBeingAcquiredIfAvailable.

Specified by:

createConnectionProxy in interface XPooledConnection<ConnectionType>

Returns:

Throws:

CreateConnectionException

registerXPooledConnectionEventListener

public void registerXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)

Specified by:

registerXPooledConnectionEventListener in interface XPooledConnection<ConnectionType>

unregisterXPooledConnectionEventListener

public void unregisterXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)

Specified by:

unregisterXPooledConnectionEventListener in interface XPooledConnection<ConnectionType>

fireOnXPooledConnectionTerminated

protected void fireOnXPooledConnectionTerminated()

getTestQuery

protected String getTestQuery()

updateLastTimeReleased

protected void updateLastTimeReleased()

getCurrentConnectionProxy

protected ConnectionType getCurrentConnectionProxy()

canBeRecycledForCallingThread

public boolean canBeRecycledForCallingThread()

Description copied from interface: XPooledConnection

Can the connection be recycled (if not available) for the calling thread?

Specified by:

canBeRecycledForCallingThread in interface XPooledConnection<ConnectionType>

Returns:

getDefaultIsolationLevel

protected int getDefaultIsolationLevel()

getBorrowConnectionTimeout

protected int getBorrowConnectionTimeout()

getCreationTime

public long getCreationTime()

Description copied from interface: XPooledConnection

Get the moment when the connection was created.

Specified by:

getCreationTime in interface XPooledConnection<ConnectionType>

Returns:

markAsBeingAcquiredIfAvailable

public boolean markAsBeingAcquiredIfAvailable()

Description copied from interface: XPooledConnection

Attempt to claim this connection for use.

Specified by:

markAsBeingAcquiredIfAvailable in interface XPooledConnection<ConnectionType>

Returns:

True if the connection is available, and could be claimed for the caller of this method. In that case, it is up to the caller to call createConnectionProxy at a later time (which will in turn trigger a round-trip to the resource if there is any testQuery set) or the pool will be leaking.

doCreateConnectionProxy

protected abstract ConnectionType doCreateConnectionProxy()
                                                   throws CreateConnectionException

Throws:

CreateConnectionException

testUnderlyingConnection

protected abstract void testUnderlyingConnection()
                                          throws CreateConnectionException

Throws:

CreateConnectionException

maxLifetimeExceeded

protected boolean maxLifetimeExceeded()

destroy

public void destroy()

Description copied from interface: XPooledConnection

Destroy the pooled connection by closing the underlying physical connection.

Specified by:

destroy in interface XPooledConnection<ConnectionType>

doDestroy

protected abstract void doDestroy()