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