com.atomikos.datasource.pool

Class ConnectionPool<ConnectionType>

java.lang.Object

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

All Implemented Interfaces:

XPooledConnectionEventListener<ConnectionType>

Direct Known Subclasses:

ConnectionPoolWithConcurrentValidation, ConnectionPoolWithSynchronizedValidation

public abstract class ConnectionPool<ConnectionType>
extends Object
implements XPooledConnectionEventListener<ConnectionType>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<XPooledConnection<ConnectionType>>	connections

Constructor Summary

Constructors

Constructor and Description
ConnectionPool(ConnectionFactory<ConnectionType> connectionFactory, ConnectionPoolProperties properties)

Method Summary

Modifier and Type	Method and Description
int	availableSize() The amount of pooled connections in state available.
ConnectionType	borrowConnection() Borrows a connection from the pool.
void	destroy()
protected void	destroyPooledConnection(XPooledConnection<ConnectionType> xpc)
protected void	logCurrentPoolSize()
void	onXPooledConnectionTerminated(XPooledConnection<ConnectionType> connection) fired when a connection changed its state to terminated
protected abstract ConnectionType	recycleConnectionIfPossible()
void	refresh()
protected abstract ConnectionType	retrieveFirstAvailableConnection()
String	toString()
int	totalSize() The total amount of pooled connections in any state.

Methods inherited from class java.lang.Object

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

Field Detail

connections

protected List<XPooledConnection<ConnectionType>> connections

Constructor Detail

ConnectionPool

public ConnectionPool(ConnectionFactory<ConnectionType> connectionFactory,
                      ConnectionPoolProperties properties)
               throws ConnectionPoolException

Throws:

ConnectionPoolException

Method Detail

recycleConnectionIfPossible

protected abstract ConnectionType recycleConnectionIfPossible()
                                                       throws Exception

Throws:

Exception

borrowConnection

public ConnectionType borrowConnection()
                                throws CreateConnectionException,
                                       PoolExhaustedException,
                                       ConnectionPoolException

Borrows a connection from the pool.

Returns:

The connection

Throws:

CreateConnectionException - If the pool attempted to grow but failed.

PoolExhaustedException - If the pool could not grow because it is exhausted.

ConnectionPoolException - Other errors.

logCurrentPoolSize

protected void logCurrentPoolSize()

retrieveFirstAvailableConnection

protected abstract ConnectionType retrieveFirstAvailableConnection()

destroyPooledConnection

protected void destroyPooledConnection(XPooledConnection<ConnectionType> xpc)

destroy

public void destroy()

refresh

public void refresh()

availableSize

public int availableSize()

The amount of pooled connections in state available.

Returns:

the amount of pooled connections in state available.

totalSize

public int totalSize()

The total amount of pooled connections in any state.

Returns:

the total amount of pooled connections in any state

onXPooledConnectionTerminated

public void onXPooledConnectionTerminated(XPooledConnection<ConnectionType> connection)

Description copied from interface: XPooledConnectionEventListener

fired when a connection changed its state to terminated

Specified by:

onXPooledConnectionTerminated in interface XPooledConnectionEventListener<ConnectionType>

toString

public String toString()

Overrides:

toString in class Object