| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.mgt;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.subject.Subject;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * A Default {@code SessionStorageEvaluator} that provides reasonable control over if and how Sessions may be used for<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * storing Subject state. See the {@link #isSessionStorageEnabled(org.apache.shiro.subject.Subject)}<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * method for exact behavior.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @since 1.2<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public class DefaultSessionStorageEvaluator implements SessionStorageEvaluator {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> /**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Global policy determining if Subject sessions may be used to persist Subject state if the Subject's Session<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * does not yet exist.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private boolean sessionStorageEnabled = true;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * This implementation functions as follows:<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <ul><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li>If the specified Subject already has an existing {@code Session} (typically because an application developer<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * has called {@code subject.getSession()} already), Shiro will use that existing session to store subject state.</li><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li>If a Subject does not yet have a Session, this implementation checks the<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * {@link #isSessionStorageEnabled() sessionStorageEnabled} property:<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <ul><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <li>If {@code sessionStorageEnabled} is true (the default setting), a new session may be created to persist<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Subject state if necessary.</li><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <li>If {@code sessionStorageEnabled} is {@code false}, a new session will <em>not</em> be created to persist<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * session state.</li><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * </ul></li><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Most applications use Sessions and are OK with the default {@code true} setting for {@code sessionStorageEnabled}.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p/><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * However, if your application is a purely 100% stateless application that never uses sessions,<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * you will want to set {@code sessionStorageEnabled} to {@code false}. Realize that a {@code false} value will<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * ensure that any subject login only retains the authenticated identity for the duration of a request. Any other<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * requests, invocations or messages will not be authenticated.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> *<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param subject the {@code Subject} for which session state persistence may be enabled<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return the value of {@link #isSessionStorageEnabled()} and ignores the {@code Subject} argument.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public boolean isSessionStorageEnabled(Subject subject) {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> return (subject != null && subject.getSession(false) != null) || isSessionStorageEnabled();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Returns {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state,<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * {@code false} otherwise. The default value is {@code true}.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p/><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * 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> |
| <span class="sourceLineNo">072</span> * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * authenticate on every request).<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @return {@code true} if any Subject's {@code Session} may be used to persist that {@code Subject}'s state,<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * {@code false} otherwise.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public boolean isSessionStorageEnabled() {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return sessionStorageEnabled;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Sets if any Subject's {@code Session} may be used to persist that {@code Subject}'s state. The<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * default value is {@code true}.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <p/><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <b>N.B.</b> This is a global configuration setting; setting this value to {@code false} will disable sessions<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * 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> |
| <span class="sourceLineNo">088</span> * to {@code false} for 100% stateless applications (e.g. when sessions aren't used or when remote clients<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * authenticate on every request).<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param sessionStorageEnabled if any Subject's {@code Session} may be used to persist that {@code Subject}'s state.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public void setSessionStorageEnabled(boolean sessionStorageEnabled) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.sessionStorageEnabled = sessionStorageEnabled;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span>}<a name="line.96"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
