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