| <!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.util;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * A {@code ThreadState} instance manages any state that might need to be bound and/or restored during a thread's<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * execution.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <h3>Usage</h3><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * Calling {@link #bind bind()} will place state on the currently executing thread to be accessed later during<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * the thread's execution.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <h4>WARNING</h4><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * After the thread is finished executing, or if an exception occurs, any previous state <b>MUST</b> be<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * {@link #restore restored} to guarantee all threads stay clean in any thread-pooled environment. This should always<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * be done in a {@code try/finally} block:<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <pre><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * ThreadState state = //acquire or instantiate as necessary<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * try {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * state.bind();<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * doSomething(); //execute any logic downstream logic that might need to access the state<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * } <b>finally {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * state.restore();<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * }</b><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * </pre><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @since 1.0<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>public interface ThreadState {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Binds any state that should be made accessible during a thread's execution. This should typically always<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * be called in a {@code try/finally} block paired with the {@link #restore} call to guarantee that the thread<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * is cleanly restored back to its original state. For example:<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * ThreadState state = //acquire or instantiate as necessary<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <b>try {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * state.bind();<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * doSomething(); //execute any logic downstream logic that might need to access the state<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * } </b> finally {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * state.restore();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </pre><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> void bind();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Restores a thread to its state before bind {@link #bind bind} was invoked. This should typically always be<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * called in a {@code finally} block to guarantee that the thread is cleanly restored back to its original state<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * before {@link #bind bind}'s bind was called. For example:<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <pre><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * ThreadState state = //acquire or instantiate as necessary<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * try {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * state.bind();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * doSomething(); //execute any logic downstream logic that might need to access the state<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * } <b>finally {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * state.restore();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * }</b><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * </pre><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> void restore();<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> * Completely clears/removes the {@code ThreadContext} state. Typically this method should<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * only be called in special cases - it is more 'correct' to {@link #restore restore} a thread to its previous<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * state than to clear it entirely.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> void clear();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span>}<a name="line.84"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
