public class WrapperNamedXAResource extends Object implements NamedXAResource
TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY
Constructor and Description |
---|
WrapperNamedXAResource(XAResource xaResource,
String name) |
Modifier and Type | Method and Description |
---|---|
void |
commit(Xid xid,
boolean onePhase)
Commits 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)
Tells the resource manager to forget about a heuristically
completed transaction branch.
|
String |
getName() |
int |
getTransactionTimeout()
Obtains the current transaction timeout value set for this
XAResource instance.
|
boolean |
isSameRM(XAResource other)
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)
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.
|
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 . |
public WrapperNamedXAResource(XAResource xaResource, String name)
public String getName()
getName
in interface NamedXAResource
public void commit(Xid xid, boolean onePhase) throws XAException
javax.transaction.xa.XAResource
commit
in interface XAResource
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 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 end(Xid xid, int flags) throws XAException
javax.transaction.xa.XAResource
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.
end
in interface XAResource
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_RMFAIL, XAER_NOTA, XAER_INVAL,
XAER_PROTO, or XA_RB*.public void forget(Xid xid) throws XAException
javax.transaction.xa.XAResource
forget
in interface XAResource
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
javax.transaction.xa.XAResource
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.getTransactionTimeout
in interface XAResource
XAException
- An error has occurred. Possible exception
values are XAER_RMERR and XAER_RMFAIL.public boolean isSameRM(XAResource other) throws XAException
javax.transaction.xa.XAResource
isSameRM
in interface XAResource
other
- 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.public int prepare(Xid xid) throws XAException
javax.transaction.xa.XAResource
prepare
in interface XAResource
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
javax.transaction.xa.XAResource
recover
in interface XAResource
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.public void rollback(Xid xid) throws XAException
javax.transaction.xa.XAResource
rollback
in interface XAResource
xid
- A global transaction identifier.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.
public boolean setTransactionTimeout(int seconds) throws XAException
javax.transaction.xa.XAResource
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.
setTransactionTimeout
in interface XAResource
seconds
- The transaction timeout value in seconds.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
javax.transaction.xa.XAResource
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.start
in interface XAResource
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.Copyright © 2010 - 2020 Adobe. All Rights Reserved