| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>XATerminator</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XATerminator"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/spi/ValidatingManagedConnectionFactory.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/XATerminator.html" target="_top">Frames</a></li> |
| <li><a href="XATerminator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.resource.spi</div> |
| <h2 title="Interface XATerminator" class="title">Interface XATerminator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">XATerminator</span></pre> |
| <div class="block"><p>The XATerminator interface is used for transaction completion and |
| crash recovery flows.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/XATerminator.html#commit-javax.transaction.xa.Xid-boolean-">commit</a></span>(javax.transaction.xa.Xid xid, |
| boolean onePhase)</code> |
| <div class="block">Commits the global transaction specified by xid.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/XATerminator.html#forget-javax.transaction.xa.Xid-">forget</a></span>(javax.transaction.xa.Xid xid)</code> |
| <div class="block">Tells the resource manager to forget about a heuristically |
| completed transaction branch.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/XATerminator.html#prepare-javax.transaction.xa.Xid-">prepare</a></span>(javax.transaction.xa.Xid xid)</code> |
| <div class="block">Ask the resource manager to prepare for a transaction commit |
| of the transaction specified in xid.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>javax.transaction.xa.Xid[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/XATerminator.html#recover-int-">recover</a></span>(int flag)</code> |
| <div class="block">Obtains a list of prepared transaction branches from a resource |
| manager.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/XATerminator.html#rollback-javax.transaction.xa.Xid-">rollback</a></span>(javax.transaction.xa.Xid xid)</code> |
| <div class="block">Informs the resource manager to roll back work done on behalf |
| of a transaction branch.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="commit-javax.transaction.xa.Xid-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>void commit(javax.transaction.xa.Xid xid, |
| boolean onePhase) |
| throws javax.transaction.xa.XAException</pre> |
| <div class="block">Commits the global transaction specified by xid.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xid</code> - A global transaction identifier</dd> |
| <dd><code>onePhase</code> - If true, the resource manager should use a one-phase |
| commit protocol to commit the work done on behalf of xid.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.transaction.xa.XAException</code> - 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. |
| |
| <P>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.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forget-javax.transaction.xa.Xid-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forget</h4> |
| <pre>void forget(javax.transaction.xa.Xid xid) |
| throws javax.transaction.xa.XAException</pre> |
| <div class="block">Tells the resource manager to forget about a heuristically |
| completed transaction branch.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xid</code> - A global transaction identifier.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.transaction.xa.XAException</code> - An error has occurred. Possible exception |
| values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or |
| XAER_PROTO.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepare-javax.transaction.xa.Xid-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>int prepare(javax.transaction.xa.Xid xid) |
| throws javax.transaction.xa.XAException</pre> |
| <div class="block">Ask the resource manager to prepare for a transaction commit |
| of the transaction specified in xid.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xid</code> - A global transaction identifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A value indicating the resource manager's vote on the |
| outcome of the transaction. The possible values are: XA_RDONLY |
| or XA_OK. These constants are defined in |
| <code> javax.transaction.xa.XAResource</code> interface. |
| If the resource manager wants to roll back the |
| transaction, it should do so by raising an appropriate XAException |
| in the prepare method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.transaction.xa.XAException</code> - An error has occurred. Possible exception |
| values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, |
| or XAER_PROTO.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="recover-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recover</h4> |
| <pre>javax.transaction.xa.Xid[] recover(int flag) |
| throws javax.transaction.xa.XAException</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS |
| must be used when no other flags are set in the parameter. These |
| constants are defined in <code>javax.transaction.xa.XAResource</code> |
| interface.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource manager returns zero or more XIDs of the |
| transaction branches that are currently in a prepared or |
| heuristically completed state. If an error occurs during the |
| operation, the resource manager should throw the appropriate |
| XAException.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.transaction.xa.XAException</code> - An error has occurred. Possible values are |
| XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback-javax.transaction.xa.Xid-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>void rollback(javax.transaction.xa.Xid xid) |
| throws javax.transaction.xa.XAException</pre> |
| <div class="block">Informs the resource manager to roll back work done on behalf |
| of a transaction branch.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xid</code> - A global transaction identifier.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.transaction.xa.XAException</code> - 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. |
| |
| <p>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.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/spi/ValidatingManagedConnectionFactory.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/XATerminator.html" target="_top">Frames</a></li> |
| <li><a href="XATerminator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
