bitronix.tm.resource.common

Class XAPool<R extends XAResourceHolder<R>,T extends XAStatefulHolder<T>>

java.lang.Object

bitronix.tm.resource.common.XAPool<R,T>

All Implemented Interfaces:

StateChangeListener<T>

public class XAPool<R extends XAResourceHolder<R>,T extends XAStatefulHolder<T>>
extends Object
implements StateChangeListener<T>

Generic XA pool. XAStatefulHolder instances are created by the XAPool out of a XAResourceProducer. Those objects are then pooled and can be retrieved and/or recycled by the pool depending on the running XA transaction's and the XAStatefulHolder's states.

Author:

Ludovic Orban, Brett Wooldridge

Constructor Summary

Constructors

Constructor and Description
XAPool(XAResourceProducer<R,T> xaResourceProducer, ResourceBean bean, Object xaFactory)

Method Summary

Modifier and Type	Method and Description
void	close() Close down and cleanup this XAPool instance.
Object	getConnectionHandle() Get a connection handle from this pool.
Object	getConnectionHandle(boolean recycle) Get a connection handle from this pool.
Date	getNextShrinkDate()
Object	getXAFactory() Get the XAFactory (XADataSource) that produces objects for this pool.
List<T>	getXAResourceHolders()
int	inPoolSize() Get the number of objects in the available pool.
boolean	isFailed() Is the XAPool in a failed state?
void	reset()
void	setFailed(boolean failed) Sets this XAPool as failed or unfailed, requiring recovery.
void	shrink()
void	stateChanged(T source, XAStatefulHolder.State oldState, XAStatefulHolder.State newState) Fired when the internal state of a XAStatefulHolder has changed.
void	stateChanging(T source, XAStatefulHolder.State currentState, XAStatefulHolder.State futureState) Fired before the internal state of a XAStatefulHolder has changed.
String	toString()
int	totalPoolSize() Get the total size of this pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

XAPool

public XAPool(XAResourceProducer<R,T> xaResourceProducer,
              ResourceBean bean,
              Object xaFactory)
       throws Exception

Throws:

Exception

Method Detail

close

public void close()

Close down and cleanup this XAPool instance.

getConnectionHandle

public Object getConnectionHandle()
                           throws Exception

Get a connection handle from this pool.

Returns:

a connection handle

Throws:

Exception - throw in the pool is unrecoverable or a timeout occurs getting a connection

getConnectionHandle

public Object getConnectionHandle(boolean recycle)
                           throws Exception

Get a connection handle from this pool.

Parameters:

recycle - true if we should try to get a connection in the NON_ACCESSIBLE pool in the same transaction

Returns:

a connection handle

Throws:

Exception - throw in the pool is unrecoverable or a timeout occurs getting a connection

stateChanging

public void stateChanging(T source,
                          XAStatefulHolder.State currentState,
                          XAStatefulHolder.State futureState)

Description copied from interface: StateChangeListener

Fired before the internal state of a XAStatefulHolder has changed.

Specified by:

stateChanging in interface StateChangeListener<T extends XAStatefulHolder<T>>

Parameters:

source - the XAStatefulHolder changing state.

currentState - the current state of the XAStatefulHolder.

futureState - the future state of the XAStatefulHolder.

stateChanged

public void stateChanged(T source,
                         XAStatefulHolder.State oldState,
                         XAStatefulHolder.State newState)

Description copied from interface: StateChangeListener

Fired when the internal state of a XAStatefulHolder has changed.

Specified by:

stateChanged in interface StateChangeListener<T extends XAStatefulHolder<T>>

Parameters:

source - the XAStatefulHolder changing state.

oldState - the old state of the XAStatefulHolder.

newState - the new state of the XAStatefulHolder.

getNextShrinkDate

public Date getNextShrinkDate()

shrink

public void shrink()
            throws Exception

Throws:

Exception

reset

public void reset()
           throws Exception

Throws:

Exception

getXAFactory

public Object getXAFactory()

Get the XAFactory (XADataSource) that produces objects for this pool.

Returns:

the factory (XADataSource) object

setFailed

public void setFailed(boolean failed)

Sets this XAPool as failed or unfailed, requiring recovery.

Parameters:

failed - true if this XAPool has failed and requires recovery, false if it is ok

isFailed

public boolean isFailed()

Is the XAPool in a failed state?

Returns:

true if this XAPool has failed, false otherwise

totalPoolSize

public int totalPoolSize()

Get the total size of this pool.

Returns:

the total size of this pool

inPoolSize

public int inPoolSize()

Get the number of objects in the available pool.

Returns:

the number of available objects

getXAResourceHolders

public List<T> getXAResourceHolders()

toString

public String toString()

Overrides:

toString in class Object