| <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> * A Default {@code SessionStorageEvaluator} that provides reasonable control over if and how Sessions may be used for<a name="line.24"></a> |
| <FONT color="green">025</FONT> * storing Subject state. See the {@link #isSessionStorageEnabled(org.apache.shiro.subject.Subject)}<a name="line.25"></a> |
| <FONT color="green">026</FONT> * method for exact behavior.<a name="line.26"></a> |
| <FONT color="green">027</FONT> *<a name="line.27"></a> |
| <FONT color="green">028</FONT> * @since 1.2<a name="line.28"></a> |
| <FONT color="green">029</FONT> */<a name="line.29"></a> |
| <FONT color="green">030</FONT> public class DefaultSessionStorageEvaluator implements SessionStorageEvaluator {<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * Global policy determining if Subject sessions may be used to persist Subject state if the Subject's Session<a name="line.33"></a> |
| <FONT color="green">034</FONT> * does not yet exist.<a name="line.34"></a> |
| <FONT color="green">035</FONT> */<a name="line.35"></a> |
| <FONT color="green">036</FONT> private boolean sessionStorageEnabled = true;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * This implementation functions as follows:<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <ul><a name="line.40"></a> |
| <FONT color="green">041</FONT> * <li>If the specified Subject already has an existing {@code Session} (typically because an application developer<a name="line.41"></a> |
| <FONT color="green">042</FONT> * has called {@code subject.getSession()} already), Shiro will use that existing session to store subject state.</li><a name="line.42"></a> |
| <FONT color="green">043</FONT> * <li>If a Subject does not yet have a Session, this implementation checks the<a name="line.43"></a> |
| <FONT color="green">044</FONT> * {@link #isSessionStorageEnabled() sessionStorageEnabled} property:<a name="line.44"></a> |
| <FONT color="green">045</FONT> * <ul><a name="line.45"></a> |
| <FONT color="green">046</FONT> * <li>If {@code sessionStorageEnabled} is true (the default setting), a new session may be created to persist<a name="line.46"></a> |
| <FONT color="green">047</FONT> * Subject state if necessary.</li><a name="line.47"></a> |
| <FONT color="green">048</FONT> * <li>If {@code sessionStorageEnabled} is {@code false}, a new session will <em>not</em> be created to persist<a name="line.48"></a> |
| <FONT color="green">049</FONT> * session state.</li><a name="line.49"></a> |
| <FONT color="green">050</FONT> * </ul></li><a name="line.50"></a> |
| <FONT color="green">051</FONT> * </ul><a name="line.51"></a> |
| <FONT color="green">052</FONT> * Most applications use Sessions and are OK with the default {@code true} setting for {@code sessionStorageEnabled}.<a name="line.52"></a> |
| <FONT color="green">053</FONT> * <p/><a name="line.53"></a> |
| <FONT color="green">054</FONT> * However, if your application is a purely 100% stateless application that never uses sessions,<a name="line.54"></a> |
| <FONT color="green">055</FONT> * you will want to set {@code sessionStorageEnabled} to {@code false}. Realize that a {@code false} value will<a name="line.55"></a> |
| <FONT color="green">056</FONT> * ensure that any subject login only retains the authenticated identity for the duration of a request. Any other<a name="line.56"></a> |
| <FONT color="green">057</FONT> * requests, invocations or messages will not be authenticated.<a name="line.57"></a> |
| <FONT color="green">058</FONT> *<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @param subject the {@code Subject} for which session state persistence may be enabled<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @return the value of {@link #isSessionStorageEnabled()} and ignores the {@code Subject} argument.<a name="line.60"></a> |
| <FONT color="green">061</FONT> */<a name="line.61"></a> |
| <FONT color="green">062</FONT> public boolean isSessionStorageEnabled(Subject subject) {<a name="line.62"></a> |
| <FONT color="green">063</FONT> return (subject != null && subject.getSession(false) != null) || isSessionStorageEnabled();<a name="line.63"></a> |
| <FONT color="green">064</FONT> }<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> /**<a name="line.66"></a> |
| <FONT color="green">067</FONT> * Returns {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state,<a name="line.67"></a> |
| <FONT color="green">068</FONT> * {@code false} otherwise. The default value is {@code true}.<a name="line.68"></a> |
| <FONT color="green">069</FONT> * <p/><a name="line.69"></a> |
| <FONT color="green">070</FONT> * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions<a name="line.70"></a> |
| <FONT color="green">071</FONT> * to persist Subject state for all Subjects that do not already have a Session. It should typically only be set<a name="line.71"></a> |
| <FONT color="green">072</FONT> * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients<a name="line.72"></a> |
| <FONT color="green">073</FONT> * authenticate on every request).<a name="line.73"></a> |
| <FONT color="green">074</FONT> *<a name="line.74"></a> |
| <FONT color="green">075</FONT> * @return {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state,<a name="line.75"></a> |
| <FONT color="green">076</FONT> * {@code false} otherwise.<a name="line.76"></a> |
| <FONT color="green">077</FONT> */<a name="line.77"></a> |
| <FONT color="green">078</FONT> public boolean isSessionStorageEnabled() {<a name="line.78"></a> |
| <FONT color="green">079</FONT> return sessionStorageEnabled;<a name="line.79"></a> |
| <FONT color="green">080</FONT> }<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> /**<a name="line.82"></a> |
| <FONT color="green">083</FONT> * Sets if any Subject's {@code Session} may be used to persist that {@code Subject}'s state. The<a name="line.83"></a> |
| <FONT color="green">084</FONT> * default value is {@code true}.<a name="line.84"></a> |
| <FONT color="green">085</FONT> * <p/><a name="line.85"></a> |
| <FONT color="green">086</FONT> * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions<a name="line.86"></a> |
| <FONT color="green">087</FONT> * to persist Subject state for all Subjects that do not already have a Session. It should typically only be set<a name="line.87"></a> |
| <FONT color="green">088</FONT> * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients<a name="line.88"></a> |
| <FONT color="green">089</FONT> * authenticate on every request).<a name="line.89"></a> |
| <FONT color="green">090</FONT> *<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @param sessionStorageEnabled if any Subject's {@code Session} may be used to persist that {@code Subject}'s state.<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> public void setSessionStorageEnabled(boolean sessionStorageEnabled) {<a name="line.93"></a> |
| <FONT color="green">094</FONT> this.sessionStorageEnabled = sessionStorageEnabled;<a name="line.94"></a> |
| <FONT color="green">095</FONT> }<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
