| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Wed May 25 23:25:56 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SubjectThreadState (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SubjectThreadState (Apache Shiro 1.2.5 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SubjectThreadState.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/subject/support/SubjectRunnable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectThreadState.html" target="_top">Frames</a></li> |
| <li><a href="SubjectThreadState.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.subject.support</div> |
| <h2 title="Class SubjectThreadState" class="title">Class SubjectThreadState</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.subject.support.SubjectThreadState</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.42">SubjectThreadState</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></pre> |
| <div class="block">Manages thread-state for <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> access (supporting |
| <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> calls) |
| during a thread's execution. |
| <p/> |
| The <a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#bind()"><code>bind</code></a> method will bind a <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> and a |
| <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> to the <a href="../../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><code>ThreadContext</code></a> so they can be retrieved |
| from the <code>ThreadContext</code> later by any |
| <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> calls that might occur during |
| the thread's execution.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#SubjectThreadState(org.apache.shiro.subject.Subject)">SubjectThreadState</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code> |
| <div class="block">Creates a new <code>SubjectThreadState</code> that will bind and unbind the specified <code>Subject</code> to the |
| thread</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#bind()">bind</a></strong>()</code> |
| <div class="block">Binds a <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> and <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> to the |
| <a href="../../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><code>ThreadContext</code></a> so they can be retrieved later by any |
| <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> calls that might occur |
| during the thread's execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#clear()">clear</a></strong>()</code> |
| <div class="block">Completely <a href="../../../../../org/apache/shiro/util/ThreadContext.html#remove(java.lang.Object)"><code>removes</code></a> the <code>ThreadContext</code> state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#getSubject()">getSubject</a></strong>()</code> |
| <div class="block">Returns the <code>Subject</code> instance managed by this <code>ThreadState</code> implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#restore()">restore</a></strong>()</code> |
| <div class="block"><a href="../../../../../org/apache/shiro/util/ThreadContext.html#remove(java.lang.Object)"><code>Remove</code></a>s all thread-state that was bound by this instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SubjectThreadState(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SubjectThreadState</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.55">SubjectThreadState</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block">Creates a new <code>SubjectThreadState</code> that will bind and unbind the specified <code>Subject</code> to the |
| thread</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subject</code> - the <code>Subject</code> instance to bind and unbind from the <a href="../../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><code>ThreadContext</code></a>.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSubject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubject</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.76">getSubject</a>()</pre> |
| <div class="block">Returns the <code>Subject</code> instance managed by this <code>ThreadState</code> implementation.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <code>Subject</code> instance managed by this <code>ThreadState</code> implementation.</dd></dl> |
| </li> |
| </ul> |
| <a name="bind()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.89">bind</a>()</pre> |
| <div class="block">Binds a <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> and <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> to the |
| <a href="../../../../../org/apache/shiro/util/ThreadContext.html" title="class in org.apache.shiro.util"><code>ThreadContext</code></a> so they can be retrieved later by any |
| <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> calls that might occur |
| during the thread's execution. |
| <p/> |
| Prior to binding, the <code>ThreadContext</code>'s existing <a href="../../../../../org/apache/shiro/util/ThreadContext.html#getResources()"><code>resources</code></a> are |
| retained so they can be restored later via the <a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#restore()"><code>restore</code></a> call.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()">bind</a></code> in interface <code><a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restore()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restore</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.109">restore</a>()</pre> |
| <div class="block"><a href="../../../../../org/apache/shiro/util/ThreadContext.html#remove(java.lang.Object)"><code>Remove</code></a>s all thread-state that was bound by this instance. If any previous |
| thread-bound resources existed prior to the <a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html#bind()"><code>bind</code></a> call, they are restored back to the |
| <code>ThreadContext</code> to ensure the thread state is exactly as it was before binding.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()">restore</a></code> in interface <code><a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectThreadState.html#line.121">clear</a>()</pre> |
| <div class="block">Completely <a href="../../../../../org/apache/shiro/util/ThreadContext.html#remove(java.lang.Object)"><code>removes</code></a> 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/subject/support/SubjectThreadState.html#restore()"><code>restore</code></a> a thread to its previous |
| state than to clear it entirely.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/util/ThreadState.html#clear()">clear</a></code> in interface <code><a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SubjectThreadState.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/subject/support/SubjectRunnable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectThreadState.html" target="_top">Frames</a></li> |
| <li><a href="SubjectThreadState.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |