| <!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>ThreadContext xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/util/ThreadContext.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.util; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Collections; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * A ThreadContext provides a means of binding and unbinding objects to the</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * current thread based on key/value pairs.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p>An internal {@link java.util.HashMap} is used to maintain the key/value pairs</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * for each thread.</p></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p>If the desired behavior is to ensure that bound data is not shared across</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * threads in a pooled or reusable threaded environment, the application (or more likely a framework) must</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * bind and remove any necessary values at the beginning and end of stack</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * execution, respectively (i.e. individually explicitly or all via the <tt>clear</tt> method).</p></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @see #remove()</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/util/ThreadContext.html">ThreadContext</a> { |
| <a name="47" href="#47">47</a> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Private internal log instance.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(ThreadContext.<strong class="jxr_keyword">class</strong>); |
| <a name="52" href="#52">52</a> |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SECURITY_MANAGER_KEY = ThreadContext.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"_SECURITY_MANAGER_KEY"</span>; |
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SUBJECT_KEY = ThreadContext.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"_SUBJECT_KEY"</span>; |
| <a name="55" href="#55">55</a> |
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> ThreadLocal<Map<Object, Object>> resources = <strong class="jxr_keyword">new</strong> InheritableThreadLocalMap<Map<Object, Object>>(); |
| <a name="57" href="#57">57</a> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Default no-argument constructor.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/util/ThreadContext.html">ThreadContext</a>() { |
| <a name="62" href="#62">62</a> } |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Returns the ThreadLocal Map. This Map is used internally to bind objects</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * to the current thread by storing each object under a unique key.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return the map of bound resources</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Map<Object, Object> getResources() { |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> (resources.get() == <strong class="jxr_keyword">null</strong>){ |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">return</strong> Collections.emptyMap(); |
| <a name="73" href="#73">73</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> HashMap<Object, Object>(resources.get()); |
| <a name="75" href="#75">75</a> } |
| <a name="76" href="#76">76</a> } |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Allows a caller to explicitly set the entire resource map. This operation overwrites everything that existed</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * previously in the ThreadContext - if you need to retain what was on the thread prior to calling this method,</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * call the {@link #getResources()} method, which will give you the existing state.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param newResources the resources to replace the existing {@link #getResources() resources}.</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setResources(Map<Object, Object> newResources) { |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(newResources)) { |
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong>; |
| <a name="89" href="#89">89</a> } |
| <a name="90" href="#90">90</a> ensureResourcesInitialized(); |
| <a name="91" href="#91">91</a> resources.get().clear(); |
| <a name="92" href="#92">92</a> resources.get().putAll(newResources); |
| <a name="93" href="#93">93</a> } |
| <a name="94" href="#94">94</a> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Returns the value bound in the {@code ThreadContext} under the specified {@code key}, or {@code null} if there</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * is no value for that {@code key}.</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param key the map key to use to lookup the value</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return the value bound in the {@code ThreadContext} under the specified {@code key}, or {@code null} if there</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * is no value for that {@code key}.</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Object getValue(Object key) { |
| <a name="105" href="#105">105</a> Map<Object, Object> perThreadResources = resources.get(); |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> perThreadResources != <strong class="jxr_keyword">null</strong> ? perThreadResources.get(key) : <strong class="jxr_keyword">null</strong>; |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> ensureResourcesInitialized(){ |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (resources.get() == <strong class="jxr_keyword">null</strong>){ |
| <a name="111" href="#111">111</a> resources.set(<strong class="jxr_keyword">new</strong> HashMap<Object, Object>()); |
| <a name="112" href="#112">112</a> } |
| <a name="113" href="#113">113</a> } |
| <a name="114" href="#114">114</a> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Returns the object for the specified <code>key</code> that is bound to</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * the current thread.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param key the key that identifies the value to return</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @return the object keyed by <code>key</code> or <code>null</code> if</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * no value exists for the specified <code>key</code></em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Object get(Object key) { |
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="125" href="#125">125</a> String msg = <span class="jxr_string">"get() - in thread ["</span> + Thread.currentThread().getName() + <span class="jxr_string">"]"</span>; |
| <a name="126" href="#126">126</a> log.trace(msg); |
| <a name="127" href="#127">127</a> } |
| <a name="128" href="#128">128</a> |
| <a name="129" href="#129">129</a> Object value = getValue(key); |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> ((value != <strong class="jxr_keyword">null</strong>) && log.isTraceEnabled()) { |
| <a name="131" href="#131">131</a> String msg = <span class="jxr_string">"Retrieved value of type ["</span> + value.getClass().getName() + <span class="jxr_string">"] for key ["</span> + |
| <a name="132" href="#132">132</a> key + <span class="jxr_string">"] "</span> + <span class="jxr_string">"bound to thread ["</span> + Thread.currentThread().getName() + <span class="jxr_string">"]"</span>; |
| <a name="133" href="#133">133</a> log.trace(msg); |
| <a name="134" href="#134">134</a> } |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="136" href="#136">136</a> } |
| <a name="137" href="#137">137</a> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * Binds <tt>value</tt> for the given <code>key</code> to the current thread.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * <p>A <tt>null</tt> <tt>value</tt> has the same effect as if <tt>remove</tt> was called for the given</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * <tt>key</tt>, i.e.:</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * if ( value == null ) {</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * remove( key );</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * }</pre></em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param key The key with which to identify the <code>value</code>.</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @param value The value to bind to the thread.</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the <code>key</code> argument is <tt>null</tt>.</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> put(Object key, Object value) { |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>) { |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"key cannot be null"</span>); |
| <a name="156" href="#156">156</a> } |
| <a name="157" href="#157">157</a> |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) { |
| <a name="159" href="#159">159</a> remove(key); |
| <a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong>; |
| <a name="161" href="#161">161</a> } |
| <a name="162" href="#162">162</a> |
| <a name="163" href="#163">163</a> ensureResourcesInitialized(); |
| <a name="164" href="#164">164</a> resources.get().put(key, value); |
| <a name="165" href="#165">165</a> |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="167" href="#167">167</a> String msg = <span class="jxr_string">"Bound value of type ["</span> + value.getClass().getName() + <span class="jxr_string">"] for key ["</span> + |
| <a name="168" href="#168">168</a> key + <span class="jxr_string">"] to thread "</span> + <span class="jxr_string">"["</span> + Thread.currentThread().getName() + <span class="jxr_string">"]"</span>; |
| <a name="169" href="#169">169</a> log.trace(msg); |
| <a name="170" href="#170">170</a> } |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * Unbinds the value for the given <code>key</code> from the current</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * thread.</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @param key The key identifying the value bound to the current thread.</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @return the object unbound or <tt>null</tt> if there was nothing bound</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * under the specified <tt>key</tt> name.</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Object remove(Object key) { |
| <a name="182" href="#182">182</a> Map<Object, Object> perThreadResources = resources.get(); |
| <a name="183" href="#183">183</a> Object value = perThreadResources != <strong class="jxr_keyword">null</strong> ? perThreadResources.remove(key) : <strong class="jxr_keyword">null</strong>; |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> ((value != <strong class="jxr_keyword">null</strong>) && log.isTraceEnabled()) { |
| <a name="186" href="#186">186</a> String msg = <span class="jxr_string">"Removed value of type ["</span> + value.getClass().getName() + <span class="jxr_string">"] for key ["</span> + |
| <a name="187" href="#187">187</a> key + <span class="jxr_string">"]"</span> + <span class="jxr_string">"from thread ["</span> + Thread.currentThread().getName() + <span class="jxr_string">"]"</span>; |
| <a name="188" href="#188">188</a> log.trace(msg); |
| <a name="189" href="#189">189</a> } |
| <a name="190" href="#190">190</a> |
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="192" href="#192">192</a> } |
| <a name="193" href="#193">193</a> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * {@link ThreadLocal#remove Remove}s the underlying {@link ThreadLocal ThreadLocal} from the thread.</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * This method is meant to be the final 'clean up' operation that is called at the end of thread execution to</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * prevent thread corruption in pooled thread environments.</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="202" href="#202">202</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> remove() { |
| <a name="203" href="#203">203</a> resources.remove(); |
| <a name="204" href="#204">204</a> } |
| <a name="205" href="#205">205</a> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies retrieval of the application's SecurityManager instance from the current</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * thread. If there is no SecurityManager bound to the thread (probably because framework code did not bind it</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * to the thread), this method returns <tt>null</tt>.</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * It is merely a convenient wrapper for the following:</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * <code>return (SecurityManager)get( SECURITY_MANAGER_KEY );</code></em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * This method only returns the bound value if it exists - it does not remove it</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * from the thread. To remove it, one must call {@link #unbindSecurityManager() unbindSecurityManager()} instead.</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @return the Subject object bound to the thread, or <tt>null</tt> if there isn't one bound.</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="221" href="#221">221</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> getSecurityManager() { |
| <a name="222" href="#222">222</a> <strong class="jxr_keyword">return</strong> (SecurityManager) get(SECURITY_MANAGER_KEY); |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies binding the application's SecurityManager instance to the ThreadContext.</em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * <p>The method's existence is to help reduce casting in code and to simplify remembering of</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * ThreadContext key names. The implementation is simple in that, if the SecurityManager is not <tt>null</tt>,</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * it binds it to the thread, i.e.:</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * if (securityManager != null) {</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * put( SECURITY_MANAGER_KEY, securityManager);</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * }</pre></em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * @param securityManager the application's SecurityManager instance to bind to the thread. If the argument is</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * null, nothing will be done.</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> bind(<a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager) { |
| <a name="243" href="#243">243</a> <strong class="jxr_keyword">if</strong> (securityManager != <strong class="jxr_keyword">null</strong>) { |
| <a name="244" href="#244">244</a> put(SECURITY_MANAGER_KEY, securityManager); |
| <a name="245" href="#245">245</a> } |
| <a name="246" href="#246">246</a> } |
| <a name="247" href="#247">247</a> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies removal of the application's SecurityManager instance from the thread.</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * The implementation just helps reduce casting and remembering of the ThreadContext key name, i.e it is</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * merely a conveient wrapper for the following:</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * <code>return (SecurityManager)remove( SECURITY_MANAGER_KEY );</code></em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * If you wish to just retrieve the object from the thread without removing it (so it can be retrieved later</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * during thread execution), use the {@link #getSecurityManager() getSecurityManager()} method instead.</em> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * @return the application's SecurityManager instance previously bound to the thread, or <tt>null</tt> if there</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * was none bound.</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> unbindSecurityManager() { |
| <a name="264" href="#264">264</a> <strong class="jxr_keyword">return</strong> (SecurityManager) remove(SECURITY_MANAGER_KEY); |
| <a name="265" href="#265">265</a> } |
| <a name="266" href="#266">266</a> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies retrieval of a thread-bound Subject. If there is no</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * Subject bound to the thread, this method returns <tt>null</tt>. It is merely a convenient wrapper</em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * for the following:</em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * <code>return (Subject)get( SUBJECT_KEY );</code></em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * This method only returns the bound value if it exists - it does not remove it</em> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * from the thread. To remove it, one must call {@link #unbindSubject() unbindSubject()} instead.</em> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @return the Subject object bound to the thread, or <tt>null</tt> if there isn't one bound.</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="280" href="#280">280</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> getSubject() { |
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">return</strong> (Subject) get(SUBJECT_KEY); |
| <a name="282" href="#282">282</a> } |
| <a name="283" href="#283">283</a> |
| <a name="284" href="#284">284</a> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies binding a Subject to the ThreadContext.</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * <p>The method's existence is to help reduce casting in your own code and to simplify remembering of</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * ThreadContext key names. The implementation is simple in that, if the Subject is not <tt>null</tt>,</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> * it binds it to the thread, i.e.:</em> |
| <a name="291" href="#291">291</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="292" href="#292">292</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * if (subject != null) {</em> |
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * put( SUBJECT_KEY, subject );</em> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * }</pre></em> |
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @param subject the Subject object to bind to the thread. If the argument is null, nothing will be done.</em> |
| <a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="300" href="#300">300</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> bind(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="301" href="#301">301</a> <strong class="jxr_keyword">if</strong> (subject != <strong class="jxr_keyword">null</strong>) { |
| <a name="302" href="#302">302</a> put(SUBJECT_KEY, subject); |
| <a name="303" href="#303">303</a> } |
| <a name="304" href="#304">304</a> } |
| <a name="305" href="#305">305</a> |
| <a name="306" href="#306">306</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * Convenience method that simplifies removal of a thread-local Subject from the thread.</em> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * The implementation just helps reduce casting and remembering of the ThreadContext key name, i.e it is</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * merely a conveient wrapper for the following:</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * <code>return (Subject)remove( SUBJECT_KEY );</code></em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * If you wish to just retrieve the object from the thread without removing it (so it can be retrieved later during</em> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * thread execution), you should use the {@link #getSubject() getSubject()} method for that purpose.</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @return the Subject object previously bound to the thread, or <tt>null</tt> if there was none bound.</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="320" href="#320">320</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> unbindSubject() { |
| <a name="321" href="#321">321</a> <strong class="jxr_keyword">return</strong> (Subject) remove(SUBJECT_KEY); |
| <a name="322" href="#322">322</a> } |
| <a name="323" href="#323">323</a> |
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> InheritableThreadLocalMap<T <strong class="jxr_keyword">extends</strong> Map<Object, Object>> <strong class="jxr_keyword">extends</strong> InheritableThreadLocal<Map<Object, Object>> { |
| <a name="325" href="#325">325</a> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * This implementation was added to address a</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://jsecurity.markmail.org/search/?q=" target="alexandria_uri">http://jsecurity.markmail.org/search/?q=</a>#query:+page:1+mid:xqi2yxurwmrpqrvj+state:results"></em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * user-reported issue</a>.</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @param parentValue the parent value, a HashMap as defined in the {@link #initialValue()} method.</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * @return the HashMap to be used by any parent-spawned child threads (a clone of the parent HashMap).</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="333" href="#333">333</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>}) |
| <a name="334" href="#334">334</a> <strong class="jxr_keyword">protected</strong> Map<Object, Object> childValue(Map<Object, Object> parentValue) { |
| <a name="335" href="#335">335</a> <strong class="jxr_keyword">if</strong> (parentValue != <strong class="jxr_keyword">null</strong>) { |
| <a name="336" href="#336">336</a> <strong class="jxr_keyword">return</strong> (Map<Object, Object>) ((HashMap<Object, Object>) parentValue).clone(); |
| <a name="337" href="#337">337</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="338" href="#338">338</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="339" href="#339">339</a> } |
| <a name="340" href="#340">340</a> } |
| <a name="341" href="#341">341</a> } |
| <a name="342" href="#342">342</a> } |
| <a name="343" href="#343">343</a> |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
