| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Sat May 02 22:20:02 CEST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ThreadState (Apache Shiro 1.5.3 API)</title> |
| <meta name="date" content="2020-05-02"> |
| <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="ThreadState (Apache Shiro 1.5.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":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="class-use/ThreadState.html">Use</a></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="../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/util/UnknownClassException.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/util/ThreadState.html" target="_top">Frames</a></li> |
| <li><a href="ThreadState.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">org.apache.shiro.util</div> |
| <h2 title="Interface ThreadState" class="title">Interface ThreadState</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/subject/support/SubjectThreadState.html" title="class in org.apache.shiro.subject.support">SubjectThreadState</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/util/ThreadState.html#line.43">ThreadState</a></pre> |
| <div class="block">A <code>ThreadState</code> instance manages any state that might need to be bound and/or restored during a thread's |
| execution. |
| <h3>Usage</h3> |
| Calling <a href="../../../../org/apache/shiro/util/ThreadState.html#bind--"><code>bind()</code></a> will place state on the currently executing thread to be accessed later during |
| the thread's execution. |
| <h4>WARNING</h4> |
| After the thread is finished executing, or if an exception occurs, any previous state <b>MUST</b> be |
| <a href="../../../../org/apache/shiro/util/ThreadState.html#restore--"><code>restored</code></a> to guarantee all threads stay clean in any thread-pooled environment. This should always |
| be done in a <code>try/finally</code> block: |
| <pre> |
| ThreadState state = //acquire or instantiate as necessary |
| try { |
| state.bind(); |
| doSomething(); //execute any logic downstream logic that might need to access the state |
| } <b>finally { |
| state.restore(); |
| }</b> |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </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="../../../../org/apache/shiro/util/ThreadState.html#bind--">bind</a></span>()</code> |
| <div class="block">Binds any state that should be made accessible during a thread's execution.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/ThreadState.html#clear--">clear</a></span>()</code> |
| <div class="block">Completely clears/removes the <code>ThreadContext</code> state.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/shiro/util/ThreadState.html#restore--">restore</a></span>()</code> |
| <div class="block">Restores a thread to its state before bind <a href="../../../../org/apache/shiro/util/ThreadState.html#bind--"><code>bind</code></a> was invoked.</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="bind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/util/ThreadState.html#line.59">bind</a>()</pre> |
| <div class="block">Binds any state that should be made accessible during a thread's execution. This should typically always |
| be called in a <code>try/finally</code> block paired with the <a href="../../../../org/apache/shiro/util/ThreadState.html#restore--"><code>restore()</code></a> call to guarantee that the thread |
| is cleanly restored back to its original state. For example: |
| <pre> |
| ThreadState state = //acquire or instantiate as necessary |
| <b>try { |
| state.bind(); |
| doSomething(); //execute any logic downstream logic that might need to access the state |
| } </b> finally { |
| state.restore(); |
| } |
| </pre></div> |
| </li> |
| </ul> |
| <a name="restore--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restore</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/util/ThreadState.html#line.75">restore</a>()</pre> |
| <div class="block">Restores a thread to its state before bind <a href="../../../../org/apache/shiro/util/ThreadState.html#bind--"><code>bind</code></a> was invoked. This should typically always be |
| called in a <code>finally</code> block to guarantee that the thread is cleanly restored back to its original state |
| before <a href="../../../../org/apache/shiro/util/ThreadState.html#bind--"><code>bind</code></a>'s bind was called. For example: |
| <pre> |
| ThreadState state = //acquire or instantiate as necessary |
| try { |
| state.bind(); |
| doSomething(); //execute any logic downstream logic that might need to access the state |
| } <b>finally { |
| state.restore(); |
| }</b> |
| </pre></div> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>void <a href="../../../../src-html/org/apache/shiro/util/ThreadState.html#line.82">clear</a>()</pre> |
| <div class="block">Completely clears/removes the <code>ThreadContext</code> state. Typically this method should |
| only be called in special cases - it is more 'correct' to <a href="../../../../org/apache/shiro/util/ThreadState.html#restore--"><code>restore</code></a> a thread to its previous |
| state than to clear it entirely.</div> |
| </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="class-use/ThreadState.html">Use</a></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="../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/util/UnknownClassException.html" title="class in org.apache.shiro.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/util/ThreadState.html" target="_top">Frames</a></li> |
| <li><a href="ThreadState.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |