| <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.concurrent;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.SecurityUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.subject.Subject;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.util.concurrent.Executor;<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> * {@code Executor} implementation that will automatically first associate any argument<a name="line.27"></a> |
| <FONT color="green">028</FONT> * {@link Runnable} instances with the currently available {@link Subject} and then<a name="line.28"></a> |
| <FONT color="green">029</FONT> * dispatch the Subject-enabled runnable to an underlying delegate {@link Executor}<a name="line.29"></a> |
| <FONT color="green">030</FONT> * instance.<a name="line.30"></a> |
| <FONT color="green">031</FONT> * <p/><a name="line.31"></a> |
| <FONT color="green">032</FONT> * This is a simplification for applications that want to execute code as the currently<a name="line.32"></a> |
| <FONT color="green">033</FONT> * executing {@code Subject} on another thread, but don't want or need to call the<a name="line.33"></a> |
| <FONT color="green">034</FONT> * {@link Subject#associateWith(Runnable)} method and dispatch to a Thread manually. This<a name="line.34"></a> |
| <FONT color="green">035</FONT> * simplifies code and reduces Shiro dependencies across application source code.<a name="line.35"></a> |
| <FONT color="green">036</FONT> * <p/><a name="line.36"></a> |
| <FONT color="green">037</FONT> * Consider this code that could be repeated in many places across an application:<a name="line.37"></a> |
| <FONT color="green">038</FONT> * <pre><a name="line.38"></a> |
| <FONT color="green">039</FONT> * {@link Runnable Runnable} applicationWork = //instantiate or acquire Runnable from somewhere<a name="line.39"></a> |
| <FONT color="green">040</FONT> * {@link Subject Subject} subject = {@link SecurityUtils SecurityUtils}.{@link SecurityUtils#getSubject() getSubject()};<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link Runnable Runnable} work = subject.{@link Subject#associateWith(Runnable) associateWith(applicationWork)};<a name="line.41"></a> |
| <FONT color="green">042</FONT> * {@link Executor anExecutor}.{@link Executor#execute(Runnable) execute(work)};<a name="line.42"></a> |
| <FONT color="green">043</FONT> * </pre><a name="line.43"></a> |
| <FONT color="green">044</FONT> * Instead, if the {@code Executor} instance used in application code is an instance of this class (which delegates<a name="line.44"></a> |
| <FONT color="green">045</FONT> * to the target Executor that you want), all places in code like the above reduce to this:<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <pre><a name="line.46"></a> |
| <FONT color="green">047</FONT> * {@link Runnable Runnable} applicationWork = //instantiate or acquire Runnable from somewhere<a name="line.47"></a> |
| <FONT color="green">048</FONT> * {@link Executor anExecutor}.{@link Executor#execute(Runnable) execute(work)};<a name="line.48"></a> |
| <FONT color="green">049</FONT> * </pre><a name="line.49"></a> |
| <FONT color="green">050</FONT> * Notice there is no use of the Shiro API in the 2nd code block, encouraging the principle of loose coupling across<a name="line.50"></a> |
| <FONT color="green">051</FONT> * your codebase.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @see SubjectAwareExecutorService<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @since 1.0<a name="line.54"></a> |
| <FONT color="green">055</FONT> */<a name="line.55"></a> |
| <FONT color="green">056</FONT> public class SubjectAwareExecutor implements Executor {<a name="line.56"></a> |
| <FONT color="green">057</FONT> <a name="line.57"></a> |
| <FONT color="green">058</FONT> /**<a name="line.58"></a> |
| <FONT color="green">059</FONT> * The target Executor instance that will actually execute the subject-associated Runnable instances.<a name="line.59"></a> |
| <FONT color="green">060</FONT> */<a name="line.60"></a> |
| <FONT color="green">061</FONT> private Executor targetExecutor;<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> public SubjectAwareExecutor() {<a name="line.63"></a> |
| <FONT color="green">064</FONT> }<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> public SubjectAwareExecutor(Executor targetExecutor) {<a name="line.66"></a> |
| <FONT color="green">067</FONT> if (targetExecutor == null) {<a name="line.67"></a> |
| <FONT color="green">068</FONT> throw new NullPointerException("target Executor instance cannot be null.");<a name="line.68"></a> |
| <FONT color="green">069</FONT> }<a name="line.69"></a> |
| <FONT color="green">070</FONT> this.targetExecutor = targetExecutor;<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> * Returns the target Executor instance that will actually execute the subject-associated Runnable instances.<a name="line.74"></a> |
| <FONT color="green">075</FONT> *<a name="line.75"></a> |
| <FONT color="green">076</FONT> * @return target Executor instance that will actually execute the subject-associated Runnable instances.<a name="line.76"></a> |
| <FONT color="green">077</FONT> */<a name="line.77"></a> |
| <FONT color="green">078</FONT> public Executor getTargetExecutor() {<a name="line.78"></a> |
| <FONT color="green">079</FONT> return targetExecutor;<a name="line.79"></a> |
| <FONT color="green">080</FONT> }<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> /**<a name="line.82"></a> |
| <FONT color="green">083</FONT> * Sets target Executor instance that will actually execute the subject-associated Runnable instances.<a name="line.83"></a> |
| <FONT color="green">084</FONT> *<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @param targetExecutor the target Executor instance that will actually execute the subject-associated Runnable<a name="line.85"></a> |
| <FONT color="green">086</FONT> * instances.<a name="line.86"></a> |
| <FONT color="green">087</FONT> */<a name="line.87"></a> |
| <FONT color="green">088</FONT> public void setTargetExecutor(Executor targetExecutor) {<a name="line.88"></a> |
| <FONT color="green">089</FONT> this.targetExecutor = targetExecutor;<a name="line.89"></a> |
| <FONT color="green">090</FONT> }<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> * Returns the currently Subject instance that should be associated with Runnable or Callable instances before<a name="line.93"></a> |
| <FONT color="green">094</FONT> * being dispatched to the target {@code Executor} instance. This implementation merely defaults to returning<a name="line.94"></a> |
| <FONT color="green">095</FONT> * {@code SecurityUtils}.{@link SecurityUtils#getSubject() getSubject()}.<a name="line.95"></a> |
| <FONT color="green">096</FONT> *<a name="line.96"></a> |
| <FONT color="green">097</FONT> * @return the currently Subject instance that should be associated with Runnable or Callable instances before<a name="line.97"></a> |
| <FONT color="green">098</FONT> * being dispatched to the target {@code Executor} instance.<a name="line.98"></a> |
| <FONT color="green">099</FONT> */<a name="line.99"></a> |
| <FONT color="green">100</FONT> protected Subject getSubject() {<a name="line.100"></a> |
| <FONT color="green">101</FONT> return SecurityUtils.getSubject();<a name="line.101"></a> |
| <FONT color="green">102</FONT> }<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> /**<a name="line.104"></a> |
| <FONT color="green">105</FONT> * Utility method for subclasses to associate the argument {@code Runnable} with the currently executing subject<a name="line.105"></a> |
| <FONT color="green">106</FONT> * and then return the associated Runnable. The default implementation merely defaults to<a name="line.106"></a> |
| <FONT color="green">107</FONT> * <pre><a name="line.107"></a> |
| <FONT color="green">108</FONT> * Subject subject = {@link #getSubject() getSubject()};<a name="line.108"></a> |
| <FONT color="green">109</FONT> * return subject.{@link Subject#associateWith(Runnable) associateWith(r)};<a name="line.109"></a> |
| <FONT color="green">110</FONT> * </pre><a name="line.110"></a> |
| <FONT color="green">111</FONT> *<a name="line.111"></a> |
| <FONT color="green">112</FONT> * @param r the argument runnable to be associated with the current subject<a name="line.112"></a> |
| <FONT color="green">113</FONT> * @return the associated runnable instance reflecting the current subject<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> protected Runnable associateWithSubject(Runnable r) {<a name="line.115"></a> |
| <FONT color="green">116</FONT> Subject subject = getSubject();<a name="line.116"></a> |
| <FONT color="green">117</FONT> return subject.associateWith(r);<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /**<a name="line.120"></a> |
| <FONT color="green">121</FONT> * Executes the specified runnable by first associating it with the currently executing {@code Subject} and then<a name="line.121"></a> |
| <FONT color="green">122</FONT> * dispatches the associated Runnable to the underlying target {@link Executor} instance.<a name="line.122"></a> |
| <FONT color="green">123</FONT> *<a name="line.123"></a> |
| <FONT color="green">124</FONT> * @param command the runnable to associate with the currently executing subject and then to execute via the target<a name="line.124"></a> |
| <FONT color="green">125</FONT> * {@code Executor} instance.<a name="line.125"></a> |
| <FONT color="green">126</FONT> */<a name="line.126"></a> |
| <FONT color="green">127</FONT> public void execute(Runnable command) {<a name="line.127"></a> |
| <FONT color="green">128</FONT> Runnable associated = associateWithSubject(command);<a name="line.128"></a> |
| <FONT color="green">129</FONT> getTargetExecutor().execute(associated);<a name="line.129"></a> |
| <FONT color="green">130</FONT> }<a name="line.130"></a> |
| <FONT color="green">131</FONT> }<a name="line.131"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
