| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.util;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.mgt.SecurityManager;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">025</span><a id="line.25"></a> |
| <span class="sourceLineNo">026</span><a id="line.26">import java.util.Collections;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.HashMap;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import java.util.Map;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">/**</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * A ThreadContext provides a means of binding and unbinding objects to the</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * current thread based on key/value pairs.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <p/></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p>An internal {@link java.util.HashMap} is used to maintain the key/value pairs</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * for each thread.</p></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * <p/></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * <p>If the desired behavior is to ensure that bound data is not shared across</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * threads in a pooled or reusable threaded environment, the application (or more likely a framework) must</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * bind and remove any necessary values at the beginning and end of stack</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * execution, respectively (i.e. individually explicitly or all via the <tt>clear</tt> method).</p></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @see #remove()</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @since 0.1</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> */</a> |
| <span class="sourceLineNo">046</span><a id="line.46">public abstract class ThreadContext {</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> /**</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * Private internal log instance.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> private static final Logger log = LoggerFactory.getLogger(ThreadContext.class);</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> public static final String SECURITY_MANAGER_KEY = ThreadContext.class.getName() + "_SECURITY_MANAGER_KEY";</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> public static final String SUBJECT_KEY = ThreadContext.class.getName() + "_SUBJECT_KEY";</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> private static final ThreadLocal<Map<Object, Object>> resources = new InheritableThreadLocalMap<Map<Object, Object>>();</a> |
| <span class="sourceLineNo">057</span><a id="line.57"></a> |
| <span class="sourceLineNo">058</span><a id="line.58"> /**</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * Default no-argument constructor.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> protected ThreadContext() {</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> }</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> /**</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Returns the ThreadLocal Map. This Map is used internally to bind objects</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * to the current thread by storing each object under a unique key.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> *</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @return the map of bound resources</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> */</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> public static Map<Object, Object> getResources() {</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> if (resources.get() == null){</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> return Collections.emptyMap();</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> } else {</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> return new HashMap<Object, Object>(resources.get());</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> }</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> }</a> |
| <span class="sourceLineNo">077</span><a id="line.77"></a> |
| <span class="sourceLineNo">078</span><a id="line.78"> /**</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * Allows a caller to explicitly set the entire resource map. This operation overwrites everything that existed</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * previously in the ThreadContext - if you need to retain what was on the thread prior to calling this method,</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * call the {@link #getResources()} method, which will give you the existing state.</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> *</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * @param newResources the resources to replace the existing {@link #getResources() resources}.</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * @since 1.0</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> public static void setResources(Map<Object, Object> newResources) {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> if (CollectionUtils.isEmpty(newResources)) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> return;</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> ensureResourcesInitialized();</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> resources.get().clear();</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> resources.get().putAll(newResources);</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> }</a> |
| <span class="sourceLineNo">094</span><a id="line.94"></a> |
| <span class="sourceLineNo">095</span><a id="line.95"> /**</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * Returns the value bound in the {@code ThreadContext} under the specified {@code key}, or {@code null} if there</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * is no value for that {@code key}.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> *</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @param key the map key to use to lookup the value</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @return the value bound in the {@code ThreadContext} under the specified {@code key}, or {@code null} if there</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * is no value for that {@code key}.</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * @since 1.0</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> */</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> private static Object getValue(Object key) {</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> Map<Object, Object> perThreadResources = resources.get();</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> return perThreadResources != null ? perThreadResources.get(key) : null;</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> }</a> |
| <span class="sourceLineNo">108</span><a id="line.108"></a> |
| <span class="sourceLineNo">109</span><a id="line.109"> private static void ensureResourcesInitialized(){</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> if (resources.get() == null){</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> resources.set(new HashMap<Object, Object>());</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> }</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> }</a> |
| <span class="sourceLineNo">114</span><a id="line.114"></a> |
| <span class="sourceLineNo">115</span><a id="line.115"> /**</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * Returns the object for the specified <code>key</code> that is bound to</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * the current thread.</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> *</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @param key the key that identifies the value to return</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @return the object keyed by <code>key</code> or <code>null</code> if</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * no value exists for the specified <code>key</code></a> |
| <span class="sourceLineNo">122</span><a id="line.122"> */</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> public static Object get(Object key) {</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> String msg = "get() - in thread [" + Thread.currentThread().getName() + "]";</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> log.trace(msg);</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> }</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> Object value = getValue(key);</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> if ((value != null) && log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> String msg = "Retrieved value of type [" + value.getClass().getName() + "] for key [" +</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> key + "] " + "bound to thread [" + Thread.currentThread().getName() + "]";</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> log.trace(msg);</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> }</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> return value;</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> }</a> |
| <span class="sourceLineNo">137</span><a id="line.137"></a> |
| <span class="sourceLineNo">138</span><a id="line.138"> /**</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * Binds <tt>value</tt> for the given <code>key</code> to the current thread.</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * <p/></a> |
| <span class="sourceLineNo">141</span><a id="line.141"> * <p>A <tt>null</tt> <tt>value</tt> has the same effect as if <tt>remove</tt> was called for the given</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * <tt>key</tt>, i.e.:</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * <p/></a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * <pre></a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * if ( value == null ) {</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * remove( key );</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * }</pre></a> |
| <span class="sourceLineNo">148</span><a id="line.148"> *</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * @param key The key with which to identify the <code>value</code>.</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * @param value The value to bind to the thread.</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @throws IllegalArgumentException if the <code>key</code> argument is <tt>null</tt>.</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> */</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> public static void put(Object key, Object value) {</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> if (key == null) {</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> throw new IllegalArgumentException("key cannot be null");</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> }</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> if (value == null) {</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> remove(key);</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> return;</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> }</a> |
| <span class="sourceLineNo">162</span><a id="line.162"></a> |
| <span class="sourceLineNo">163</span><a id="line.163"> ensureResourcesInitialized();</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> resources.get().put(key, value);</a> |
| <span class="sourceLineNo">165</span><a id="line.165"></a> |
| <span class="sourceLineNo">166</span><a id="line.166"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> String msg = "Bound value of type [" + value.getClass().getName() + "] for key [" +</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> key + "] to thread " + "[" + Thread.currentThread().getName() + "]";</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> log.trace(msg);</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> }</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> }</a> |
| <span class="sourceLineNo">172</span><a id="line.172"></a> |
| <span class="sourceLineNo">173</span><a id="line.173"> /**</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * Unbinds the value for the given <code>key</code> from the current</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * thread.</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> *</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> * @param key The key identifying the value bound to the current thread.</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @return the object unbound or <tt>null</tt> if there was nothing bound</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * under the specified <tt>key</tt> name.</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> */</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> public static Object remove(Object key) {</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> Map<Object, Object> perThreadResources = resources.get();</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> Object value = perThreadResources != null ? perThreadResources.remove(key) : null;</a> |
| <span class="sourceLineNo">184</span><a id="line.184"></a> |
| <span class="sourceLineNo">185</span><a id="line.185"> if ((value != null) && log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> String msg = "Removed value of type [" + value.getClass().getName() + "] for key [" +</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> key + "]" + "from thread [" + Thread.currentThread().getName() + "]";</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> log.trace(msg);</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> }</a> |
| <span class="sourceLineNo">190</span><a id="line.190"></a> |
| <span class="sourceLineNo">191</span><a id="line.191"> return value;</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> }</a> |
| <span class="sourceLineNo">193</span><a id="line.193"></a> |
| <span class="sourceLineNo">194</span><a id="line.194"> /**</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> * {@link ThreadLocal#remove Remove}s the underlying {@link ThreadLocal ThreadLocal} from the thread.</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * <p/></a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * This method is meant to be the final 'clean up' operation that is called at the end of thread execution to</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * prevent thread corruption in pooled thread environments.</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> *</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * @since 1.0</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> */</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> public static void remove() {</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> resources.remove();</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> }</a> |
| <span class="sourceLineNo">205</span><a id="line.205"></a> |
| <span class="sourceLineNo">206</span><a id="line.206"> /**</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> * Convenience method that simplifies retrieval of the application's SecurityManager instance from the current</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> * thread. If there is no SecurityManager bound to the thread (probably because framework code did not bind it</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> * to the thread), this method returns <tt>null</tt>.</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> * <p/></a> |
| <span class="sourceLineNo">211</span><a id="line.211"> * It is merely a convenient wrapper for the following:</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> * <p/></a> |
| <span class="sourceLineNo">213</span><a id="line.213"> * <code>return (SecurityManager)get( SECURITY_MANAGER_KEY );</code></a> |
| <span class="sourceLineNo">214</span><a id="line.214"> * <p/></a> |
| <span class="sourceLineNo">215</span><a id="line.215"> * This method only returns the bound value if it exists - it does not remove it</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> * from the thread. To remove it, one must call {@link #unbindSecurityManager() unbindSecurityManager()} instead.</a> |
| <span class="sourceLineNo">217</span><a id="line.217"> *</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> * @return the Subject object bound to the thread, or <tt>null</tt> if there isn't one bound.</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> * @since 0.9</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> */</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> public static SecurityManager getSecurityManager() {</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> return (SecurityManager) get(SECURITY_MANAGER_KEY);</a> |
| <span class="sourceLineNo">223</span><a id="line.223"> }</a> |
| <span class="sourceLineNo">224</span><a id="line.224"></a> |
| <span class="sourceLineNo">225</span><a id="line.225"></a> |
| <span class="sourceLineNo">226</span><a id="line.226"> /**</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * Convenience method that simplifies binding the application's SecurityManager instance to the ThreadContext.</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> * <p/></a> |
| <span class="sourceLineNo">229</span><a id="line.229"> * <p>The method's existence is to help reduce casting in code and to simplify remembering of</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> * ThreadContext key names. The implementation is simple in that, if the SecurityManager is not <tt>null</tt>,</a> |
| <span class="sourceLineNo">231</span><a id="line.231"> * it binds it to the thread, i.e.:</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> * <p/></a> |
| <span class="sourceLineNo">233</span><a id="line.233"> * <pre></a> |
| <span class="sourceLineNo">234</span><a id="line.234"> * if (securityManager != null) {</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> * put( SECURITY_MANAGER_KEY, securityManager);</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> * }</pre></a> |
| <span class="sourceLineNo">237</span><a id="line.237"> *</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> * @param securityManager the application's SecurityManager instance to bind to the thread. If the argument is</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> * null, nothing will be done.</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> * @since 0.9</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> */</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> public static void bind(SecurityManager securityManager) {</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> if (securityManager != null) {</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> put(SECURITY_MANAGER_KEY, securityManager);</a> |
| <span class="sourceLineNo">245</span><a id="line.245"> }</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> }</a> |
| <span class="sourceLineNo">247</span><a id="line.247"></a> |
| <span class="sourceLineNo">248</span><a id="line.248"> /**</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> * Convenience method that simplifies removal of the application's SecurityManager instance from the thread.</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> * <p/></a> |
| <span class="sourceLineNo">251</span><a id="line.251"> * The implementation just helps reduce casting and remembering of the ThreadContext key name, i.e it is</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> * merely a convenient wrapper for the following:</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> * <p/></a> |
| <span class="sourceLineNo">254</span><a id="line.254"> * <code>return (SecurityManager)remove( SECURITY_MANAGER_KEY );</code></a> |
| <span class="sourceLineNo">255</span><a id="line.255"> * <p/></a> |
| <span class="sourceLineNo">256</span><a id="line.256"> * If you wish to just retrieve the object from the thread without removing it (so it can be retrieved later</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> * during thread execution), use the {@link #getSecurityManager() getSecurityManager()} method instead.</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> *</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> * @return the application's SecurityManager instance previously bound to the thread, or <tt>null</tt> if there</a> |
| <span class="sourceLineNo">260</span><a id="line.260"> * was none bound.</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> * @since 0.9</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> */</a> |
| <span class="sourceLineNo">263</span><a id="line.263"> public static SecurityManager unbindSecurityManager() {</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> return (SecurityManager) remove(SECURITY_MANAGER_KEY);</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> }</a> |
| <span class="sourceLineNo">266</span><a id="line.266"></a> |
| <span class="sourceLineNo">267</span><a id="line.267"> /**</a> |
| <span class="sourceLineNo">268</span><a id="line.268"> * Convenience method that simplifies retrieval of a thread-bound Subject. If there is no</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> * Subject bound to the thread, this method returns <tt>null</tt>. It is merely a convenient wrapper</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> * for the following:</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> * <p/></a> |
| <span class="sourceLineNo">272</span><a id="line.272"> * <code>return (Subject)get( SUBJECT_KEY );</code></a> |
| <span class="sourceLineNo">273</span><a id="line.273"> * <p/></a> |
| <span class="sourceLineNo">274</span><a id="line.274"> * This method only returns the bound value if it exists - it does not remove it</a> |
| <span class="sourceLineNo">275</span><a id="line.275"> * from the thread. To remove it, one must call {@link #unbindSubject() unbindSubject()} instead.</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> *</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> * @return the Subject object bound to the thread, or <tt>null</tt> if there isn't one bound.</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> * @since 0.2</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> */</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> public static Subject getSubject() {</a> |
| <span class="sourceLineNo">281</span><a id="line.281"> return (Subject) get(SUBJECT_KEY);</a> |
| <span class="sourceLineNo">282</span><a id="line.282"> }</a> |
| <span class="sourceLineNo">283</span><a id="line.283"></a> |
| <span class="sourceLineNo">284</span><a id="line.284"></a> |
| <span class="sourceLineNo">285</span><a id="line.285"> /**</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> * Convenience method that simplifies binding a Subject to the ThreadContext.</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> * <p/></a> |
| <span class="sourceLineNo">288</span><a id="line.288"> * <p>The method's existence is to help reduce casting in your own code and to simplify remembering of</a> |
| <span class="sourceLineNo">289</span><a id="line.289"> * ThreadContext key names. The implementation is simple in that, if the Subject is not <tt>null</tt>,</a> |
| <span class="sourceLineNo">290</span><a id="line.290"> * it binds it to the thread, i.e.:</a> |
| <span class="sourceLineNo">291</span><a id="line.291"> * <p/></a> |
| <span class="sourceLineNo">292</span><a id="line.292"> * <pre></a> |
| <span class="sourceLineNo">293</span><a id="line.293"> * if (subject != null) {</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> * put( SUBJECT_KEY, subject );</a> |
| <span class="sourceLineNo">295</span><a id="line.295"> * }</pre></a> |
| <span class="sourceLineNo">296</span><a id="line.296"> *</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> * @param subject the Subject object to bind to the thread. If the argument is null, nothing will be done.</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> * @since 0.2</a> |
| <span class="sourceLineNo">299</span><a id="line.299"> */</a> |
| <span class="sourceLineNo">300</span><a id="line.300"> public static void bind(Subject subject) {</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> if (subject != null) {</a> |
| <span class="sourceLineNo">302</span><a id="line.302"> put(SUBJECT_KEY, subject);</a> |
| <span class="sourceLineNo">303</span><a id="line.303"> }</a> |
| <span class="sourceLineNo">304</span><a id="line.304"> }</a> |
| <span class="sourceLineNo">305</span><a id="line.305"></a> |
| <span class="sourceLineNo">306</span><a id="line.306"> /**</a> |
| <span class="sourceLineNo">307</span><a id="line.307"> * Convenience method that simplifies removal of a thread-local Subject from the thread.</a> |
| <span class="sourceLineNo">308</span><a id="line.308"> * <p/></a> |
| <span class="sourceLineNo">309</span><a id="line.309"> * The implementation just helps reduce casting and remembering of the ThreadContext key name, i.e it is</a> |
| <span class="sourceLineNo">310</span><a id="line.310"> * merely a convenient wrapper for the following:</a> |
| <span class="sourceLineNo">311</span><a id="line.311"> * <p/></a> |
| <span class="sourceLineNo">312</span><a id="line.312"> * <code>return (Subject)remove( SUBJECT_KEY );</code></a> |
| <span class="sourceLineNo">313</span><a id="line.313"> * <p/></a> |
| <span class="sourceLineNo">314</span><a id="line.314"> * If you wish to just retrieve the object from the thread without removing it (so it can be retrieved later during</a> |
| <span class="sourceLineNo">315</span><a id="line.315"> * thread execution), you should use the {@link #getSubject() getSubject()} method for that purpose.</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> *</a> |
| <span class="sourceLineNo">317</span><a id="line.317"> * @return the Subject object previously bound to the thread, or <tt>null</tt> if there was none bound.</a> |
| <span class="sourceLineNo">318</span><a id="line.318"> * @since 0.2</a> |
| <span class="sourceLineNo">319</span><a id="line.319"> */</a> |
| <span class="sourceLineNo">320</span><a id="line.320"> public static Subject unbindSubject() {</a> |
| <span class="sourceLineNo">321</span><a id="line.321"> return (Subject) remove(SUBJECT_KEY);</a> |
| <span class="sourceLineNo">322</span><a id="line.322"> }</a> |
| <span class="sourceLineNo">323</span><a id="line.323"> </a> |
| <span class="sourceLineNo">324</span><a id="line.324"> private static final class InheritableThreadLocalMap<T extends Map<Object, Object>> extends InheritableThreadLocal<Map<Object, Object>> {</a> |
| <span class="sourceLineNo">325</span><a id="line.325"></a> |
| <span class="sourceLineNo">326</span><a id="line.326"> /**</a> |
| <span class="sourceLineNo">327</span><a id="line.327"> * This implementation was added to address a</a> |
| <span class="sourceLineNo">328</span><a id="line.328"> * <a href="http://jsecurity.markmail.org/search/?q=#query:+page:1+mid:xqi2yxurwmrpqrvj+state:results"></a> |
| <span class="sourceLineNo">329</span><a id="line.329"> * user-reported issue</a>.</a> |
| <span class="sourceLineNo">330</span><a id="line.330"> * @param parentValue the parent value, a HashMap as defined in the {@link #initialValue()} method.</a> |
| <span class="sourceLineNo">331</span><a id="line.331"> * @return the HashMap to be used by any parent-spawned child threads (a clone of the parent HashMap).</a> |
| <span class="sourceLineNo">332</span><a id="line.332"> */</a> |
| <span class="sourceLineNo">333</span><a id="line.333"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">334</span><a id="line.334"> protected Map<Object, Object> childValue(Map<Object, Object> parentValue) {</a> |
| <span class="sourceLineNo">335</span><a id="line.335"> if (parentValue != null) {</a> |
| <span class="sourceLineNo">336</span><a id="line.336"> return (Map<Object, Object>) ((HashMap<Object, Object>) parentValue).clone();</a> |
| <span class="sourceLineNo">337</span><a id="line.337"> } else {</a> |
| <span class="sourceLineNo">338</span><a id="line.338"> return null;</a> |
| <span class="sourceLineNo">339</span><a id="line.339"> }</a> |
| <span class="sourceLineNo">340</span><a id="line.340"> }</a> |
| <span class="sourceLineNo">341</span><a id="line.341"> }</a> |
| <span class="sourceLineNo">342</span><a id="line.342">}</a> |
| <span class="sourceLineNo">343</span><a id="line.343"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
