| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>BootstrapContext</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="BootstrapContext"; |
| } |
| } |
| 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="../../../javax/resource/spi/AuthenticationMechanism.CredentialInterface.html" title="enum in javax.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/resource/spi/CommException.html" title="class in javax.resource.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/resource/spi/BootstrapContext.html" target="_top">Frames</a></li> |
| <li><a href="BootstrapContext.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">javax.resource.spi</div> |
| <h2 title="Interface BootstrapContext" class="title">Interface BootstrapContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">BootstrapContext</span></pre> |
| <div class="block">This provides a mechanism to pass a bootstrap context to a resource adapter |
| instance when it is bootstrapped. That is, when |
| (<code>start(BootstrapContext)</code>) method on the |
| <code>ResourceAdapter</code> class is invoked. The bootstrap |
| context contains references to useful facilities that could be used by the |
| resource adapter instance.</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>java.util.Timer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/resource/spi/BootstrapContext.html#createTimer--">createTimer</a></span>()</code> |
| <div class="block">Creates a new <code>java.util.Timer</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>TransactionSynchronizationRegistry</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/resource/spi/BootstrapContext.html#getTransactionSynchronizationRegistry--">getTransactionSynchronizationRegistry</a></span>()</code> |
| <div class="block">Provides a handle to a <code>TransactionSynchronization</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/resource/spi/work/WorkManager.html" title="interface in javax.resource.spi.work">WorkManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/resource/spi/BootstrapContext.html#getWorkManager--">getWorkManager</a></span>()</code> |
| <div class="block">Provides a handle to a <code>WorkManager</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/resource/spi/XATerminator.html" title="interface in javax.resource.spi">XATerminator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/resource/spi/BootstrapContext.html#getXATerminator--">getXATerminator</a></span>()</code> |
| <div class="block">Provides a handle to a <code>XATerminator</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/resource/spi/BootstrapContext.html#isContextSupported-java.lang.Class-">isContextSupported</a></span>(java.lang.Class<? extends <a href="../../../javax/resource/spi/work/WorkContext.html" title="interface in javax.resource.spi.work">WorkContext</a>> workContextClass)</code> |
| <div class="block">A resource adapter can check an application server's support |
| for a particular WorkContext type through this method.</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="getWorkManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkManager</h4> |
| <pre><a href="../../../javax/resource/spi/work/WorkManager.html" title="interface in javax.resource.spi.work">WorkManager</a> getWorkManager()</pre> |
| <div class="block">Provides a handle to a <code>WorkManager</code> instance. The |
| <code>WorkManager</code> instance could be used by a resource adapter to |
| do its work by submitting <code>Work</code> instances for execution.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>WorkManager</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXATerminator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXATerminator</h4> |
| <pre><a href="../../../javax/resource/spi/XATerminator.html" title="interface in javax.resource.spi">XATerminator</a> getXATerminator()</pre> |
| <div class="block">Provides a handle to a <code>XATerminator</code> instance. The |
| <code>XATerminator</code> instance could be used by a resource adapter |
| to flow-in transaction completion and crash recovery calls from an EIS.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>XATerminator</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTimer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTimer</h4> |
| <pre>java.util.Timer createTimer() |
| throws <a href="../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></pre> |
| <div class="block">Creates a new <code>java.util.Timer</code> instance. The |
| <code>Timer</code> instance could be used to perform periodic |
| <code>Work</code> executions or other tasks.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>Timer</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></code> - indicates that a |
| <code>Timer</code> instance is not available. The |
| request may be retried later.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isContextSupported-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isContextSupported</h4> |
| <pre>boolean isContextSupported(java.lang.Class<? extends <a href="../../../javax/resource/spi/work/WorkContext.html" title="interface in javax.resource.spi.work">WorkContext</a>> workContextClass)</pre> |
| <div class="block">A resource adapter can check an application server's support |
| for a particular WorkContext type through this method. |
| This mechanism enables a resource adapter developer to |
| dynamically change the WorkContexts submitted with a Work instance |
| based on the support provided by the application server. |
| |
| The application server must employ an exact type equality check (that is |
| <code>java.lang.Class.equals(java.lang.Class)</code> check) in |
| this method, to check if it supports the WorkContext type provided |
| by the resource adapter. This method must be idempotent, that is all |
| calls to this method by a resource adapter for a particular |
| <code>WorkContext</code> type must return the same boolean value |
| throughout the lifecycle of that resource adapter instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workContextClass</code> - The WorkContext type that is tested for |
| support by the application server.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the <code>workContextClass</code> is supported |
| by the application server. false if the <code>workContextClass</code> |
| is unsupported or unknown to the application server.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransactionSynchronizationRegistry--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTransactionSynchronizationRegistry</h4> |
| <pre>TransactionSynchronizationRegistry getTransactionSynchronizationRegistry()</pre> |
| <div class="block">Provides a handle to a <code>TransactionSynchronization</code> instance. The |
| <code>TransactionSynchronizationRegistry</code> instance could be used by a |
| resource adapter to register synchronization objects, get transaction state and |
| status etc. This interface is implemented by the application server by a |
| stateless service object. The same object can be used by any number of |
| resource adapter objects with thread safety.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>TransactionSynchronizationRegistry</code> instance.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</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="../../../javax/resource/spi/AuthenticationMechanism.CredentialInterface.html" title="enum in javax.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/resource/spi/CommException.html" title="class in javax.resource.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/resource/spi/BootstrapContext.html" target="_top">Frames</a></li> |
| <li><a href="BootstrapContext.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> |
