| <!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_21) on Thu May 30 15:02:19 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SubjectCallable (Apache Shiro 1.2.2 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <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="SubjectCallable (Apache Shiro 1.2.2 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/SubjectCallable.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/DisabledSessionException.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectCallable.html" target="_top">Frames</a></li> |
| <li><a href="SubjectCallable.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 SubjectCallable" class="title">Class SubjectCallable<V></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.SubjectCallable<V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.60">SubjectCallable</a><V> |
| 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="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><V></pre> |
| <div class="block">A <code>SubjectCallable</code> associates a <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> with a target/delegate |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent"><code>Callable</code></a> to ensure proper <code>Subject</code> thread-state management when the <code>Callable</code> executes. |
| This ensures that any calls to <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> |
| during the target <code>Callable</code>'s execution still work correctly even if the <code>Callable</code> executes on a |
| different thread than the one that created it. This allows <code>Subject</code> access during asynchronous operations. |
| <p/> |
| When instances of this class execute (typically via a <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a>), |
| the following occurs: |
| <ol> |
| <li>The specified Subject any of its associated thread state is first bound to the thread that executes the |
| <code>Callable</code>.</li> |
| <li>The delegate/target <code>Callable</code> is <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true#call()" title="class or interface in java.util.concurrent"><code>executed</code></a></li> |
| <li>The previous thread state that might have existed before the <code>Subject</code> was bound is fully restored</li> |
| </ol> |
| <p/> |
| This behavior ensures that the thread that executes this <code>Callable</code>, which is often a different thread than |
| the one that created the instance, retains a <code>Subject</code> to support <code>SecurityUtils.getSubject()</code> |
| invocations. It also guarantees that the running thread remains 'clean' in any thread-pooled environments. |
| |
| <h3>Usage</h3> |
| |
| This is typically considered a support class and is not often directly referenced. Most people prefer to use |
| the <code>Subject.</code><a href="../../../../../org/apache/shiro/subject/Subject.html#associateWith(java.util.concurrent.Callable)"><code>associateWith</code></a> method, which will automatically return |
| an instance of this class. |
| <p/> |
| An even more convenient alternative is to use a |
| <a href="../../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent"><code>SubjectAwareExecutorService</code></a>, which |
| transparently uses instances of this class.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/subject/Subject.html#associateWith(java.util.concurrent.Callable)"><code>Subject.associateWith(Callable)</code></a>, |
| <a href="../../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent"><code>SubjectAwareExecutorService</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html#threadState">threadState</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html#SubjectCallable(org.apache.shiro.subject.Subject, java.util.concurrent.Callable)">SubjectCallable</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> delegate)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html#SubjectCallable(org.apache.shiro.util.ThreadState, java.util.concurrent.Callable)">SubjectCallable</a></strong>(<a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a> threadState, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> delegate)</code> </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><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html#call()">call</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html#doCall(java.util.concurrent.Callable)">doCall</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> target)</code> </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="threadState"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>threadState</h4> |
| <pre>protected final <a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a> <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.62">threadState</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SubjectCallable(org.apache.shiro.subject.Subject, java.util.concurrent.Callable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SubjectCallable</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.65">SubjectCallable</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> delegate)</pre> |
| </li> |
| </ul> |
| <a name="SubjectCallable(org.apache.shiro.util.ThreadState, java.util.concurrent.Callable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SubjectCallable</h4> |
| <pre>protected <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.69">SubjectCallable</a>(<a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a> threadState, |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> delegate)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="call()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>call</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a> <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.80">call</a>() |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true#call()" title="class or interface in java.util.concurrent">call</a></code> in interface <code><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="doCall(java.util.concurrent.Callable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>doCall</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a> <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectCallable.html#line.89">doCall</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><<a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="type parameter in SubjectCallable">V</a>> target) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</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/SubjectCallable.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/DisabledSessionException.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectCallable.html" target="_top">Frames</a></li> |
| <li><a href="SubjectCallable.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |