| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.subject.support;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.subject.Subject;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.util.ThreadContext;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.util.ThreadState;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import java.util.Map;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> /**<a name="line.29"></a> |
| <FONT color="green">030</FONT> * Manages thread-state for {@link Subject Subject} access (supporting<a name="line.30"></a> |
| <FONT color="green">031</FONT> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls)<a name="line.31"></a> |
| <FONT color="green">032</FONT> * during a thread's execution.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <p/><a name="line.33"></a> |
| <FONT color="green">034</FONT> * The {@link #bind bind} method will bind a {@link Subject} and a<a name="line.34"></a> |
| <FONT color="green">035</FONT> * {@link org.apache.shiro.mgt.SecurityManager SecurityManager} to the {@link ThreadContext} so they can be retrieved<a name="line.35"></a> |
| <FONT color="green">036</FONT> * from the {@code ThreadContext} later by any<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls that might occur during<a name="line.37"></a> |
| <FONT color="green">038</FONT> * the thread's execution.<a name="line.38"></a> |
| <FONT color="green">039</FONT> *<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 1.0<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public class SubjectThreadState implements ThreadState {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> private Map<Object, Object> originalResources;<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> private final Subject subject;<a name="line.46"></a> |
| <FONT color="green">047</FONT> private transient SecurityManager securityManager;<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> /**<a name="line.49"></a> |
| <FONT color="green">050</FONT> * Creates a new {@code SubjectThreadState} that will bind and unbind the specified {@code Subject} to the<a name="line.50"></a> |
| <FONT color="green">051</FONT> * thread<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @param subject the {@code Subject} instance to bind and unbind from the {@link ThreadContext}.<a name="line.53"></a> |
| <FONT color="green">054</FONT> */<a name="line.54"></a> |
| <FONT color="green">055</FONT> public SubjectThreadState(Subject subject) {<a name="line.55"></a> |
| <FONT color="green">056</FONT> if (subject == null) {<a name="line.56"></a> |
| <FONT color="green">057</FONT> throw new IllegalArgumentException("Subject argument cannot be null.");<a name="line.57"></a> |
| <FONT color="green">058</FONT> }<a name="line.58"></a> |
| <FONT color="green">059</FONT> this.subject = subject;<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> SecurityManager securityManager = null;<a name="line.61"></a> |
| <FONT color="green">062</FONT> if ( subject instanceof DelegatingSubject) {<a name="line.62"></a> |
| <FONT color="green">063</FONT> securityManager = ((DelegatingSubject)subject).getSecurityManager();<a name="line.63"></a> |
| <FONT color="green">064</FONT> }<a name="line.64"></a> |
| <FONT color="green">065</FONT> if ( securityManager == null) {<a name="line.65"></a> |
| <FONT color="green">066</FONT> securityManager = ThreadContext.getSecurityManager();<a name="line.66"></a> |
| <FONT color="green">067</FONT> }<a name="line.67"></a> |
| <FONT color="green">068</FONT> this.securityManager = securityManager;<a name="line.68"></a> |
| <FONT color="green">069</FONT> }<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> /**<a name="line.71"></a> |
| <FONT color="green">072</FONT> * Returns the {@code Subject} instance managed by this {@code ThreadState} implementation.<a name="line.72"></a> |
| <FONT color="green">073</FONT> *<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @return the {@code Subject} instance managed by this {@code ThreadState} implementation.<a name="line.74"></a> |
| <FONT color="green">075</FONT> */<a name="line.75"></a> |
| <FONT color="green">076</FONT> protected Subject getSubject() {<a name="line.76"></a> |
| <FONT color="green">077</FONT> return this.subject;<a name="line.77"></a> |
| <FONT color="green">078</FONT> }<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> /**<a name="line.80"></a> |
| <FONT color="green">081</FONT> * Binds a {@link Subject} and {@link org.apache.shiro.mgt.SecurityManager SecurityManager} to the<a name="line.81"></a> |
| <FONT color="green">082</FONT> * {@link ThreadContext} so they can be retrieved later by any<a name="line.82"></a> |
| <FONT color="green">083</FONT> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls that might occur<a name="line.83"></a> |
| <FONT color="green">084</FONT> * during the thread's execution.<a name="line.84"></a> |
| <FONT color="green">085</FONT> * <p/><a name="line.85"></a> |
| <FONT color="green">086</FONT> * Prior to binding, the {@code ThreadContext}'s existing {@link ThreadContext#getResources() resources} are<a name="line.86"></a> |
| <FONT color="green">087</FONT> * retained so they can be restored later via the {@link #restore restore} call.<a name="line.87"></a> |
| <FONT color="green">088</FONT> */<a name="line.88"></a> |
| <FONT color="green">089</FONT> public void bind() {<a name="line.89"></a> |
| <FONT color="green">090</FONT> SecurityManager securityManager = this.securityManager;<a name="line.90"></a> |
| <FONT color="green">091</FONT> if ( securityManager == null ) {<a name="line.91"></a> |
| <FONT color="green">092</FONT> //try just in case the constructor didn't find one at the time:<a name="line.92"></a> |
| <FONT color="green">093</FONT> securityManager = ThreadContext.getSecurityManager();<a name="line.93"></a> |
| <FONT color="green">094</FONT> }<a name="line.94"></a> |
| <FONT color="green">095</FONT> this.originalResources = ThreadContext.getResources();<a name="line.95"></a> |
| <FONT color="green">096</FONT> ThreadContext.remove();<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> ThreadContext.bind(this.subject);<a name="line.98"></a> |
| <FONT color="green">099</FONT> if (securityManager != null) {<a name="line.99"></a> |
| <FONT color="green">100</FONT> ThreadContext.bind(securityManager);<a name="line.100"></a> |
| <FONT color="green">101</FONT> }<a name="line.101"></a> |
| <FONT color="green">102</FONT> }<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> /**<a name="line.104"></a> |
| <FONT color="green">105</FONT> * {@link ThreadContext#remove Remove}s all thread-state that was bound by this instance. If any previous<a name="line.105"></a> |
| <FONT color="green">106</FONT> * thread-bound resources existed prior to the {@link #bind bind} call, they are restored back to the<a name="line.106"></a> |
| <FONT color="green">107</FONT> * {@code ThreadContext} to ensure the thread state is exactly as it was before binding.<a name="line.107"></a> |
| <FONT color="green">108</FONT> */<a name="line.108"></a> |
| <FONT color="green">109</FONT> public void restore() {<a name="line.109"></a> |
| <FONT color="green">110</FONT> ThreadContext.remove();<a name="line.110"></a> |
| <FONT color="green">111</FONT> if (!CollectionUtils.isEmpty(this.originalResources)) {<a name="line.111"></a> |
| <FONT color="green">112</FONT> ThreadContext.setResources(this.originalResources);<a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> <a name="line.115"></a> |
| <FONT color="green">116</FONT> /**<a name="line.116"></a> |
| <FONT color="green">117</FONT> * Completely {@link ThreadContext#remove removes} the {@code ThreadContext} state. Typically this method should<a name="line.117"></a> |
| <FONT color="green">118</FONT> * only be called in special cases - it is more 'correct' to {@link #restore restore} a thread to its previous<a name="line.118"></a> |
| <FONT color="green">119</FONT> * state than to clear it entirely.<a name="line.119"></a> |
| <FONT color="green">120</FONT> */<a name="line.120"></a> |
| <FONT color="green">121</FONT> public void clear() {<a name="line.121"></a> |
| <FONT color="green">122</FONT> ThreadContext.remove();<a name="line.122"></a> |
| <FONT color="green">123</FONT> }<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
