| javax.transaction.xa.XAResource
| XAResource | | public interface XAResource (Code) | | 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).
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.
|
| Field Summary | |
| final public static int | TMENDRSCAN
Ends a recovery scan. | | final public static int | TMFAIL
Disassociates the caller and marks the transaction branch
rollback-only. | | final public static int | TMJOIN
Caller is joining existing transaction branch. | | final public static int | TMNOFLAGS
Use TMNOFLAGS to indicate no flags value is selected. | | final public static int | TMONEPHASE
Caller is using one-phase optimization. | | final public static int | TMRESUME
Caller is resuming association with a suspended
transaction branch. | | final public static int | TMSTARTRSCAN
Starts a recovery scan. | | final public static int | TMSUCCESS
Disassociates caller from a transaction branch. | | final public static int | TMSUSPEND
Caller is suspending (not ending) its association with
a transaction branch. | | final public static int | XA_OK
The transaction work has been prepared normally. | | final public static int | XA_RDONLY
The transaction branch has been read-only and has been committed. |
| Method Summary | |
| void | commit(Xid xid, boolean onePhase)
Commits the global transaction specified by xid.
Parameters:
xid - A global transaction identifier
Parameters:
onePhase - If true, the resource manager should use a one-phasecommit protocol to commit the work done on behalf of xid.
exception:
XAException - An error has occurred. | | void | end(Xid xid, int flags)
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. | | void | forget(Xid xid)
Tells the resource manager to forget about a heuristically
completed transaction branch.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. | | int | getTransactionTimeout()
Obtains the current transaction timeout value set for this
XAResource instance. | | boolean | isSameRM(XAResource xares)
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.
Parameters:
xares - An XAResource object whose resource manager instanceis to be compared with the resource manager instance of thetarget object. | | int | prepare(Xid xid)
Ask the resource manager to prepare for a transaction commit
of the transaction specified in xid.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. | | 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.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. | | boolean | setTransactionTimeout(int seconds)
Sets the current transaction timeout value for this XAResource
instance. | | void | start(Xid xid, int flags)
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. |
| TMENDRSCAN | | final public static int TMENDRSCAN(Code) | | Ends a recovery scan.
|
| TMFAIL | | final public static int TMFAIL(Code) | | Disassociates the caller and marks the transaction branch
rollback-only.
|
| TMJOIN | | final public static int TMJOIN(Code) | | Caller is joining existing transaction branch.
|
| TMNOFLAGS | | final public static int TMNOFLAGS(Code) | | Use TMNOFLAGS to indicate no flags value is selected.
|
| TMONEPHASE | | final public static int TMONEPHASE(Code) | | Caller is using one-phase optimization.
|
| TMRESUME | | final public static int TMRESUME(Code) | | Caller is resuming association with a suspended
transaction branch.
|
| TMSTARTRSCAN | | final public static int TMSTARTRSCAN(Code) | | Starts a recovery scan.
|
| TMSUCCESS | | final public static int TMSUCCESS(Code) | | Disassociates caller from a transaction branch.
|
| TMSUSPEND | | final public static int TMSUSPEND(Code) | | Caller is suspending (not ending) its association with
a transaction branch.
|
| XA_OK | | final public static int XA_OK(Code) | | The transaction work has been prepared normally.
|
| XA_RDONLY | | final public static int XA_RDONLY(Code) | | The transaction branch has been read-only and has been committed.
|
| commit | | void commit(Xid xid, boolean onePhase) throws XAException(Code) | | Commits the global transaction specified by xid.
Parameters:
xid - A global transaction identifier
Parameters:
onePhase - If true, the resource manager should use a one-phasecommit protocol to commit the work done on behalf of xid.
exception:
XAException - An error has occurred. Possible XAExceptionsare 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 theparameter onePhase is set to true, the resource manager may throwone of the XA_RB* exceptions. Upon return, the resource manager hasrolled back the branch's work and has released all held resources. |
| end | | void end(Xid xid, int flags) throws XAException(Code) | | 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 asthe identifier used previously in the start method.
Parameters:
flags - One of TMSUCCESS, TMFAIL, or TMSUSPEND.
exception:
XAException - An error has occurred. Possible XAExceptionvalues are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL,XAER_PROTO, or XA_RB*. |
| forget | | void forget(Xid xid) throws XAException(Code) | | Tells the resource manager to forget about a heuristically
completed transaction branch.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. Possible exceptionvalues are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, orXAER_PROTO. |
| getTransactionTimeout | | int getTransactionTimeout() throws XAException(Code) | | 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.
the transaction timeout value in seconds.
exception:
XAException - An error has occurred. Possible exceptionvalues are XAER_RMERR and XAER_RMFAIL. |
| isSameRM | | boolean isSameRM(XAResource xares) throws XAException(Code) | | 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.
Parameters:
xares - An XAResource object whose resource manager instanceis to be compared with the resource manager instance of thetarget object. true if it's the same RM instance; otherwisefalse.
exception:
XAException - An error has occurred. Possible exceptionvalues are XAER_RMERR and XAER_RMFAIL. |
| prepare | | int prepare(Xid xid) throws XAException(Code) | | Ask the resource manager to prepare for a transaction commit
of the transaction specified in xid.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. Possible exceptionvalues are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL,or XAER_PROTO. A value indicating the resource manager's vote on theoutcome of the transaction. The possible values are: XA_RDONLYor XA_OK. If the resource manager wants to roll back thetransaction, it should do so by raising an appropriate XAExceptionin the prepare method. |
| recover | | Xid[] recover(int flag) throws XAException(Code) | | 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. TMNOFLAGSmust be used when no other flags are set in the parameter.
exception:
XAException - An error has occurred. Possible values areXAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO. The resource manager returns zero or more XIDs of thetransaction branches that are currently in a prepared orheuristically completed state. If an error occurs during theoperation, the resource manager should throw the appropriateXAException. |
| rollback | | void rollback(Xid xid) throws XAException(Code) | | Informs the resource manager to roll back work done on behalf
of a transaction branch.
Parameters:
xid - A global transaction identifier.
exception:
XAException - An error has occurred. Possible XAExceptions areXA_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 theresource manager may throw one of the XA_RB* exceptions. Upon return,the resource manager has rolled back the branch's work and has releasedall held resources. |
| setTransactionTimeout | | boolean setTransactionTimeout(int seconds) throws XAException(Code) | | Sets the current transaction timeout value for this 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.
Parameters:
seconds - The transaction timeout value in seconds. true if the transaction timeout value is set successfully;otherwise false.
exception:
XAException - An error has occurred. Possible exception valuesare XAER_RMERR, XAER_RMFAIL, or XAER_INVAL. |
| start | | void start(Xid xid, int flags) throws XAException(Code) | | 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 associatedwith the resource.
Parameters:
flags - One of TMNOFLAGS, TMJOIN, or TMRESUME.
exception:
XAException - An error has occurred. Possible exceptionsare XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE,XAER_NOTA, XAER_INVAL, or XAER_PROTO. |
|
|