org.jboss.resource.connectionmanager
Class JBossManagedConnectionPool.BasePool

java.lang.Object
  org.jboss.resource.connectionmanager.JBossManagedConnectionPool.BasePool

All Implemented Interfaces:

ManagedConnectionPool, PreFillPoolSupport

Direct Known Subclasses:

JBossManagedConnectionPool.OnePool, JBossManagedConnectionPool.PoolByCri, JBossManagedConnectionPool.PoolBySubject, JBossManagedConnectionPool.PoolBySubjectAndCri

Enclosing class:

JBossManagedConnectionPool

public abstract static class JBossManagedConnectionPool.BasePool
extends Object
implements ManagedConnectionPool, PreFillPoolSupport

The base pool implementation

Field Summary

protected boolean	noTxSeparatePools Whether to use separate pools for transactional and non-transaction use
protected InternalManagedConnectionPool.PoolParams	poolParams The pool parameters

Constructor Summary

JBossManagedConnectionPool.BasePool(javax.resource.spi.ManagedConnectionFactory mcf, InternalManagedConnectionPool.PoolParams poolParams, boolean noTxSeparatePools, org.jboss.logging.Logger log)

JBossManagedConnectionPool.BasePool(javax.resource.spi.ManagedConnectionFactory mcf, String poolName, InternalManagedConnectionPool.PoolParams poolParams, boolean noTxSeparatePools, org.jboss.logging.Logger log)
Create a new base pool

Method Summary

void	flush() flush the pool
long	getAvailableConnectionCount()
ConnectionListener	getConnection(Transaction trackByTransaction, Subject subject, javax.resource.spi.ConnectionRequestInfo cri) Get a connection
int	getConnectionCount()
int	getConnectionCreatedCount()
int	getConnectionDestroyedCount()
int	getInUseConnectionCount() Return the inuse count
protected abstract Object	getKey(Subject subject, javax.resource.spi.ConnectionRequestInfo cri, boolean separateNoTx) Retrieve the key for this request
javax.resource.spi.ManagedConnectionFactory	getManagedConnectionFactory() Retrieve the managed connection factory for this pool
int	getMaxConnectionsInUseCount()
String	getPoolName()
boolean	getPreFill()
protected JBossManagedConnectionPool.SubPoolContext	getSubPool(Object key)
protected JBossManagedConnectionPool.SubPoolContext	getSubPool(Object key, Subject subject, javax.resource.spi.ConnectionRequestInfo cri) Determine the correct pool for this request, creates a new one when necessary
protected TransactionManager	getTransactionManager() Get any transaction manager associated with the pool
void	prefill() Prefill the connection pool
void	prefill(boolean noTxSeperatePool) Prefill the connection pool
void	prefill(Subject subject, javax.resource.spi.ConnectionRequestInfo cri, boolean noTxSeperatePool) Prefill the connection pool
void	returnConnection(ConnectionListener cl, boolean kill) Return a connection
void	setConnectionListenerFactory(ConnectionListenerFactory clf) Set the connection listener factory
boolean	shouldPreFill() Get the flag indicating whether or not to attempt to prefill this pool.
void	shutdown() shutdown the pool
protected void	shutdownWithoutClear() For testing

Methods inherited from class java.lang.Object

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

Field Detail

poolParams

protected final InternalManagedConnectionPool.PoolParams poolParams

The pool parameters

noTxSeparatePools

protected boolean noTxSeparatePools

Whether to use separate pools for transactional and non-transaction use

Constructor Detail

JBossManagedConnectionPool.BasePool

public JBossManagedConnectionPool.BasePool(javax.resource.spi.ManagedConnectionFactory mcf,
                                           InternalManagedConnectionPool.PoolParams poolParams,
                                           boolean noTxSeparatePools,
                                           org.jboss.logging.Logger log)

JBossManagedConnectionPool.BasePool

public JBossManagedConnectionPool.BasePool(javax.resource.spi.ManagedConnectionFactory mcf,
                                           String poolName,
                                           InternalManagedConnectionPool.PoolParams poolParams,
                                           boolean noTxSeparatePools,
                                           org.jboss.logging.Logger log)

Create a new base pool

Parameters:

mcf - the managed connection factory

