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