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