| <!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.subject.support;</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.apache.shiro.util.CollectionUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.util.ThreadContext;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.util.ThreadState;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.Map;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">/**</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * Manages thread-state for {@link Subject Subject} access (supporting</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls)</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * during a thread's execution.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <p/></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * The {@link #bind bind} method will bind a {@link Subject} and a</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * {@link org.apache.shiro.mgt.SecurityManager SecurityManager} to the {@link ThreadContext} so they can be retrieved</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * from the {@code ThreadContext} later by any</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls that might occur during</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * the thread's execution.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> *</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * @since 1.0</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> */</a> |
| <span class="sourceLineNo">042</span><a id="line.42">public class SubjectThreadState implements ThreadState {</a> |
| <span class="sourceLineNo">043</span><a id="line.43"></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> private Map<Object, Object> originalResources;</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> private final Subject subject;</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private transient SecurityManager securityManager;</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * Creates a new {@code SubjectThreadState} that will bind and unbind the specified {@code Subject} to the</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * thread</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> *</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param subject the {@code Subject} instance to bind and unbind from the {@link ThreadContext}.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> */</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> public SubjectThreadState(Subject subject) {</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> if (subject == null) {</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> throw new IllegalArgumentException("Subject argument cannot be null.");</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> }</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> this.subject = subject;</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> SecurityManager securityManager = null;</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> if ( subject instanceof DelegatingSubject) {</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> securityManager = ((DelegatingSubject)subject).getSecurityManager();</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> }</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> if ( securityManager == null) {</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> securityManager = ThreadContext.getSecurityManager();</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> }</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> this.securityManager = securityManager;</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> /**</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * Returns the {@code Subject} instance managed by this {@code ThreadState} implementation.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> *</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @return the {@code Subject} instance managed by this {@code ThreadState} implementation.</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> */</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> protected Subject getSubject() {</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> return this.subject;</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> }</a> |
| <span class="sourceLineNo">079</span><a id="line.79"></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> /**</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * Binds a {@link Subject} and {@link org.apache.shiro.mgt.SecurityManager SecurityManager} to the</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * {@link ThreadContext} so they can be retrieved later by any</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} calls that might occur</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * during the thread's execution.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * <p/></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * Prior to binding, the {@code ThreadContext}'s existing {@link ThreadContext#getResources() resources} are</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * retained so they can be restored later via the {@link #restore restore} call.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> */</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> public void bind() {</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> SecurityManager securityManager = this.securityManager;</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> if ( securityManager == null ) {</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> //try just in case the constructor didn't find one at the time:</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> securityManager = ThreadContext.getSecurityManager();</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> }</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> this.originalResources = ThreadContext.getResources();</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> ThreadContext.remove();</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> ThreadContext.bind(this.subject);</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> if (securityManager != null) {</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> ThreadContext.bind(securityManager);</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> }</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> }</a> |
| <span class="sourceLineNo">103</span><a id="line.103"></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> /**</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * {@link ThreadContext#remove Remove}s all thread-state that was bound by this instance. If any previous</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * thread-bound resources existed prior to the {@link #bind bind} call, they are restored back to the</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * {@code ThreadContext} to ensure the thread state is exactly as it was before binding.</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> */</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> public void restore() {</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> ThreadContext.remove();</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> if (!CollectionUtils.isEmpty(this.originalResources)) {</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> ThreadContext.setResources(this.originalResources);</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"> /**</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * Completely {@link ThreadContext#remove removes} the {@code ThreadContext} state. Typically this method should</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * only be called in special cases - it is more 'correct' to {@link #restore restore} a thread to its previous</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * state than to clear it entirely.</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> */</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> public void clear() {</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> ThreadContext.remove();</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> }</a> |
| <span class="sourceLineNo">124</span><a id="line.124">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
