| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ThreadContextRestorer</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ThreadContextRestorer"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/enterprise/concurrent/spi/ThreadContextProvider.html" title="interface in jakarta.enterprise.concurrent.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextSnapshot.html" title="interface in jakarta.enterprise.concurrent.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/enterprise/concurrent/spi/ThreadContextRestorer.html" target="_top">Frames</a></li> |
| <li><a href="ThreadContextRestorer.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.enterprise.concurrent.spi</div> |
| <h2 title="Interface ThreadContextRestorer" class="title">Interface ThreadContextRestorer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Functional Interface:</dt> |
| <dd>This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@FunctionalInterface |
| public interface <span class="typeNameLabel">ThreadContextRestorer</span></pre> |
| <div class="block">Restores the prior context on a thread after a contextual task or action completes.</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/enterprise/concurrent/spi/ThreadContextRestorer.html#endContext--">endContext</a></span>()</code> |
| <div class="block">Invoked by the Jakarta EE Product Provider to remove the thread context that |
| the <a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextSnapshot.html" title="interface in jakarta.enterprise.concurrent.spi"><code>ThreadContextSnapshot</code></a> began on this thread and restore the previous |
| context that was on the thread prior to that point.</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="endContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>endContext</h4> |
| <pre>void endContext() |
| throws java.lang.IllegalStateException</pre> |
| <div class="block">Invoked by the Jakarta EE Product Provider to remove the thread context that |
| the <a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextSnapshot.html" title="interface in jakarta.enterprise.concurrent.spi"><code>ThreadContextSnapshot</code></a> began on this thread and restore the previous |
| context that was on the thread prior to that point. The Jakarta EE Product Provider |
| must invoke the <a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextRestorer.html#endContext--"><code>endContext</code></a> method exactly |
| once for each <code>ThreadContextRestorer</code> instance that it obtains |
| and on the same thread from which the Jakarta EE Product Provider obtained it |
| by invoking <a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextSnapshot.html#begin--"><code>ThreadContextSnapshot.begin</code></a>. |
| <p> |
| Typically, patterns such as the following will be observed: |
| <pre> |
| restorerA1 = contextA_snapshot1.begin(); |
| restorerB1 = contextB_snapshot1.begin(); |
| restorerC1 = contextC_snapshot1.begin(); |
| ... |
| restorerC1.endContext(); |
| restorerB1.endContext(); |
| restorerA1.endContext(); |
| </pre> |
| However, more advanced sequences such as the following are also valid: |
| <pre> |
| restorerA1 = contextA_snapshot1.begin(); |
| restorerB1 = contextB_snapshot1.begin(); |
| ... |
| restorerC1 = contextC_snapshot1.begin(); |
| ... |
| restorerC1.endContext(); |
| ... |
| restorerB2 = contextB_snapshot2.begin(); |
| restorerC2 = contextC_snapshot2.begin(); |
| ... |
| restorerC2.endContext(); |
| restorerB2.endContext(); |
| ... |
| restorerB1.endContext(); |
| restorerA1.endContext(); |
| </pre></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if invoked more than once on the same instance.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</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/enterprise/concurrent/spi/ThreadContextProvider.html" title="interface in jakarta.enterprise.concurrent.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/enterprise/concurrent/spi/ThreadContextSnapshot.html" title="interface in jakarta.enterprise.concurrent.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/enterprise/concurrent/spi/ThreadContextRestorer.html" target="_top">Frames</a></li> |
| <li><a href="ThreadContextRestorer.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> |
