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