| <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.subject.Subject;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.util.ThreadState;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> /**<a name="line.24"></a> |
| <FONT color="green">025</FONT> * A {@code SubjectRunnable} ensures that a target/delegate {@link Runnable Runnable} will execute such that any<a name="line.25"></a> |
| <FONT color="green">026</FONT> * call to {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()} during the<a name="line.26"></a> |
| <FONT color="green">027</FONT> * {@code Runnable}'s execution will return the associated {@code Subject} instance. The {@code SubjectRunnable}<a name="line.27"></a> |
| <FONT color="green">028</FONT> * instance can be run on any thread (the current thread or asynchronously on another thread) and the<a name="line.28"></a> |
| <FONT color="green">029</FONT> * {@code SecurityUtils.getSubject()} call will still work properly. This implementation also guarantees that Shiro's<a name="line.29"></a> |
| <FONT color="green">030</FONT> * thread state will be identical before and after execution to ensure threads remain clean in any thread-pooled<a name="line.30"></a> |
| <FONT color="green">031</FONT> * environment.<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p/><a name="line.32"></a> |
| <FONT color="green">033</FONT> * When instances of this class {@link Runnable#run() run()}, the following occurs:<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <ol><a name="line.34"></a> |
| <FONT color="green">035</FONT> * <li>The Subject and any of its associated thread state is first bound to the thread that executes the<a name="line.35"></a> |
| <FONT color="green">036</FONT> * {@code Runnable}.</li><a name="line.36"></a> |
| <FONT color="green">037</FONT> * <li>The delegate/target {@code Runnable} is {@link #doRun(Runnable) run}</li><a name="line.37"></a> |
| <FONT color="green">038</FONT> * <li>Any previous thread state that might have existed before the {@code Subject} was bound is fully restored</li><a name="line.38"></a> |
| <FONT color="green">039</FONT> * </ol><a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p/><a name="line.40"></a> |
| <FONT color="green">041</FONT> *<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <h3>Usage</h3><a name="line.42"></a> |
| <FONT color="green">043</FONT> *<a name="line.43"></a> |
| <FONT color="green">044</FONT> * This is typically considered a support class and is not often directly referenced. Most people prefer to use<a name="line.44"></a> |
| <FONT color="green">045</FONT> * the {@code Subject.}{@link Subject#execute(Runnable) execute} or<a name="line.45"></a> |
| <FONT color="green">046</FONT> * {@code Subject.}{@link Subject#associateWith(Runnable) associateWith} methods, which transparently perform the<a name="line.46"></a> |
| <FONT color="green">047</FONT> * necessary association logic.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p/><a name="line.48"></a> |
| <FONT color="green">049</FONT> * An even more convenient alternative is to use a<a name="line.49"></a> |
| <FONT color="green">050</FONT> * {@link org.apache.shiro.concurrent.SubjectAwareExecutor SubjectAwareExecutor}, which transparently uses<a name="line.50"></a> |
| <FONT color="green">051</FONT> * instances of this class but does not require referencing Shiro's API at all.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @see Subject#associateWith(Runnable)<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @see org.apache.shiro.concurrent.SubjectAwareExecutor SubjectAwareExecutor<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @since 1.0<a name="line.55"></a> |
| <FONT color="green">056</FONT> */<a name="line.56"></a> |
| <FONT color="green">057</FONT> public class SubjectRunnable implements Runnable {<a name="line.57"></a> |
| <FONT color="green">058</FONT> <a name="line.58"></a> |
| <FONT color="green">059</FONT> protected final ThreadState threadState;<a name="line.59"></a> |
| <FONT color="green">060</FONT> private final Runnable runnable;<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> /**<a name="line.62"></a> |
| <FONT color="green">063</FONT> * Creates a new {@code SubjectRunnable} that, when executed, will execute the target {@code delegate}, but<a name="line.63"></a> |
| <FONT color="green">064</FONT> * guarantees that it will run associated with the specified {@code Subject}.<a name="line.64"></a> |
| <FONT color="green">065</FONT> *<a name="line.65"></a> |
| <FONT color="green">066</FONT> * @param subject the Subject to associate with the delegate's execution.<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param delegate the runnable to run.<a name="line.67"></a> |
| <FONT color="green">068</FONT> */<a name="line.68"></a> |
| <FONT color="green">069</FONT> public SubjectRunnable(Subject subject, Runnable delegate) {<a name="line.69"></a> |
| <FONT color="green">070</FONT> this(new SubjectThreadState(subject), delegate);<a name="line.70"></a> |
| <FONT color="green">071</FONT> }<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> /**<a name="line.73"></a> |
| <FONT color="green">074</FONT> * Creates a new {@code SubjectRunnable} that, when executed, will perform thread state<a name="line.74"></a> |
| <FONT color="green">075</FONT> * {@link ThreadState#bind binding} and guaranteed {@link ThreadState#restore restoration} before and after the<a name="line.75"></a> |
| <FONT color="green">076</FONT> * {@link Runnable Runnable}'s execution, respectively.<a name="line.76"></a> |
| <FONT color="green">077</FONT> *<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param threadState the thread state to bind and unbind before and after the runnable's execution.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * @param delegate the delegate {@code Runnable} to execute when this instance is {@link #run() run()}.<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @throws IllegalArgumentException if either the {@code ThreadState} or {@link Runnable} arguments are {@code null}.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> protected SubjectRunnable(ThreadState threadState, Runnable delegate) throws IllegalArgumentException {<a name="line.82"></a> |
| <FONT color="green">083</FONT> if (threadState == null) {<a name="line.83"></a> |
| <FONT color="green">084</FONT> throw new IllegalArgumentException("ThreadState argument cannot be null.");<a name="line.84"></a> |
| <FONT color="green">085</FONT> }<a name="line.85"></a> |
| <FONT color="green">086</FONT> this.threadState = threadState;<a name="line.86"></a> |
| <FONT color="green">087</FONT> if (delegate == null) {<a name="line.87"></a> |
| <FONT color="green">088</FONT> throw new IllegalArgumentException("Runnable argument cannot be null.");<a name="line.88"></a> |
| <FONT color="green">089</FONT> }<a name="line.89"></a> |
| <FONT color="green">090</FONT> this.runnable = delegate;<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> /**<a name="line.93"></a> |
| <FONT color="green">094</FONT> * {@link ThreadState#bind Bind}s the Subject thread state, executes the target {@code Runnable} and then guarantees<a name="line.94"></a> |
| <FONT color="green">095</FONT> * the previous thread state's {@link ThreadState#restore restoration}:<a name="line.95"></a> |
| <FONT color="green">096</FONT> * <pre><a name="line.96"></a> |
| <FONT color="green">097</FONT> * try {<a name="line.97"></a> |
| <FONT color="green">098</FONT> * threadState.{@link ThreadState#bind bind()};<a name="line.98"></a> |
| <FONT color="green">099</FONT> * {@link #doRun doRun}(targetRunnable);<a name="line.99"></a> |
| <FONT color="green">100</FONT> * } finally {<a name="line.100"></a> |
| <FONT color="green">101</FONT> * threadState.{@link ThreadState#restore restore()}<a name="line.101"></a> |
| <FONT color="green">102</FONT> * }<a name="line.102"></a> |
| <FONT color="green">103</FONT> * </pre><a name="line.103"></a> |
| <FONT color="green">104</FONT> */<a name="line.104"></a> |
| <FONT color="green">105</FONT> public void run() {<a name="line.105"></a> |
| <FONT color="green">106</FONT> try {<a name="line.106"></a> |
| <FONT color="green">107</FONT> threadState.bind();<a name="line.107"></a> |
| <FONT color="green">108</FONT> doRun(this.runnable);<a name="line.108"></a> |
| <FONT color="green">109</FONT> } finally {<a name="line.109"></a> |
| <FONT color="green">110</FONT> threadState.restore();<a name="line.110"></a> |
| <FONT color="green">111</FONT> }<a name="line.111"></a> |
| <FONT color="green">112</FONT> }<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> * Simply calls the target {@link Runnable Runnable}'s {@link Runnable#run run()} method.<a name="line.115"></a> |
| <FONT color="green">116</FONT> *<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @param runnable the target runnable to run.<a name="line.117"></a> |
| <FONT color="green">118</FONT> */<a name="line.118"></a> |
| <FONT color="green">119</FONT> protected void doRun(Runnable runnable) {<a name="line.119"></a> |
| <FONT color="green">120</FONT> runnable.run();<a name="line.120"></a> |
| <FONT color="green">121</FONT> }<a name="line.121"></a> |
| <FONT color="green">122</FONT> }<a name="line.122"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
