| <!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.concurrent;<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><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Collection;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * {@code ExecutorService} implementation that will automatically first associate any argument<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * {@link Runnable} or {@link Callable} instances with the {@link #getSubject currently available subject} and then<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * dispatch the Subject-enabled runnable or callable to an underlying delegate<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * {@link java.util.concurrent.ExecutorService ExecutorService} instance. The principle is the same as the<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * parent {@link SubjectAwareExecutor} class, but enables the richer {@link ExecutorService} API.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p/><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * This is a simplification for applications that want to execute code as the currently<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * executing {@code Subject} on another thread, but don't want or need to call the<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * {@link Subject#associateWith(Runnable)} or {@link Subject#associateWith(Callable)} methods and dispatch them to a<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Thread manually. This simplifies code and reduces Shiro dependencies across application source code.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p/><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Consider this code that could be repeated in many places across an application:<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <pre><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * {@link Callable Callable} applicationWork = //instantiate or acquire Callable from somewhere<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * {@link Subject Subject} subject = {@link org.apache.shiro.SecurityUtils SecurityUtils}.{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()};<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * {@link Callable Callable} work = subject.{@link Subject#associateWith(Callable) associateWith(applicationWork)};<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * {@link ExecutorService anExecutorService}.{@link ExecutorService#submit(Callable) submit(work)};<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Instead, if the {@code ExecutorService} instance used at runtime is an instance of this class<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * (which delegates to the target ExecutorService that you want), all places in code like the above reduce to this:<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@link Callable Callable} applicationWork = //instantiate or acquire Callable from somewhere<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * {@link ExecutorService anExecutorService}.{@link ExecutorService#submit(Callable) submit(work)};<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </pre><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Notice there is no use of the Shiro API in the 2nd code block, encouraging the principle of loose coupling across<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * your codebase.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @since 1.0<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>public class SubjectAwareExecutorService extends SubjectAwareExecutor implements ExecutorService {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private ExecutorService targetExecutorService;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public SubjectAwareExecutorService() {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public SubjectAwareExecutorService(ExecutorService target) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> setTargetExecutorService(target);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public ExecutorService getTargetExecutorService() {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return targetExecutorService;<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> public void setTargetExecutorService(ExecutorService targetExecutorService) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> super.setTargetExecutor(targetExecutorService);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> this.targetExecutorService = targetExecutorService;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> @Override<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public void setTargetExecutor(Executor targetExecutor) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (!(targetExecutor instanceof ExecutorService)) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> String msg = "The " + getClass().getName() + " implementation only accepts " +<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> ExecutorService.class.getName() + " target instances.";<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> throw new IllegalArgumentException(msg);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> super.setTargetExecutor(targetExecutor);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public void shutdown() {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.targetExecutorService.shutdown();<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> public List<Runnable> shutdownNow() {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return this.targetExecutorService.shutdownNow();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public boolean isShutdown() {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> return this.targetExecutorService.isShutdown();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public boolean isTerminated() {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return this.targetExecutorService.isTerminated();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return this.targetExecutorService.awaitTermination(timeout, unit);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> protected <T> Callable<T> associateWithSubject(Callable<T> task) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> Subject subject = getSubject();<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return subject.associateWith(task);<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> public <T> Future<T> submit(Callable<T> task) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> Callable<T> work = associateWithSubject(task);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return this.targetExecutorService.submit(work);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public <T> Future<T> submit(Runnable task, T result) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> Runnable work = associateWithSubject(task);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return this.targetExecutorService.submit(work, result);<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> |
| <span class="sourceLineNo">123</span> public Future<?> submit(Runnable task) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> Runnable work = associateWithSubject(task);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return this.targetExecutorService.submit(work);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> protected <T> Collection<Callable<T>> associateWithSubject(Collection<? extends Callable<T>> tasks) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> Collection<Callable<T>> workItems = new ArrayList<Callable<T>>(tasks.size());<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> for (Callable<T> task : tasks) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> Callable<T> work = associateWithSubject(task);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> workItems.add(work);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return workItems;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> Collection<Callable<T>> workItems = associateWithSubject(tasks);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> return this.targetExecutorService.invokeAll(workItems);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> throws InterruptedException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> Collection<Callable<T>> workItems = associateWithSubject(tasks);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return this.targetExecutorService.invokeAll(workItems, timeout, unit);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> Collection<Callable<T>> workItems = associateWithSubject(tasks);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return this.targetExecutorService.invokeAny(workItems);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> throws InterruptedException, ExecutionException, TimeoutException {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> Collection<Callable<T>> workItems = associateWithSubject(tasks);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return this.targetExecutorService.invokeAny(workItems, timeout, unit);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span>}<a name="line.158"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
| |
