|
Novell exteNd Messaging Platform 5.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 the this interface to support 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 invocation.
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 | |
static int |
TMENDRSCAN
End a recovery scan. |
static int |
TMFAIL
Disassociates the caller and mark the transaction branch rollback-only. |
static int |
TMJOIN
Caller is joining existing transaction branch. |
static int |
TMNOFLAGS
Use TMNOFLAGS to indicate no flags value is selected. |
static int |
TMONEPHASE
Caller is using one-phase optimization. |
static int |
TMRESUME
Caller is resuming association with with suspended transaction branch. |
static int |
TMSTARTRSCAN
Start a recovery scan. |
static int |
TMSUCCESS
Disassociate caller from transaction branch. |
static int |
TMSUSPEND
Caller is suspending (not ending) association with transaction branch. |
static int |
XA_OK
The transaction work has been prepared normally. |
static int |
XA_RDONLY
The transaction branch has been read-only and has been committed. |
Method Summary | |
void |
commit(Xid xid,
boolean onePhase)
Commit the global transaction specified by xid. |
void |
end(Xid xid,
int flags)
Ends the work performed on behalf of a transaction branch. |
void |
forget(Xid xid)
Tell the resource manager to forget about a heuristically completed transaction branch. |
int |
getTransactionTimeout()
Obtain 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. |
int |
prepare(Xid xid)
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid. |
Xid[] |
recover(int flag)
Obtain a list of prepared transaction branches from a resource manager. |
void |
rollback(Xid xid)
Inform the resource manager to roll back work done on behalf of a transaction branch |
boolean |
setTransactionTimeout(int seconds)
Set the current transaction timeout value for this XAResource
instance. |
void |
start(Xid xid,
int flags)
Start work on behalf of a transaction branch specified in xid If TMJOIN is specified, the start is for joining a transaction previously seen by the resource manager. |
Field Detail |
public static final int TMENDRSCAN
public static final int TMFAIL
public static final int TMJOIN
public static final int TMNOFLAGS
public static final int TMONEPHASE
public static final int TMRESUME
public static final int TMSTARTRSCAN
public static final int TMSUCCESS
public static final int TMSUSPEND
public static final int XA_RDONLY
public static final int XA_OK
Method Detail |
public 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.
public void end(Xid xid, int flags) throws XAException
If TMSUSPEND is specified in flags, the transaction branch is temporarily suspended in incomplete state. The transaction context is in suspened state and must be resumed via start 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
what was 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*.public 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.public int getTransactionTimeout() throws XAException
XAResource.setTransactionTimeout
was not use 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, XAER_RMFAIL.public 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, XAER_RMFAIL.public 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.public Xid[] recover(int flag) throws XAException
flag
- One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS
must be used when no other flags are set in flags.
XAException
- An error has occurred. Possible values are
XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.public void rollback(Xid xid) throws XAException
xid
- A global transaction identifier
XAException
- An error has occurredpublic boolean setTransactionTimeout(int seconds) throws XAException
Set 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 transaction timeout value to be set explicitly, this method
returns false.
XAException
- An error has occurred. Possible exception values
are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.public void start(Xid xid, int flags) throws XAException
xid
- A global transaction identifier to be associated
with the resourceflags
- 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.
|
Novell exteNd Messaging Platform 5.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |