public interface XAResource
The XA interface defines the contract between a Resource Manager and a Transaction Manager in a distributed transaction processing (DTP) environment. A JDBC driver or a JMS provider implements this interface to support the association between a global transaction and a database or message service connection.
The XAResource interface can be supported by any transactional resource that is intended to be used by application programs in an environment where transactions are controlled by an external transaction manager. An example of such a resource is a database management system. An application may access data through multiple database connections. Each database connection is enlisted with the transaction manager as a transactional resource. The transaction manager obtains an XAResource for each connection participating in a global transaction. The transaction manager uses the start
method to associate the global transaction with the resource, and it uses the end
method to disassociate the transaction from the resource. The resource manager is responsible for associating the global transaction to all work performed on its data between the start and end method invocations.
At transaction commit time, the resource managers are informed by the transaction manager to prepare, commit, or rollback a transaction according to the two-phase commit protocol.
Modifier and Type | Field | Description |
---|---|---|
static final int |
TMENDRSCAN |
Ends a recovery scan. |
static final int |
TMFAIL |
Disassociates the caller and marks the transaction branch rollback-only. |
static final int |
TMJOIN |
Caller is joining existing transaction branch. |
static final int |
TMNOFLAGS |
Use TMNOFLAGS to indicate no flags value is selected. |
static final int |
TMONEPHASE |
Caller is using one-phase optimization. |
static final int |
TMRESUME |
Caller is resuming association with a suspended transaction branch. |
static final int |
TMSTARTRSCAN |
Starts a recovery scan. |
static final int |
TMSUCCESS |
Disassociates caller from a transaction branch. |
static final int |
TMSUSPEND |
Caller is suspending (not ending) its association with a transaction branch. |
static final int |
XA_OK |
The transaction work has been prepared normally. |
static final int |
XA_RDONLY |
The transaction branch has been read-only and has been committed. |
Modifier and Type | Method | Description |
---|---|---|
void |
commit |
Commits the global transaction specified by xid. |
void |
end |
Ends the work performed on behalf of a transaction branch. |
void |
forget |
Tells the resource manager to forget about a heuristically completed transaction branch. |
int |
getTransactionTimeout() |
Obtains the current transaction timeout value set for this XAResource instance. |
boolean |
isSameRM |
This method is called to determine if the resource manager instance represented by the target object is the same as the resource manager instance represented by the parameter xares. |
int |
prepare |
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid. |
Xid[] |
recover |
Obtains a list of prepared transaction branches from a resource manager. |
void |
rollback |
Informs the resource manager to roll back work done on behalf of a transaction branch. |
boolean |
setTransactionTimeout |
Sets the current transaction timeout value for this XAResource instance. |
void |
start |
Starts work on behalf of a transaction branch specified in xid . |
static final int TMENDRSCAN
static final int TMFAIL
static final int TMJOIN
static final int TMNOFLAGS
static final int TMONEPHASE
static final int TMRESUME
static final int TMSTARTRSCAN
static final int TMSUCCESS
static final int TMSUSPEND
static final int XA_RDONLY
static final int XA_OK
void commit(Xid xid, boolean onePhase) throws XAException
xid
- A global transaction identifieronePhase
- If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.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 paramether 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.
void end(Xid xid, int flags) throws XAException
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.
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.XAException
- An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.void forget(Xid xid) throws XAException
xid
- A global transaction identifier.XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.int getTransactionTimeout() throws XAException
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.XAException
- An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.boolean isSameRM(XAResource xares) throws XAException
xares
- An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object.XAException
- An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.int prepare(Xid xid) throws XAException
xid
- A global transaction identifier.XAException
- An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.Xid[] recover(int flag) throws XAException
flag
- One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter.XAException
- An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.void rollback(Xid xid) throws XAException
xid
- A global transaction identifier.XAException
- An error has occurred.boolean setTransactionTimeout(int seconds) throws XAException
XAResource
instance. Once set, this timeout value is effective until setTransactionTimeout
is invoked again with a different value. To reset the timeout value to the default value used by the resource manager, set the value to zero. If the timeout operation is performed successfully, the method returns true; otherwise false. If a resource manager does not support explicitly setting the transaction timeout value, this method returns false.seconds
- The transaction timeout value in seconds.XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.void start(Xid xid, int flags) throws XAException
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.xid
- A global transaction identifier to be associated with the resource.flags
- One of TMNOFLAGS, TMJOIN, or TMRESUME.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.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.transaction.xa/javax/transaction/xa/XAResource.html