| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>SubjectRunnable xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/subject/support/SubjectRunnable.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.subject.support; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ThreadState; |
| <a name="23" href="#23">23</a> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * A {@code SubjectRunnable} ensures that a target/delegate {@link Runnable Runnable} will execute such that any</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * call to {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} during the</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * {@code Runnable}'s execution will return the associated {@code Subject} instance. The {@code SubjectRunnable}</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * instance can be run on any thread (the current thread or asynchronously on another thread) and the</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils.getSubject()} call will still work properly. This implementation also guarantees that Shiro's</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * thread state will be identical before and after execution to ensure threads remain clean in any thread-pooled</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * environment.</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * When instances of this class {@link Runnable#run() run()}, the following occurs:</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <li>The Subject and any of its associated thread state is first bound to the thread that executes the</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@code Runnable}.</li></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <li>The delegate/target {@code Runnable} is {@link #doRun(Runnable) run}</li></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <li>Any previous thread state that might have existed before the {@code Subject} was bound is fully restored</li></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <h3>Usage</h3></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * This is typically considered a support class and is not often directly referenced. Most people prefer to use</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * the {@code Subject.}{@link Subject#execute(Runnable) execute} or</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@code Subject.}{@link Subject#associateWith(Runnable) associateWith} methods, which transparently perform the</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * necessary association logic.</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * An even more convenient alternative is to use a</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.concurrent.SubjectAwareExecutor SubjectAwareExecutor}, which transparently uses</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * instances of this class but does not require referencing Shiro's API at all.</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @see Subject#associateWith(Runnable)</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.concurrent.SubjectAwareExecutor SubjectAwareExecutor</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html">SubjectRunnable</a> implements Runnable { |
| <a name="58" href="#58">58</a> |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/util/ThreadState.html">ThreadState</a> threadState; |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Runnable runnable; |
| <a name="61" href="#61">61</a> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Creates a new {@code SubjectRunnable} that, when executed, will execute the target {@code delegate}, but</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * guarantees that it will run associated with the specified {@code Subject}.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param subject the Subject to associate with the delegate's execution.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param delegate the runnable to run.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html">SubjectRunnable</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, Runnable delegate) { |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html">SubjectThreadState</a>(subject), delegate); |
| <a name="71" href="#71">71</a> } |
| <a name="72" href="#72">72</a> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Creates a new {@code SubjectRunnable} that, when executed, will perform thread state</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * {@link ThreadState#bind binding} and guaranteed {@link ThreadState#restore restoration} before and after the</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * {@link Runnable Runnable}'s execution, respectively.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param threadState the thread state to bind and unbind before and after the runnable's execution.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param delegate the delegate {@code Runnable} to execute when this instance is {@link #run() run()}.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if either the {@code ThreadState} or {@link Runnable} arguments are {@code null}.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html">SubjectRunnable</a>(<a href="../../../../../org/apache/shiro/util/ThreadState.html">ThreadState</a> threadState, Runnable delegate) <strong class="jxr_keyword">throws</strong> IllegalArgumentException { |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">if</strong> (threadState == <strong class="jxr_keyword">null</strong>) { |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ThreadState argument cannot be null."</span>); |
| <a name="85" href="#85">85</a> } |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">this</strong>.threadState = threadState; |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (delegate == <strong class="jxr_keyword">null</strong>) { |
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Runnable argument cannot be null."</span>); |
| <a name="89" href="#89">89</a> } |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.runnable = delegate; |
| <a name="91" href="#91">91</a> } |
| <a name="92" href="#92">92</a> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * {@link ThreadState#bind Bind}s the Subject thread state, executes the target {@code Runnable} and then guarantees</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * the previous thread state's {@link ThreadState#restore restoration}:</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * threadState.{@link ThreadState#bind bind()};</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * {@link #doRun doRun}(targetRunnable);</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * threadState.{@link ThreadState#restore restore()}</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() { |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">try</strong> { |
| <a name="107" href="#107">107</a> threadState.bind(); |
| <a name="108" href="#108">108</a> doRun(<strong class="jxr_keyword">this</strong>.runnable); |
| <a name="109" href="#109">109</a> } <strong class="jxr_keyword">finally</strong> { |
| <a name="110" href="#110">110</a> threadState.restore(); |
| <a name="111" href="#111">111</a> } |
| <a name="112" href="#112">112</a> } |
| <a name="113" href="#113">113</a> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Simply calls the target {@link Runnable Runnable}'s {@link Runnable#run run()} method.</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @param runnable the target runnable to run.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="119" href="#119">119</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doRun(Runnable runnable) { |
| <a name="120" href="#120">120</a> runnable.run(); |
| <a name="121" href="#121">121</a> } |
| <a name="122" href="#122">122</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
