File	Doc	Category	Size	Date	Package
XATerminator.java	API Doc	Glassfish v2 API	6026	Fri May 04 22:35:36 BST 2007	javax.resource.spi

XATerminator

Fields Summary

Constructors Summary

Methods Summary
public void	commit(javax.transaction.xa.Xid xid, boolean onePhase) Commits the global transaction specified by xid. param xid A global transaction identifier param onePhase If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid. exception 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 resource 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 held resources.
public void	forget(javax.transaction.xa.Xid xid) Tells the resource manager to forget about a heuristically completed transaction branch. param xid A global transaction identifier. exception XAException An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
public int	prepare(javax.transaction.xa.Xid xid) Ask the resource manager to prepare for a transaction commit of the transaction specified in xid. param xid A global transaction identifier. exception XAException An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. return 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.
public javax.transaction.xa.Xid[]	recover(int flag) 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. param flag One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. These constants are defined in javax.transaction.xa.XAResource interface. exception XAException An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO. return 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.
public void	rollback(javax.transaction.xa.Xid xid) Informs the resource manager to roll back work done on behalf of a transaction branch. param xid A global transaction identifier. exception 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.