org.objectweb.jotm

Class XATerminatorImpl

Implemented Interfaces:
XATerminator

public class XATerminatorImpl
extends Object
implements XATerminator

Implementation of the object that represents an inflow transaction.

Constructor Summary

XATerminatorImpl()
Constructor for create

Method Summary

void
commit(Xid xid, boolean onePhase)
Commits the global transaction specified by xid.
void
forget(Xid xid)
Tells the resource manager to forget about a heuristically completed transaction branch.
String
get_transaction_name()
Gets a String that represents the inflow transaction name.
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.

Constructor Details

XATerminatorImpl

public XATerminatorImpl()
            throws XAException
Constructor for create

Method Details

commit

public void commit(Xid xid,
                   boolean onePhase)
            throws XAException
Commits the global transaction specified by xid.

Parameters:
xid - A global transaction identifier
onePhase - If true, the resource manager should use one-phase commit protocol to commit the work done on behalf of xid.


forget

public void forget(Xid xid)
            throws XAException
Tells the resource manager to forget about a heuristically completed transaction branch.

Parameters:
xid - A global transaction identifier.


get_transaction_name

public String get_transaction_name()
            throws XAException
Gets a String that represents the inflow transaction name.

Returns:
Transaction Name


prepare

public int prepare(Xid xid)
            throws XAException
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Parameters:
xid - A global transaction identifier.

Returns:
A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. These constants are defined in javax.transaction.xa.XAResource interface. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method.


recover

public Xid[] recover(int flag)
            throws XAException
Obtains a list of prepared transaction branches from a resource manager. The transaction manager calls this method during recovery to obtain the list of transaction branches that are currently in prepared or heuristically completed states.

Parameters:
flag - One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMHOFLAGS must be used when no other flags are set in the parameter. These constants are defined in javax.transaction.xa.XAResource interface.

Returns:
The resource manager returns zero or more XIDs of the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should throw the appropriate XAException.


rollback

public void rollback(Xid xid)
            throws XAException
Informs the resource manager to roll back work done on behalf of a transaction branch.

Parameters:
xid - A global transaction identifier.