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