blob: f5b08e681415593c85e4052f1bd76b0d92e58db5 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>NoSessionCreationFilter.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: Test Coverage</a> &gt; <a href="../index.html" class="el_bundle">shiro-web</a> &gt; <a href="index.source.html" class="el_package">org.apache.shiro.web.filter.session</a> &gt; <span class="el_source">NoSessionCreationFilter.java</span></div><h1>NoSessionCreationFilter.java</h1><pre class="source lang-java linenums">/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.web.filter.session;
import org.apache.shiro.subject.support.DefaultSubjectContext;
import org.apache.shiro.web.filter.PathMatchingFilter;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
/**
* A {@code PathMatchingFilter} that will disable creating new Sessions during the request. This is a useful
* filter to place in the front of any filter chains that may result in REST, SOAP or other service invocations that
* are not intended to participate in a session.
* &lt;p/&gt;
* This filter enables the following behavior:
* &lt;ol&gt;
* &lt;li&gt;If a {@code Subject} does not yet have a Session by the time this filter is called, this filter effectively
* disables all calls to {@code subject}.{@link org.apache.shiro.subject.Subject#getSession() getSession()} and
* {@code subject}.{@link org.apache.shiro.subject.Subject#getSession(boolean) getSession(true)}. If either are called
* during the request, an exception will be thrown.&lt;/li&gt;
* &lt;li&gt;
* However, if the {@code Subject} already has an associated session before this filter is invoked, either because it
* was created in another part of the application, or a filter higher in the chain created one, this filter has no
* effect.
* &lt;/li&gt;
* &lt;/ol&gt;
* Finally, calls to &lt;code&gt;subject.getSession(false)&lt;/code&gt; (i.e. a {@code false} boolean value) will be unaffected
* and may be called without repercussion in all cases.
*
* @since 1.2
*/
<span class="fc" id="L49">public class NoSessionCreationFilter extends PathMatchingFilter {</span>
@Override
protected boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {
<span class="fc" id="L53"> request.setAttribute(DefaultSubjectContext.SESSION_CREATION_ENABLED, Boolean.FALSE);</span>
<span class="fc" id="L54"> return true;</span>
}
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.eclemma.org/jacoco">JaCoCo</a> 0.7.7.201606060606</span></div></body></html>