bitronix.tm.resource.common

Interface XAResourceHolder<T extends XAResourceHolder<T>>

All Superinterfaces:

XAStatefulHolder<T>

All Known Implementing Classes:

AbstractXAResourceHolder, DualSessionWrapper, EhCacheXAResourceHolder, JdbcPooledConnection, RecoveryXAResourceHolder

public interface XAResourceHolder<T extends XAResourceHolder<T>>
extends XAStatefulHolder<T>

XAResource wrappers must implement this interface. It defines a way to get access to the transactional state of this XAResourceHolder.

Author:

Ludovic Orban

See Also:

XAResourceHolderState

Nested Class Summary

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

XAStatefulHolder.State

Method Summary

Modifier and Type	Method and Description
void	acceptVisitorForXAResourceHolderStates(Uid gtrid, XAResourceHolderStateVisitor visitor) This method implements a standard Visitor Pattern.
ResourceBean	getResourceBean() Get the ResourceBean which created this XAResourceHolder.
XAResource	getXAResource() Get the vendor's XAResource implementation of the wrapped resource.
int	getXAResourceHolderStateCountForGtrid(Uid gtrid) Get a count of XAResourceHolderStates for the specified 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.
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 interface bitronix.tm.resource.common.XAStatefulHolder

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

Method Detail

getXAResource

XAResource getXAResource()

Get the vendor's XAResource implementation of the wrapped resource.

Returns:

the vendor's XAResource implementation.

acceptVisitorForXAResourceHolderStates

void acceptVisitorForXAResourceHolderStates(Uid gtrid,
                                            XAResourceHolderStateVisitor visitor)

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.

Parameters:

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

visitor - a XAResourceHolderStateVisitor instance

isExistXAResourceHolderStatesForGtrid

boolean isExistXAResourceHolderStatesForGtrid(Uid gtrid)

Checks whether there are XAResourceHolderStates for the specified GTRID.

Parameters:

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

Returns:

true if there are XAResourceHolderStates, false otherwise

getXAResourceHolderStateCountForGtrid

int getXAResourceHolderStateCountForGtrid(Uid gtrid)

Get a count of XAResourceHolderStates for the specified GTRID.

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

putXAResourceHolderState

void putXAResourceHolderState(BitronixXid xid,
                              XAResourceHolderState xaResourceHolderState)

Add a XAResourceHolderState of this wrapped resource.

Parameters:

xid - the Xid of the transaction state to add.

xaResourceHolderState - the XAResourceHolderState to set.

removeXAResourceHolderState

void removeXAResourceHolderState(BitronixXid xid)

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

Parameters:

xid - the Xid of the transaction state to remove.

hasStateForXAResource

boolean hasStateForXAResource(XAResourceHolder<? extends XAResourceHolder> 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 ?

Parameters:

xaResourceHolder - the XAResourceHolder to look for.

Returns:

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

getResourceBean

ResourceBean getResourceBean()

Get the ResourceBean which created this XAResourceHolder.

Returns:

the ResourceBean which created this XAResourceHolder.