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