blob: cdc7c11064b6263fa9078c41a80de69b789dbca1 [file] [log] [blame]
<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.web.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.mgt.DefaultSessionStorageEvaluator;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.session.mgt.NativeSessionManager;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.session.mgt.SessionManager;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.subject.Subject;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.web.subject.WebSubject;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * A web-specific {@code SessionStorageEvaluator} that performs the same logic as the parent class<a name="line.29"></a>
<FONT color="green">030</FONT> * {@link DefaultSessionStorageEvaluator} but additionally checks for a request-specific flag that may enable or<a name="line.30"></a>
<FONT color="green">031</FONT> * disable session access.<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;p/&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * This implementation usually works in conjunction with the<a name="line.33"></a>
<FONT color="green">034</FONT> * {@link org.apache.shiro.web.filter.session.NoSessionCreationFilter}: If the {@code NoSessionCreationFilter}<a name="line.34"></a>
<FONT color="green">035</FONT> * is configured in a filter chain, that filter will set a specific<a name="line.35"></a>
<FONT color="green">036</FONT> * {@code ServletRequest} {@link javax.servlet.ServletRequest#setAttribute attribute} indicating that session creation<a name="line.36"></a>
<FONT color="green">037</FONT> * should be disabled.<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;p/&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * This {@code DefaultWebSessionStorageEvaluator} will then inspect this attribute, and if it has been set, will return<a name="line.39"></a>
<FONT color="green">040</FONT> * {@code false} from {@link #isSessionStorageEnabled(org.apache.shiro.subject.Subject)} method, thereby preventing<a name="line.40"></a>
<FONT color="green">041</FONT> * Shiro from creating a session for the purpose of storing subject state.<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;p/&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * If the request attribute has<a name="line.43"></a>
<FONT color="green">044</FONT> * not been set (i.e. the {@code NoSessionCreationFilter} is not configured or has been disabled), this class does<a name="line.44"></a>
<FONT color="green">045</FONT> * nothing and delegates to the parent class for existing behavior.<a name="line.45"></a>
<FONT color="green">046</FONT> *<a name="line.46"></a>
<FONT color="green">047</FONT> * @since 1.2<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> public class DefaultWebSessionStorageEvaluator extends DefaultSessionStorageEvaluator {<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> //since 1.2.1<a name="line.51"></a>
<FONT color="green">052</FONT> private SessionManager sessionManager;<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> /**<a name="line.54"></a>
<FONT color="green">055</FONT> * Sets the session manager to use when checking to see if session storage is possible.<a name="line.55"></a>
<FONT color="green">056</FONT> * @param sessionManager the session manager instance for checking.<a name="line.56"></a>
<FONT color="green">057</FONT> * @since 1.2.1<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> //package protected on purpose to maintain point-version compatibility: (1.2.3 -&gt; 1.2.1 should work always).<a name="line.59"></a>
<FONT color="green">060</FONT> void setSessionManager(SessionManager sessionManager) {<a name="line.60"></a>
<FONT color="green">061</FONT> this.sessionManager = sessionManager;<a name="line.61"></a>
<FONT color="green">062</FONT> }<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>
<FONT color="green">065</FONT> * Returns {@code true} if session storage is generally available (as determined by the super class's global<a name="line.65"></a>
<FONT color="green">066</FONT> * configuration property {@link #isSessionStorageEnabled()} and no request-specific override has turned off<a name="line.66"></a>
<FONT color="green">067</FONT> * session storage, {@code false} otherwise.<a name="line.67"></a>
<FONT color="green">068</FONT> * &lt;p/&gt;<a name="line.68"></a>
<FONT color="green">069</FONT> * This means session storage is disabled if the {@link #isSessionStorageEnabled()} property is {@code false} or if<a name="line.69"></a>
<FONT color="green">070</FONT> * a request attribute is discovered that turns off session storage for the current request.<a name="line.70"></a>
<FONT color="green">071</FONT> *<a name="line.71"></a>
<FONT color="green">072</FONT> * @param subject the {@code Subject} for which session state persistence may be enabled<a name="line.72"></a>
<FONT color="green">073</FONT> * @return {@code true} if session storage is generally available (as determined by the super class's global<a name="line.73"></a>
<FONT color="green">074</FONT> * configuration property {@link #isSessionStorageEnabled()} and no request-specific override has turned off<a name="line.74"></a>
<FONT color="green">075</FONT> * session storage, {@code false} otherwise.<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> @SuppressWarnings({"SimplifiableIfStatement"})<a name="line.77"></a>
<FONT color="green">078</FONT> @Override<a name="line.78"></a>
<FONT color="green">079</FONT> public boolean isSessionStorageEnabled(Subject subject) {<a name="line.79"></a>
<FONT color="green">080</FONT> if (subject.getSession(false) != null) {<a name="line.80"></a>
<FONT color="green">081</FONT> //use what already exists<a name="line.81"></a>
<FONT color="green">082</FONT> return true;<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> if (!isSessionStorageEnabled()) {<a name="line.85"></a>
<FONT color="green">086</FONT> //honor global setting:<a name="line.86"></a>
<FONT color="green">087</FONT> return false;<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> //SHIRO-350: non-web subject instances can't be saved to web-only session managers:<a name="line.90"></a>
<FONT color="green">091</FONT> //since 1.2.1:<a name="line.91"></a>
<FONT color="green">092</FONT> if (!(subject instanceof WebSubject) &amp;&amp; (this.sessionManager != null &amp;&amp; !(this.sessionManager instanceof NativeSessionManager))) {<a name="line.92"></a>
<FONT color="green">093</FONT> return false;<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> return WebUtils._isSessionCreationEnabled(subject);<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
</PRE>
</BODY>
</HTML>