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