blob: cc6ea6d10fa80b4978ad5f5029c8c6de8eb86b7a [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.filter.session;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.subject.support.DefaultSubjectContext;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.web.filter.PathMatchingFilter;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import javax.servlet.ServletRequest;<a name="line.24"></a>
<FONT color="green">025</FONT> import javax.servlet.ServletResponse;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * A {@code PathMatchingFilter} that will disable creating new Sessions during the request. This is a useful<a name="line.28"></a>
<FONT color="green">029</FONT> * filter to place in the front of any filter chains that may result in REST, SOAP or other service invocations that<a name="line.29"></a>
<FONT color="green">030</FONT> * are not intended to participate in a session.<a name="line.30"></a>
<FONT color="green">031</FONT> * &lt;p/&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> * This filter enables the following behavior:<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;ol&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;li&gt;If a {@code Subject} does not yet have a Session by the time this filter is called, this filter effectively<a name="line.34"></a>
<FONT color="green">035</FONT> * disables all calls to {@code subject}.{@link org.apache.shiro.subject.Subject#getSession() getSession()} and<a name="line.35"></a>
<FONT color="green">036</FONT> * {@code subject}.{@link org.apache.shiro.subject.Subject#getSession(boolean) getSession(true)}. If either are called<a name="line.36"></a>
<FONT color="green">037</FONT> * during the request, an exception will be thrown.&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * However, if the {@code Subject} already has an associated session before this filter is invoked, either because it<a name="line.39"></a>
<FONT color="green">040</FONT> * was created in another part of the application, or a filter higher in the chain created one, this filter has no<a name="line.40"></a>
<FONT color="green">041</FONT> * effect.<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;/ol&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * Finally, calls to &lt;code&gt;subject.getSession(false)&lt;/code&gt; (i.e. a {@code false} boolean value) will be unaffected<a name="line.44"></a>
<FONT color="green">045</FONT> * and may be called without repercussion in all cases.<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 NoSessionCreationFilter extends PathMatchingFilter {<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> @Override<a name="line.51"></a>
<FONT color="green">052</FONT> protected boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.52"></a>
<FONT color="green">053</FONT> request.setAttribute(DefaultSubjectContext.SESSION_CREATION_ENABLED, Boolean.FALSE);<a name="line.53"></a>
<FONT color="green">054</FONT> return true;<a name="line.54"></a>
<FONT color="green">055</FONT> }<a name="line.55"></a>
<FONT color="green">056</FONT> }<a name="line.56"></a>
</PRE>
</BODY>
</HTML>