| <!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.mgt;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * Evaluates whether or not Shiro may use a {@code Subject}'s {@link org.apache.shiro.session.Session Session}</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * to persist that {@code Subject}'s internal state.</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * <p/></a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * It is a common Shiro implementation strategy to use a Subject's session to persist the Subject's identity and</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * authentication state (e.g. after login) so that information does not need to be passed around for any further</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * requests/invocations. This effectively allows a session id to be used for any request or invocation as the only</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * 'pointer' that Shiro needs, and from that, Shiro can re-create the Subject instance based on the referenced Session.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * <p/></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * However, in purely stateless applications, such as some REST applications or those where every request is</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * authenticated, it is usually not needed or desirable to use Sessions to store this state (since it is in</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * fact re-created on every request). In these applications, sessions would never be used.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p/></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * This interface allows implementations to determine exactly when a Session might be used or not to store</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * {@code Subject} state on a <em>per-Subject</em> basis.</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * <p/></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * If you simply wish to enable or disable session usage at a global level for all {@code Subject}s, the</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * {@link DefaultSessionStorageEvaluator} should be sufficient. Per-subject behavior should be performed in custom</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * implementations of this interface.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @see Subject#getSession()</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @see Subject#getSession(boolean)</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @see DefaultSessionStorageEvaluator</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @since 1.2</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> */</a> |
| <span class="sourceLineNo">048</span><a id="line.48">public interface SessionStorageEvaluator {</a> |
| <span class="sourceLineNo">049</span><a id="line.49"></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> /**</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * Returns {@code true} if the specified {@code Subject}'s</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * {@link org.apache.shiro.subject.Subject#getSession() session} may be used to persist that Subject's</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * state, {@code false} otherwise.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param subject the {@code Subject} for which session state persistence may be enabled</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @return {@code true} if the specified {@code Subject}'s</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * {@link org.apache.shiro.subject.Subject#getSession() session} may be used to persist that Subject's</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * state, {@code false} otherwise.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @see Subject#getSession()</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @see Subject#getSession(boolean)</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> */</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> boolean isSessionStorageEnabled(Subject subject);</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
