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