| <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> import java.util.concurrent.Callable;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> /**<a name="line.26"></a> |
| <FONT color="green">027</FONT> * A {@code SubjectCallable} associates a {@link Subject Subject} with a target/delegate<a name="line.27"></a> |
| <FONT color="green">028</FONT> * {@link Callable Callable} to ensure proper {@code Subject} thread-state management when the {@code Callable} executes.<a name="line.28"></a> |
| <FONT color="green">029</FONT> * This ensures that any calls to {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()}<a name="line.29"></a> |
| <FONT color="green">030</FONT> * during the target {@code Callable}'s execution still work correctly even if the {@code Callable} executes on a<a name="line.30"></a> |
| <FONT color="green">031</FONT> * different thread than the one that created it. This allows {@code Subject} access during asynchronous operations.<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 execute (typically via a {@link java.util.concurrent.ExecutorService ExecutorService}),<a name="line.33"></a> |
| <FONT color="green">034</FONT> * the following occurs:<a name="line.34"></a> |
| <FONT color="green">035</FONT> * <ol><a name="line.35"></a> |
| <FONT color="green">036</FONT> * <li>The specified Subject any of its associated thread state is first bound to the thread that executes the<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@code Callable}.</li><a name="line.37"></a> |
| <FONT color="green">038</FONT> * <li>The delegate/target {@code Callable} is {@link java.util.concurrent.Callable#call() executed}</li><a name="line.38"></a> |
| <FONT color="green">039</FONT> * <li>The previous thread state that might have existed before the {@code Subject} was bound is fully restored</li><a name="line.39"></a> |
| <FONT color="green">040</FONT> * </ol><a name="line.40"></a> |
| <FONT color="green">041</FONT> * <p/><a name="line.41"></a> |
| <FONT color="green">042</FONT> * This behavior ensures that the thread that executes this {@code Callable}, which is often a different thread than<a name="line.42"></a> |
| <FONT color="green">043</FONT> * the one that created the instance, retains a {@code Subject} to support {@code SecurityUtils.getSubject()}<a name="line.43"></a> |
| <FONT color="green">044</FONT> * invocations. It also guarantees that the running thread remains 'clean' in any thread-pooled environments.<a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <h3>Usage</h3><a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * This is typically considered a support class and is not often directly referenced. Most people prefer to use<a name="line.48"></a> |
| <FONT color="green">049</FONT> * the {@code Subject.}{@link Subject#associateWith(Callable) associateWith} method, which will automatically return<a name="line.49"></a> |
| <FONT color="green">050</FONT> * an instance of this class.<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <p/><a name="line.51"></a> |
| <FONT color="green">052</FONT> * An even more convenient alternative is to use a<a name="line.52"></a> |
| <FONT color="green">053</FONT> * {@link org.apache.shiro.concurrent.SubjectAwareExecutorService SubjectAwareExecutorService}, which<a name="line.53"></a> |
| <FONT color="green">054</FONT> * transparently uses instances of this class.<a name="line.54"></a> |
| <FONT color="green">055</FONT> *<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @see Subject#associateWith(Callable)<a name="line.56"></a> |
| <FONT color="green">057</FONT> * @see org.apache.shiro.concurrent.SubjectAwareExecutorService SubjectAwareExecutorService<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @since 1.0<a name="line.58"></a> |
| <FONT color="green">059</FONT> */<a name="line.59"></a> |
| <FONT color="green">060</FONT> public class SubjectCallable<V> implements Callable<V> {<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> protected final ThreadState threadState;<a name="line.62"></a> |
| <FONT color="green">063</FONT> private final Callable<V> callable;<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> public SubjectCallable(Subject subject, Callable<V> delegate) {<a name="line.65"></a> |
| <FONT color="green">066</FONT> this(new SubjectThreadState(subject), delegate);<a name="line.66"></a> |
| <FONT color="green">067</FONT> }<a name="line.67"></a> |
| <FONT color="green">068</FONT> <a name="line.68"></a> |
| <FONT color="green">069</FONT> protected SubjectCallable(ThreadState threadState, Callable<V> delegate) {<a name="line.69"></a> |
| <FONT color="green">070</FONT> if (threadState == null) {<a name="line.70"></a> |
| <FONT color="green">071</FONT> throw new IllegalArgumentException("ThreadState argument cannot be null.");<a name="line.71"></a> |
| <FONT color="green">072</FONT> }<a name="line.72"></a> |
| <FONT color="green">073</FONT> this.threadState = threadState;<a name="line.73"></a> |
| <FONT color="green">074</FONT> if (delegate == null) {<a name="line.74"></a> |
| <FONT color="green">075</FONT> throw new IllegalArgumentException("Callable delegate instance cannot be null.");<a name="line.75"></a> |
| <FONT color="green">076</FONT> }<a name="line.76"></a> |
| <FONT color="green">077</FONT> this.callable = delegate;<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> public V call() throws Exception {<a name="line.80"></a> |
| <FONT color="green">081</FONT> try {<a name="line.81"></a> |
| <FONT color="green">082</FONT> threadState.bind();<a name="line.82"></a> |
| <FONT color="green">083</FONT> return doCall(this.callable);<a name="line.83"></a> |
| <FONT color="green">084</FONT> } finally {<a name="line.84"></a> |
| <FONT color="green">085</FONT> threadState.restore();<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> }<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> protected V doCall(Callable<V> target) throws Exception {<a name="line.89"></a> |
| <FONT color="green">090</FONT> return target.call();<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
