com.atomikos.datasource.pool

Interface XPooledConnection<ConnectionType>

All Known Implementing Classes:

AbstractXPooledConnection

public interface XPooledConnection<ConnectionType>

A pooling-capable object wrapping a physical connection to an underlying resource.

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(boolean reap) Destroy the pooled connection by closing the underlying physical connection.
long	getCreationTime() Get the moment when the connection was created.
long	getLastTimeAcquired() Get the last time the connection was acquired.
long	getLastTimeReleased() Get the last time the connection was released, i.e.
boolean	isAvailable() Is the connection available to be taken out of the pool ?
boolean	isErroneous() Is the pooled connection broken ?
boolean	markAsBeingAcquiredIfAvailable() Attempt to claim this connection for use.
void	registerXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)
void	unregisterXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)

Method Detail

isAvailable

boolean isAvailable()

Is the connection available to be taken out of the pool ?

Returns:

canBeRecycledForCallingThread

boolean canBeRecycledForCallingThread()

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

Returns:

destroy

void destroy(boolean reap)

Destroy the pooled connection by closing the underlying physical connection.

getLastTimeAcquired

long getLastTimeAcquired()

Get the last time the connection was acquired.

Returns:

getLastTimeReleased

long getLastTimeReleased()

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

Returns:

createConnectionProxy

ConnectionType createConnectionProxy()
                              throws CreateConnectionException

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.

Returns:

Throws:

CreateConnectionException

isErroneous

boolean isErroneous()

Is the pooled connection broken ?

Returns:

getCreationTime

long getCreationTime()

Get the moment when the connection was created.

Returns:

registerXPooledConnectionEventListener

void registerXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)

unregisterXPooledConnectionEventListener

void unregisterXPooledConnectionEventListener(XPooledConnectionEventListener<ConnectionType> listener)

markAsBeingAcquiredIfAvailable

boolean markAsBeingAcquiredIfAvailable()

Attempt to claim this connection for use.

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.