org.jboss.jca.core.connectionmanager.pool

Class AbstractPool

java.lang.Object

org.jboss.jca.core.connectionmanager.pool.AbstractPool

All Implemented Interfaces:

Pool

Direct Known Subclasses:

AbstractPrefillPool, PoolByCri, PoolBySubjectAndCri, ReauthPool

public abstract class AbstractPool
extends java.lang.Object
implements Pool

Abstract pool implementation.

It can contains sub-pools according to the semantic of the pool. Concrete implementatins override getKey(Subject, ConnectionRequestInfo, boolean) method to create map key object.

Version:

$Rev: 112672 $

Author:

Gurkan Erdogdu

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreLogger	log The logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPool(javax.resource.spi.ManagedConnectionFactory mcf, PoolConfiguration pc, boolean noTxSeparatePools) Create a new base pool.

Method Summary

Methods

Modifier and Type	Method and Description
void	emptyManagedConnectionPool(ManagedConnectionPool pool) Remove the matching managed connection pool if the pool is empty
void	flush() Flush idle connections from the pool
void	flush(boolean kill) Flush the pool
ConnectionListener	getConnection(javax.transaction.Transaction trackByTransaction, javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cri) Get a connection
protected ConnectionListenerFactory	getConnectionListenerFactory() Get the connection listener factory
protected abstract java.lang.Object	getKey(javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cri, boolean separateNoTx) Retrieve the key for this request.
abstract CoreLogger	getLogger() Get the logger
javax.resource.spi.ManagedConnectionFactory	getManagedConnectionFactory() Retrieve the managed connection factory for this pool.
protected ManagedConnectionPool	getManagedConnectionPool(java.lang.Object key, javax.security.auth.Subject subject, javax.resource.spi.ConnectionRequestInfo cri) Determine the correct pool for this request, creates a new one when necessary.
java.lang.String	getName() Gets pool name.
PoolStatistics	getStatistics() Get the statistics
protected TransactionIntegration	getTransactionIntegration() Get any transaction integration associated with the pool.
protected javax.transaction.TransactionManager	getTransactionManager() Get any transaction manager associated with the pool.
protected javax.transaction.TransactionSynchronizationRegistry	getTransactionSynchronizationRegistry() Get any transaction synchronization registry associated with the pool.
protected boolean	internalTestConnection(javax.security.auth.Subject subject) Test if a connection can be obtained
void	returnConnection(ConnectionListener cl, boolean kill) Return a connection
void	setConnectionListenerFactory(ConnectionListenerFactory clf) Set the connection listener factory.
void	setName(java.lang.String poolName) Sets pool name.
void	shutdown() Shutdown the pool
abstract boolean	testConnection() Test if a connection can be obtained

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final CoreLogger log

The logger

Constructor Detail

AbstractPool

protected AbstractPool(javax.resource.spi.ManagedConnectionFactory mcf,
            PoolConfiguration pc,
            boolean noTxSeparatePools)

Create a new base pool.

Parameters:

mcf - the managed connection factory

pc - the pool configuration

noTxSeparatePools - noTxSeparatePool

Method Detail

setName

public void setName(java.lang.String poolName)

Sets pool name.

Parameters:

poolName - pool name

getName

public java.lang.String getName()

Gets pool name.

Specified by:

getName in interface Pool

Returns:

pool name

getKey

protected abstract java.lang.Object getKey(javax.security.auth.Subject subject,
                      javax.resource.spi.ConnectionRequestInfo cri,
                      boolean separateNoTx)
                                    throws javax.resource.ResourceException

Retrieve the key for this request.

Parameters:

subject - the subject

cri - the connection request information

separateNoTx - separateNoTx

Returns:

the key

Throws:

javax.resource.ResourceException - for any error

getManagedConnectionPool

protected ManagedConnectionPool getManagedConnectionPool(java.lang.Object key,
                                             javax.security.auth.Subject subject,
                                             javax.resource.spi.ConnectionRequestInfo cri)
                                                  throws javax.resource.ResourceException

Determine the correct pool for this request, creates a new one when necessary.

Parameters:

key - the key to the pool

subject - the subject of the pool

cri - the connection request info

Returns:

the subpool context

Throws:

javax.resource.ResourceException - for any error

getTransactionIntegration

protected TransactionIntegration getTransactionIntegration()

Get any transaction integration associated with the pool.

Returns:

the transaction integration

getTransactionManager

protected javax.transaction.TransactionManager getTransactionManager()

Get any transaction manager associated with the pool.

Returns:

the transaction manager

getTransactionSynchronizationRegistry

protected javax.transaction.TransactionSynchronizationRegistry getTransactionSynchronizationRegistry()

Get any transaction synchronization registry associated with the pool.

Returns:

The value

emptyManagedConnectionPool

public void emptyManagedConnectionPool(ManagedConnectionPool pool)

Remove the matching managed connection pool if the pool is empty

Parameters:

pool - The pool

flush

public void flush()

Flush idle connections from the pool

Specified by:

flush in interface Pool

flush

public void flush(boolean kill)

Flush the pool

Specified by:

flush in interface Pool

Parameters:

kill - Kill all connections

getConnection

public ConnectionListener getConnection(javax.transaction.Transaction trackByTransaction,
                               javax.security.auth.Subject subject,
                               javax.resource.spi.ConnectionRequestInfo cri)
                                 throws javax.resource.ResourceException

Get a connection

Parameters:

trackByTransaction - for transaction stickiness

subject - the subject for connection

cri - the connection request information

Returns:

a connection event listener wrapping the connection

Throws:

javax.resource.ResourceException - for any error

getManagedConnectionFactory

public javax.resource.spi.ManagedConnectionFactory getManagedConnectionFactory()

Retrieve the managed connection factory for this pool.

Returns:

the managed connection factory

returnConnection

public void returnConnection(ConnectionListener cl,
                    boolean kill)
                      throws javax.resource.ResourceException

Return a connection

Parameters:

cl - the connection event listener wrapping the connection

kill - whether to destroy the managed connection

Throws:

javax.resource.ResourceException - for any error

getConnectionListenerFactory

protected ConnectionListenerFactory getConnectionListenerFactory()

Get the connection listener factory

Returns:

The value

setConnectionListenerFactory

public void setConnectionListenerFactory(ConnectionListenerFactory clf)

Set the connection listener factory.

Parameters:

clf - the connection event listener factory

shutdown

public void shutdown()

Shutdown the pool

getStatistics

public PoolStatistics getStatistics()

Get the statistics

Specified by:

getStatistics in interface Pool

Returns:

The value

testConnection

public abstract boolean testConnection()

Test if a connection can be obtained

Specified by:

testConnection in interface Pool

Returns:

True if it was poosible to get a connection; otherwise false

internalTestConnection

protected boolean internalTestConnection(javax.security.auth.Subject subject)

Test if a connection can be obtained

Parameters:

subject - Optional subject

Returns:

True if possible; otherwise false

getLogger

public abstract CoreLogger getLogger()

Get the logger

Returns:

The value