bitronix.tm.resource.common

Class AbstractXAResourceHolder<T extends XAResourceHolder<T>>

java.lang.Object

bitronix.tm.resource.common.AbstractXAStatefulHolder<T>

bitronix.tm.resource.common.AbstractXAResourceHolder<T>

All Implemented Interfaces:

XAResourceHolder<T>, XAStatefulHolder<T>

Direct Known Subclasses:

DualSessionWrapper, EhCacheXAResourceHolder, JdbcPooledConnection, RecoveryXAResourceHolder

public abstract class AbstractXAResourceHolder<T extends XAResourceHolder<T>>
extends AbstractXAStatefulHolder<T>
implements XAResourceHolder<T>

Implementation of all services required by a XAResourceHolder. This class keeps a list of all XAResourceHolderStates of the XAResourceHolder plus the currently active one. There is one per transaction in which this XAResourceHolder is enlisted plus all the suspended transactions in which it is enlisted as well.

Author:

Ludovic Orban

Nested Class Summary

Nested classes/interfaces inherited from interface bitronix.tm.resource.common.XAStatefulHolder

XAStatefulHolder.State

Constructor Summary

Constructors

Constructor and Description
AbstractXAResourceHolder()

Method Summary

Modifier and Type	Method and Description
void	acceptVisitorForXAResourceHolderStates(Uid gtrid, XAResourceHolderStateVisitor visitor) This method implements a standard Visitor Pattern.
int	getXAResourceHolderStateCountForGtrid(Uid gtrid) Get a count of XAResourceHolderStates for the specified GTRID.
Set<String>	getXAResourceHolderStateGtrids() Simple helper method which returns a set of GTRIDs of transactions in which this resource is enlisted.
protected Map<Uid,XAResourceHolderState>	getXAResourceHolderStatesForGtrid(Uid gtrid)
boolean	hasStateForXAResource(XAResourceHolder<? extends XAResourceHolder> xaResourceHolder) Check if this XAResourceHolder contains a state for a specific XAResourceHolder.
boolean	isExistXAResourceHolderStatesForGtrid(Uid gtrid) Checks whether there are XAResourceHolderStates for the specified GTRID.
boolean	isParticipatingInActiveGlobalTransaction() If this method returns false, then local transaction calls like Connection.commit() can be made.
void	putXAResourceHolderState(BitronixXid xid, XAResourceHolderState xaResourceHolderState) Add a XAResourceHolderState of this wrapped resource.
void	removeXAResourceHolderState(BitronixXid xid) Remove all states related to a specific Xid from this wrapped resource.

Methods inherited from class bitronix.tm.resource.common.AbstractXAStatefulHolder

addStateChangeEventListener, getCreationDate, getState, removeStateChangeEventListener, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface bitronix.tm.resource.common.XAResourceHolder

getResourceBean, getXAResource

Methods inherited from interface bitronix.tm.resource.common.XAStatefulHolder

addStateChangeEventListener, close, getConnectionHandle, getCreationDate, getLastReleaseDate, getState, getXAResourceHolders, removeStateChangeEventListener, setState

Constructor Detail

AbstractXAResourceHolder

public AbstractXAResourceHolder()

Method Detail

getXAResourceHolderStatesForGtrid

protected Map<Uid,XAResourceHolderState> getXAResourceHolderStatesForGtrid(Uid gtrid)

isExistXAResourceHolderStatesForGtrid

public boolean isExistXAResourceHolderStatesForGtrid(Uid gtrid)

Description copied from interface: XAResourceHolder

Checks whether there are XAResourceHolderStates for the specified GTRID.

Specified by:

isExistXAResourceHolderStatesForGtrid in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

gtrid - the GTRID of the transaction state to check existence for

Returns:

true if there are XAResourceHolderStates, false otherwise

getXAResourceHolderStateCountForGtrid

public int getXAResourceHolderStateCountForGtrid(Uid gtrid)

Description copied from interface: XAResourceHolder

Get a count of XAResourceHolderStates for the specified GTRID.

Specified by:

getXAResourceHolderStateCountForGtrid in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

gtrid - the GTRID to get a XAResourceHolderState count for

Returns:

the count of XAResourceHolderStates, or 0 if there are no states for the specified GTRID

acceptVisitorForXAResourceHolderStates

public void acceptVisitorForXAResourceHolderStates(Uid gtrid,
                                                   XAResourceHolderStateVisitor visitor)

Description copied from interface: XAResourceHolder

This method implements a standard Visitor Pattern. For the specified GTRID, the provided XAResourceHolderStateVisitor's visit() method is called for each matching XAResourceHolderState in the order they were added. This method was introduced as a replacement for the old getXAResourceHolderStatesForGtrid(Uid) method. The old getXAResourceHolderStatesForGtrid method exported an internal collection which was unsynchronized yet was iterated over by the callers. Using the Visitor Pattern allows us to perform the same iteration within the context of a lock, and avoids exposing internal state and implementation details to callers.

Specified by:

acceptVisitorForXAResourceHolderStates in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

gtrid - the GTRID of the transaction state to visit XAResourceHolderStates for

visitor - a XAResourceHolderStateVisitor instance

putXAResourceHolderState

public void putXAResourceHolderState(BitronixXid xid,
                                     XAResourceHolderState xaResourceHolderState)

Description copied from interface: XAResourceHolder

Add a XAResourceHolderState of this wrapped resource.

Specified by:

putXAResourceHolderState in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

xid - the Xid of the transaction state to add.

xaResourceHolderState - the XAResourceHolderState to set.

removeXAResourceHolderState

public void removeXAResourceHolderState(BitronixXid xid)

Description copied from interface: XAResourceHolder

Remove all states related to a specific Xid from this wrapped resource.

Specified by:

removeXAResourceHolderState in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

xid - the Xid of the transaction state to remove.

hasStateForXAResource

public boolean hasStateForXAResource(XAResourceHolder<? extends XAResourceHolder> xaResourceHolder)

Description copied from interface: XAResourceHolder

Check if this XAResourceHolder contains a state for a specific XAResourceHolder. In other words: has the XAResourceHolder's XAResource been enlisted in some transaction ?

Specified by:

hasStateForXAResource in interface XAResourceHolder<T extends XAResourceHolder<T>>

Parameters:

xaResourceHolder - the XAResourceHolder to look for.

Returns:

true if the XAResourceHolder is enlisted in some transaction, false otherwise.

isParticipatingInActiveGlobalTransaction

public boolean isParticipatingInActiveGlobalTransaction()

If this method returns false, then local transaction calls like Connection.commit() can be made.

Returns:

true if start() has been successfully called but not end() yet and the transaction is not suspended.

getXAResourceHolderStateGtrids

public Set<String> getXAResourceHolderStateGtrids()

Simple helper method which returns a set of GTRIDs of transactions in which this resource is enlisted. Useful for monitoring.

Returns:

a set of String-encoded GTRIDs of transactions in which this resource is enlisted.