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