blob: 4b239c268cb51d72ffad0b37bab61ff2a608b9f7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<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.subject.support;</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.SecurityManager;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.Session;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.session.mgt.SessionContext;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.subject.PrincipalCollection;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.subject.support.DelegatingSubject;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.StringUtils;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.web.session.mgt.DefaultWebSessionContext;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.shiro.web.session.mgt.WebSessionContext;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.shiro.web.subject.WebSubject;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.shiro.web.util.WebUtils;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">import javax.servlet.ServletRequest;</a>
<span class="sourceLineNo">033</span><a id="line.33">import javax.servlet.ServletResponse;</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35">/**</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Default {@link WebSubject WebSubject} implementation that additional ensures the ability to retain a</a>
<span class="sourceLineNo">037</span><a id="line.37"> * servlet request/response pair to be used by internal shiro components as necessary during the request execution.</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * @since 1.0</a>
<span class="sourceLineNo">040</span><a id="line.40"> */</a>
<span class="sourceLineNo">041</span><a id="line.41">public class WebDelegatingSubject extends DelegatingSubject implements WebSubject {</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> private static final long serialVersionUID = -1655724323350159250L;</a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45"> private final ServletRequest servletRequest;</a>
<span class="sourceLineNo">046</span><a id="line.46"> private final ServletResponse servletResponse;</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> public WebDelegatingSubject(PrincipalCollection principals, boolean authenticated,</a>
<span class="sourceLineNo">049</span><a id="line.49"> String host, Session session,</a>
<span class="sourceLineNo">050</span><a id="line.50"> ServletRequest request, ServletResponse response,</a>
<span class="sourceLineNo">051</span><a id="line.51"> SecurityManager securityManager) {</a>
<span class="sourceLineNo">052</span><a id="line.52"> this(principals, authenticated, host, session, true, request, response, securityManager);</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"> //since 1.2</a>
<span class="sourceLineNo">056</span><a id="line.56"> public WebDelegatingSubject(PrincipalCollection principals, boolean authenticated,</a>
<span class="sourceLineNo">057</span><a id="line.57"> String host, Session session, boolean sessionEnabled,</a>
<span class="sourceLineNo">058</span><a id="line.58"> ServletRequest request, ServletResponse response,</a>
<span class="sourceLineNo">059</span><a id="line.59"> SecurityManager securityManager) {</a>
<span class="sourceLineNo">060</span><a id="line.60"> super(principals, authenticated, host, session, sessionEnabled, securityManager);</a>
<span class="sourceLineNo">061</span><a id="line.61"> this.servletRequest = request;</a>
<span class="sourceLineNo">062</span><a id="line.62"> this.servletResponse = response;</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"> public ServletRequest getServletRequest() {</a>
<span class="sourceLineNo">066</span><a id="line.66"> return servletRequest;</a>
<span class="sourceLineNo">067</span><a id="line.67"> }</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> public ServletResponse getServletResponse() {</a>
<span class="sourceLineNo">070</span><a id="line.70"> return servletResponse;</a>
<span class="sourceLineNo">071</span><a id="line.71"> }</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> /**</a>
<span class="sourceLineNo">074</span><a id="line.74"> * Returns {@code true} if session creation is allowed (as determined by the super class's</a>
<span class="sourceLineNo">075</span><a id="line.75"> * {@link super#isSessionCreationEnabled()} value and no request-specific override has disabled sessions for this subject,</a>
<span class="sourceLineNo">076</span><a id="line.76"> * {@code false} otherwise.</a>
<span class="sourceLineNo">077</span><a id="line.77"> * &lt;p/&gt;</a>
<span class="sourceLineNo">078</span><a id="line.78"> * This means session creation is disabled if the super {@link super#isSessionCreationEnabled()} property is {@code false}</a>
<span class="sourceLineNo">079</span><a id="line.79"> * or if a request attribute is discovered that turns off sessions for the current request.</a>
<span class="sourceLineNo">080</span><a id="line.80"> *</a>
<span class="sourceLineNo">081</span><a id="line.81"> * @return {@code true} if session creation is allowed (as determined by the super class's</a>
<span class="sourceLineNo">082</span><a id="line.82"> * {@link super#isSessionCreationEnabled()} value and no request-specific override has disabled sessions for this</a>
<span class="sourceLineNo">083</span><a id="line.83"> * subject, {@code false} otherwise.</a>
<span class="sourceLineNo">084</span><a id="line.84"> * @since 1.2</a>
<span class="sourceLineNo">085</span><a id="line.85"> */</a>
<span class="sourceLineNo">086</span><a id="line.86"> @Override</a>
<span class="sourceLineNo">087</span><a id="line.87"> protected boolean isSessionCreationEnabled() {</a>
<span class="sourceLineNo">088</span><a id="line.88"> boolean enabled = super.isSessionCreationEnabled();</a>
<span class="sourceLineNo">089</span><a id="line.89"> return enabled &amp;&amp; WebUtils._isSessionCreationEnabled(this);</a>
<span class="sourceLineNo">090</span><a id="line.90"> }</a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> @Override</a>
<span class="sourceLineNo">093</span><a id="line.93"> protected SessionContext createSessionContext() {</a>
<span class="sourceLineNo">094</span><a id="line.94"> WebSessionContext wsc = new DefaultWebSessionContext();</a>
<span class="sourceLineNo">095</span><a id="line.95"> String host = getHost();</a>
<span class="sourceLineNo">096</span><a id="line.96"> if (StringUtils.hasText(host)) {</a>
<span class="sourceLineNo">097</span><a id="line.97"> wsc.setHost(host);</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"> wsc.setServletRequest(this.servletRequest);</a>
<span class="sourceLineNo">100</span><a id="line.100"> wsc.setServletResponse(this.servletResponse);</a>
<span class="sourceLineNo">101</span><a id="line.101"> return wsc;</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</a>
<span class="sourceLineNo">103</span><a id="line.103">}</a>
</pre>
</div>
</main>
</body>
</html>