org.objectweb.jotm
Class XATerminatorImpl

java.lang.Object
  org.objectweb.jotm.XATerminatorImpl

All 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

XATerminatorImpl

public XATerminatorImpl()
                 throws XAException

Constructor for create

Method Detail

get_transaction_name

public String get_transaction_name()
                            throws XAException

Gets a String that represents the inflow transaction name.

Returns:

Transaction Name

Throws:

XAException

commit

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

Commits the global transaction specified by xid.

Specified by:

commit in interface XATerminator

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.

Throws:

XAException - An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. If the resouce manager did not commit the transaction and the parameter onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all help resources.

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 XATerminator

Parameters:

xid - A global transaction identifier.

Throws:

XAException - An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. If the transaction branch is already marked rollback-only the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.

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 XATerminator

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.

Throws:

XAException - An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

forget

public void forget(Xid xid)
            throws XAException

Tells the resource manager to forget about a heuristically completed transaction branch.

Specified by:

forget in interface XATerminator

Parameters:

xid - A global transaction identifier.

Throws:

XAException - An error has occurred. Possible XAExceptions are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

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.

Specified by:

recover in interface XATerminator

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.

Throws:

XAException - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, or XAER_PROTO.