| java.lang.Object
 org.apache.derby.jdbc.EmbedXAResource
| EmbedXAResource | | class EmbedXAResource implements XAResource(Code) | | Implements XAResource
|
| Method Summary | |
| final public synchronized void | commit(Xid xid, boolean onePhase)
Commit 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. | | final public synchronized void | end(Xid xid, int flags)
Ends the work performed on behalf of a transaction branch. | | final public synchronized void | forget(Xid xid)
Tell the resource manager to forget about a heuristically completed
transaction branch.
Parameters:
xid - A global transaction identifier
exception:
XAException - An error has occurred. | | Xid | getCurrentXid()
| | public int | getTransactionTimeout()
Obtain the current transaction timeout value set for this XAResource
instance. | | final public synchronized 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 instance is tobe compared with the resource manager instance of the target object. | | final public synchronized 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 A value indicating the resource manager's vote on the outcomeof the transaction. | | final public synchronized Xid[] | recover(int flag)
Obtain a list of prepared transaction branches from a resource
manager. | | final public synchronized void | rollback(Xid xid)
| | public boolean | setTransactionTimeout(int seconds)
Set the current transaction timeout value for this XAResource
instance. | | final public synchronized 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. |
| commit | | final public synchronized void commit(Xid xid, boolean onePhase) throws XAException(Code) | | Commit 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 XAExceptions areXA_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 andthe paramether onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, theresource manager has rolled back the branch's work and has released all held resources. |
| end | | final public synchronized 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 let the transaction be completed.
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.
Parameters:
xid - A global transaction identifier that is the same as what wasused previously in the start method.
Parameters:
flags - One of TMSUCCESS, TMFAIL, or TMSUSPEND
exception:
XAException - An error has occurred.Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA,XAER_INVAL, XAER_PROTO, or XA_RB*. |
| forget | | final public synchronized void forget(Xid xid) throws XAException(Code) | | Tell the resource manager to forget about a heuristically completed
transaction branch.
Parameters:
xid - A global transaction identifier
exception:
XAException - An error has occurred. Possible exception valuesare XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO. |
| getCurrentXid | | Xid getCurrentXid()(Code) | | Resturns currently active xid
Xid |
| getTransactionTimeout | | public int getTransactionTimeout()(Code) | | Obtain the current transaction timeout value set for this XAResource
instance. If 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.
the transaction timeout value in seconds. |
| isSameRM | | final public synchronized 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 instance is tobe compared with the resource manager instance of the target object. true if it's the same RM instance; otherwise false.
exception:
XAException - An error has occurred. Possible exception valuesare XAER_RMERR, XAER_RMFAIL. |
| prepare | | final public synchronized 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 A value indicating the resource manager's vote on the outcomeof the transaction. The possible values are: XA_RDONLY or XA_OK. If theresource manager wants to roll back the transaction, it should do so byraising an appropriate XAException in the prepare method.
exception:
XAException - An error has occurred. Possible exception valuesare: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, orXAER_PROTO. |
| recover | | final public synchronized Xid[] recover(int flag) throws XAException(Code) | | Obtain 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. TMNOFLAGS mustbe used when no other flags are set in flags. The resource manager returns zero or more XIDs for thetransaction branches that are currently in a prepared or heuristicallycompleted state. If an error occurs during the operation, the resourcemanager should throw the appropriate XAException.
exception:
XAException - An error has occurred. Possible values areXAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO. |
| rollback | | final public synchronized void rollback(Xid xid) throws XAException(Code) | | Inform 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 |
| setTransactionTimeout | | public boolean setTransactionTimeout(int seconds)(Code) | | 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.
Parameters:
seconds - the transaction timeout value in seconds. true if transaction timeout value is set successfully;otherwise false.
exception:
XAException - - An error has occurred. Possible exceptionvalues are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL. |
| start | | final public synchronized void start(Xid xid, int flags) throws XAException(Code) | | 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. If TMRESUME is specified, the start is to resume
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 theresource
Parameters:
flags - One of TMNOFLAGS, TMJOIN, or TMRESUME
exception:
XAException - An error has occurred. Possible exceptions areXA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA,XAER_INVAL, or XAER_PROTO. |
|
|