XAResource JDK 1.6)

Description

public interface XAResource

The XAResource interface is a Java mapping of the industry standard XA interface based on the X/Open CAE Specification (Distributed Transaction Processing: The XA Specification).

See also:

Methods

Hide/Show inherited methods

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

Commits the global transaction specified by xid.

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

Ends the work performed on behalf of a transaction branch.

Ends the work performed on behalf of a transaction branch. The resource manager disassociates the XA resource from the transaction branch specified and lets the transaction complete.

If TMSUSPEND is specified in the flags, the transaction branch is temporarily suspended in an incomplete state. The transaction context is in a suspended state and must be resumed via the start method with TMRESUME specified.

If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as rollback-only

If TMSUCCESS is specified, the portion of work has completed successfully.

Parameters:
- xid - A global transaction identifier that is the same as the identifier used previously in the start method.
- flags - One of TMSUCCESS, TMFAIL, or TMSUSPEND.
Throws:
- XAException - An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.

public void forget (Xid xid) throws XAException

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

public int getTransactionTimeout () throws XAException

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

Obtains the current transaction timeout value set for this
XAResource instance. If XAResource.setTransactionTimeout
was not used prior to invoking this method, the return value
is the default timeout set for the resource manager; otherwise,
the value used in the previous setTransactionTimeout
call is returned.
Returns: the transaction timeout value in seconds.
Throws:
- XAException - An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

public boolean isSameRM (XAResource xares) throws XAException

This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares.

public int prepare (Xid xid) throws XAException

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

public Xid recover (int flag) throws XAException

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

public void rollback (Xid xid) throws XAException

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

public boolean setTransactionTimeout (int seconds) throws XAException

Sets the current transaction timeout value for this XAResource instance.

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

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

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

If TMJOIN is specified, the start applies to joining a transaction
previously seen by the resource manager. If TMRESUME is specified,
the start applies to resuming a suspended transaction specified in the
parameter xid.

If neither TMJOIN nor TMRESUME is specified and the transaction
specified by xid has previously been seen by the resource
manager, the resource manager throws the XAException exception with
XAER_DUPID error code.
Parameters:
- xid - A global transaction identifier to be associated with the resource.
- flags - One of TMNOFLAGS, TMJOIN, or TMRESUME.
Throws:
- XAException - An error has occurred. Possible exceptions are XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA, XAER_INVAL, or XAER_PROTO.