poolParams - the pooling parameters

log - the log

Method Detail

getKey

protected abstract Object getKey(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

Returns:

the key

Throws:

javax.resource.ResourceException - for any error

getManagedConnectionFactory

public javax.resource.spi.ManagedConnectionFactory getManagedConnectionFactory()

Description copied from interface: ManagedConnectionPool

Retrieve the managed connection factory for this pool

Specified by:

getManagedConnectionFactory in interface ManagedConnectionPool

Returns:

the managed connection factory

setConnectionListenerFactory

public void setConnectionListenerFactory(ConnectionListenerFactory clf)

Description copied from interface: ManagedConnectionPool

Set the connection listener factory

Specified by:

setConnectionListenerFactory in interface ManagedConnectionPool

Parameters:

clf - the connection event listener factory

getConnection

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

Description copied from interface: ManagedConnectionPool

Get a connection

Specified by:

getConnection in interface ManagedConnectionPool

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

shouldPreFill

public boolean shouldPreFill()

Description copied from interface: PreFillPoolSupport

Get the flag indicating whether or not to attempt to prefill this pool.

Specified by:

shouldPreFill in interface PreFillPoolSupport

Returns:

true or false depending on whether or not to prefill this pool.

prefill

public void prefill()

Description copied from interface: PreFillPoolSupport

Prefill the connection pool

Specified by:

prefill in interface PreFillPoolSupport

prefill

public void prefill(boolean noTxSeperatePool)

Description copied from interface: PreFillPoolSupport

Prefill the connection pool

Specified by:

prefill in interface PreFillPoolSupport

Parameters:

noTxSeperatePool - whether or not we are seperating non transaction and transaction pools

prefill

public void prefill(Subject subject,
                    javax.resource.spi.ConnectionRequestInfo cri,
                    boolean noTxSeperatePool)

Description copied from interface: PreFillPoolSupport

Prefill the connection pool

Specified by:

prefill in interface PreFillPoolSupport

Parameters:

subject - the subject the subject

cri - the connection request info

noTxSeperatePool - whether or not we are seperating non transaction and transaction pools

returnConnection

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

Description copied from interface: ManagedConnectionPool

Return a connection

Specified by:

returnConnection in interface ManagedConnectionPool

Parameters:

cl - the connection event listener wrapping the connection

kill - whether to destroy the managed connection

Throws:

javax.resource.ResourceException - for any error

getInUseConnectionCount

public int getInUseConnectionCount()

Return the inuse count

Specified by:

getInUseConnectionCount in interface ManagedConnectionPool

Returns:

the count

getConnectionCount

public int getConnectionCount()

Specified by:

getConnectionCount in interface ManagedConnectionPool

Returns:

the connection count

getPoolName

public String getPoolName()

getPreFill

public boolean getPreFill()

getConnectionCreatedCount

public int getConnectionCreatedCount()

Specified by:

getConnectionCreatedCount in interface ManagedConnectionPool

Returns:

the connections created count

getConnectionDestroyedCount

public int getConnectionDestroyedCount()

Specified by:

getConnectionDestroyedCount in interface ManagedConnectionPool

Returns:

the connections destroyed count

getAvailableConnectionCount

public long getAvailableConnectionCount()

Specified by:

getAvailableConnectionCount in interface ManagedConnectionPool

Returns:

the available connections

getMaxConnectionsInUseCount

public int getMaxConnectionsInUseCount()

Specified by:

getMaxConnectionsInUseCount in interface ManagedConnectionPool

Returns:

the available connections

shutdown

public void shutdown()

Description copied from interface: ManagedConnectionPool

shutdown the pool

Specified by:

shutdown in interface ManagedConnectionPool

flush

public void flush()

Description copied from interface: ManagedConnectionPool

flush the pool

Specified by:

flush in interface ManagedConnectionPool

shutdownWithoutClear

protected void shutdownWithoutClear()

For testing

getTransactionManager

protected TransactionManager getTransactionManager()

Get any transaction manager associated with the pool

Returns:

the transaction manager

getSubPool

protected JBossManagedConnectionPool.SubPoolContext getSubPool(Object key,
                                                               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

getSubPool

protected JBossManagedConnectionPool.SubPoolContext getSubPool(Object key)