org.jboss.jbossts.txbridge.outbound

Class BridgeXAResource

java.lang.Object

org.jboss.jbossts.txbridge.outbound.BridgeXAResource

All Implemented Interfaces:

Serializable, XAResource

public class BridgeXAResource
extends Object
implements XAResource, Serializable

Provides method call mapping between JTA parent coordinator and WS-AT subordinate transaction.

Author:

jonathan.halliday@redhat.com, 2009-02-10

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
BridgeXAResource(com.arjuna.ats.arjuna.common.Uid externalTxId, BridgeWrapper bridgeWrapper) Create a new XAResource which wraps the subordinate WS-AT transaction.

Method Summary

Modifier and Type	Method and Description
static void	cleanupRecoveredXAResources() Release any BridgeXAResource instances that have been driven through to completion by their parent JTA transaction.
void	commit(Xid xid, boolean onePhase) Commits the global transaction specified by xid.
void	end(Xid xid, int flags) Ends the work performed on behalf of a transaction branch.
void	forget(Xid xid) Tells the resource manager to forget about a heuristic decision.
int	getTransactionTimeout() Obtains the current transaction timeout value set for this XAResource instance.
boolean	isAwaitingRecovery()
static boolean	isAwaitingRecovery(String bridgeWrapperId) Determine if the specified BridgeWrapper is awaiting recovery or not.
boolean	isSameRM(XAResource xaResource) Tells the caller if this resource has the same resource manager as the argument resource.
int	prepare(Xid xid) Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
Xid[]	recover(int flag) Obtains a list of prepared transaction branches from a resource manager.
void	rollback(Xid xid) Informs the resource manager to roll back work done on behalf of a transaction branch.
boolean	setTransactionTimeout(int seconds) Sets the current transaction timeout value for this XAResource instance.
void	start(Xid xid, int flags) Starts work on behalf of a transaction branch specified in xid.

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeXAResource

public BridgeXAResource(com.arjuna.ats.arjuna.common.Uid externalTxId,
                        BridgeWrapper bridgeWrapper)

Create a new XAResource which wraps the subordinate WS-AT transaction.

Parameters:

externalTxId - the parent JTA transaction identifier.

bridgeWrapper - the control for the subordinate WS-AT transaction.

Method Detail

prepare

public int prepare(Xid xid)
            throws XAException

Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Specified by:

prepare in interface XAResource

Parameters:

xid - A global transaction identifier

Returns:

A value indicating the resource manager's vote on the outcome of the transaction

Throws:

XAException

cleanupRecoveredXAResources

public static void cleanupRecoveredXAResources()

Release any BridgeXAResource instances that have been driven through to completion by their parent JTA transaction.

isAwaitingRecovery

public static boolean isAwaitingRecovery(String bridgeWrapperId)

Determine if the specified BridgeWrapper is awaiting recovery or not.

Parameters:

bridgeWrapperId - the Id to search for.

Returns:

true if the BridgeWrapper is known to be awaiting recovery, false otherwise.

rollback

public void rollback(Xid xid)
              throws XAException

Informs the resource manager to roll back work done on behalf of a transaction branch.

Specified by:

rollback in interface XAResource

Parameters:

xid - A global transaction identifier

Throws:

XAException

commit

public void commit(Xid xid,
                   boolean onePhase)
            throws XAException

Commits the global transaction specified by xid.

Specified by:

commit in interface XAResource

Parameters:

xid - A global transaction identifier

onePhase -

Throws:

XAException

start

public void start(Xid xid,
                  int flags)
           throws XAException

Starts work on behalf of a transaction branch specified in xid.

Specified by:

start in interface XAResource

Parameters:

xid - A global transaction identifier

flags -

Throws:

XAException

end

public void end(Xid xid,
                int flags)
         throws XAException

Ends the work performed on behalf of a transaction branch.

Specified by:

end in interface XAResource

Parameters:

xid - A global transaction identifier

flags -

Throws:

XAException

isSameRM

public boolean isSameRM(XAResource xaResource)
                 throws XAException

Description copied from interface: XAResource

Tells the caller if this resource has the same resource manager as the argument resource. The transaction manager needs this method to be able to decide if the start method should be given the XAResource.TMJOIN flag.

Specified by:

isSameRM in interface XAResource

Throws:

XAException - If an error occurred.

forget

public void forget(Xid xid)
            throws XAException

Description copied from interface: XAResource

Tells the resource manager to forget about a heuristic decision.

Specified by:

forget in interface XAResource

Parameters:

xid - The id of the transaction that was ended with a heuristic decision.

Throws:

XAException - If an error occurred.

recover

public Xid[] recover(int flag)
              throws XAException

Obtains a list of prepared transaction branches from a resource manager.

Specified by:

recover in interface XAResource

Parameters:

flag -

Returns:

the in doubt Xids

Throws:

XAException

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Sets the current transaction timeout value for this XAResource instance.

Specified by:

setTransactionTimeout in interface XAResource

Parameters:

seconds - - The transaction timeout value in seconds.

Returns:

true if the transaction timeout value is set successfully; otherwise false.

Throws:

XAException

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Obtains the current transaction timeout value set for this XAResource instance.

Specified by:

getTransactionTimeout in interface XAResource

Returns:

the transaction timeout value in seconds.

Throws:

XAException

isAwaitingRecovery

public boolean isAwaitingRecovery()