Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / shiro-web / xref / org / apache / shiro / web / servlet / AbstractShiroFilter.html
blob: 220b47101a4cf633c031d0bcfa9114cdda046dc4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AbstractShiroFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/AbstractShiroFilter.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.servlet;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.ExecutionException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.DefaultWebSecurityManager;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.WebSecurityManager;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.WebSubject;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Callable;
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Abstract base class that provides all standard Shiro request filtering behavior and expects</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * subclasses to implement configuration-specific logic (INI, XML, .properties, etc).</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Subclasses should perform configuration and construction logic in an overridden</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * {@link #init()} method implementation. That implementation should make available any constructed</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * {@code SecurityManager} and {@code FilterChainResolver} by calling</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * {@link #setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager)} and</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver)} methods respectively.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &lt;h3&gt;Static SecurityManager&lt;/h3&gt;</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * By default the {@code SecurityManager} instance enabled by this filter &lt;em&gt;will not&lt;/em&gt; be enabled in static</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * memory via the {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * method. Instead, it is expected that Subject instances will always be constructed on a request-processing thread</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * via instances of this Filter class.</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * However, if you need to construct {@code Subject} instances on separate (non request-processing) threads, it might</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * be easiest to enable the SecurityManager to be available in static memory via the</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * {@link SecurityUtils#getSecurityManager()} method. You can do this by additionally specifying an {@code init-param}:</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * &amp;lt;filter&amp;gt;</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * ... other config here ...</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * &amp;lt;init-param&amp;gt;</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * &amp;lt;param-name&amp;gt;staticSecurityManagerEnabled&amp;lt;/param-name&amp;gt;</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * &amp;lt;param-value&amp;gt;true&amp;lt;/param-value&amp;gt;</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * &amp;lt;/init-param&amp;gt;</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * &amp;lt;/filter&amp;gt;</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * See the Shiro &lt;a href="<a href="http://shiro.apache.org/subject.html" target="alexandria_uri">http://shiro.apache.org/subject.html</a>"&gt;Subject documentation&lt;/a&gt; for more information as to</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * if you would do this, particularly the sections on the {@code Subject.Builder} and Thread Association.</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="http://shiro.apache.org/subject.html" target="alexandria_uri">http://shiro.apache.org/subject.html</a>"&gt;Subject documentation&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractShiroFilter" href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#AbstractShiroFilter">AbstractShiroFilter</a> <strong class="jxr_keyword">extends</strong> <a name="OncePerRequestFilter" href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#OncePerRequestFilter">OncePerRequestFilter</a> {
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AbstractShiroFilter.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String STATIC_INIT_PARAM_NAME = <span class="jxr_string">"staticSecurityManagerEnabled"</span>;
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">// Reference to the security manager used by this filter</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a> securityManager;
<a class="jxr_linenumber" name="L82" href="#L82">82</a>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// Used to determine which chain should handle an incoming request/response</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <a name="FilterChainResolver" href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#FilterChainResolver">FilterChainResolver</a> filterChainResolver;
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * Whether or not to bind the constructed SecurityManager instance to static memory (via</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * SecurityUtils.setSecurityManager). This was added to support <a href="https://issues.apache.org/jira/browse/SHIRO-287" target="alexandria_uri">https://issues.apache.org/jira/browse/SHIRO-287</a></em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> staticSecurityManagerEnabled;
<a class="jxr_linenumber" name="L92" href="#L92">92</a>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">protected</strong> <a name="AbstractShiroFilter" href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#AbstractShiroFilter">AbstractShiroFilter</a>() {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>.staticSecurityManagerEnabled = false;
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
<a class="jxr_linenumber" name="L96" href="#L96">96</a>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">public</strong> <a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a> getSecurityManager() {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> securityManager;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecurityManager(<a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a> sm) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.securityManager = sm;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> <a name="FilterChainResolver" href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#FilterChainResolver">FilterChainResolver</a> getFilterChainResolver() {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> filterChainResolver;
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterChainResolver(<a name="FilterChainResolver" href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#FilterChainResolver">FilterChainResolver</a> filterChainResolver) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">this</strong>.filterChainResolver = filterChainResolver;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * to static memory (via</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @return {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="https://issues.apache.org/jira/browse/SHIRO-287" target="alexandria_uri">https://issues.apache.org/jira/browse/SHIRO-287</a>"&gt;SHIRO-287&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStaticSecurityManagerEnabled() {
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> staticSecurityManagerEnabled;
<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Sets if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param staticSecurityManagerEnabled if the constructed {@link #getSecurityManager() securityManager} reference</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * should be bound to static memory (via</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="https://issues.apache.org/jira/browse/SHIRO-287" target="alexandria_uri">https://issues.apache.org/jira/browse/SHIRO-287</a>"&gt;SHIRO-287&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStaticSecurityManagerEnabled(<strong class="jxr_keyword">boolean</strong> staticSecurityManagerEnabled) {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">this</strong>.staticSecurityManagerEnabled = staticSecurityManagerEnabled;
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> onFilterConfigSet() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">//added in 1.2 for SHIRO-287:</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> applyStaticSecurityManagerEnabledConfig();
<a class="jxr_linenumber" name="L152" href="#L152">152</a> init();
<a class="jxr_linenumber" name="L153" href="#L153">153</a> ensureSecurityManager();
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_comment">//added in 1.2 for SHIRO-287:</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (isStaticSecurityManagerEnabled()) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> SecurityUtils.setSecurityManager(getSecurityManager());
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Checks if the init-param that configures the filter to use static memory has been configured, and if so,</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * sets the {@link #setStaticSecurityManagerEnabled(boolean)} attribute with the configured value.</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="https://issues.apache.org/jira/browse/SHIRO-287" target="alexandria_uri">https://issues.apache.org/jira/browse/SHIRO-287</a>"&gt;SHIRO-287&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applyStaticSecurityManagerEnabledConfig() {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> String value = getInitParam(STATIC_INIT_PARAM_NAME);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> Boolean b = Boolean.valueOf(value);
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (b != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> setStaticSecurityManagerEnabled(b);
<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * A fallback mechanism called in {@link #onFilterConfigSet()} to ensure that the</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * {@link #getSecurityManager() securityManager} property has been set by configuration, and if not,</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * creates one automatically.</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> ensureSecurityManager() {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a> securityManager = getSecurityManager();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> (securityManager == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> log.info(<span class="jxr_string">"No SecurityManager configured. Creating default."</span>);
<a class="jxr_linenumber" name="L189" href="#L189">189</a> securityManager = createDefaultSecurityManager();
<a class="jxr_linenumber" name="L190" href="#L190">190</a> setSecurityManager(securityManager);
<a class="jxr_linenumber" name="L191" href="#L191">191</a> }
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">protected</strong> <a name="WebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html#WebSecurityManager">WebSecurityManager</a> createDefaultSecurityManager() {
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="DefaultWebSecurityManager" href="../../../../../org/apache/shiro/web/mgt/DefaultWebSecurityManager.html#DefaultWebSecurityManager">DefaultWebSecurityManager</a>();
<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
<a class="jxr_linenumber" name="L197" href="#L197">197</a>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHttpSessions() {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> getSecurityManager().isHttpSessionMode();
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * Wraps the original HttpServletRequest in a {@link ShiroHttpServletRequest}, which is required for supporting</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * Servlet Specification behavior backed by a {@link org.apache.shiro.subject.Subject Subject} instance.</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @param orig the original Servlet Container-provided incoming {@code HttpServletRequest} instance.</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @return {@link ShiroHttpServletRequest ShiroHttpServletRequest} instance wrapping the original.</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">protected</strong> ServletRequest wrapServletRequest(HttpServletRequest orig) {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a>(orig, getServletContext(), isHttpSessions());
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
<a class="jxr_linenumber" name="L213" href="#L213">213</a>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * Prepares the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * processing.</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * If the {@code ServletRequest} is an instance of {@link HttpServletRequest}, the value returned from this method</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * is obtained by calling {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)} to allow Shiro-specific</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * HTTP behavior, otherwise the original {@code ServletRequest} argument is returned.</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.</em>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @return the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request processing.</em>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">protected</strong> ServletRequest prepareServletRequest(ServletRequest request, ServletResponse response, FilterChain chain) {
<a class="jxr_linenumber" name="L230" href="#L230">230</a> ServletRequest toUse = request;
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (request instanceof HttpServletRequest) {
<a class="jxr_linenumber" name="L232" href="#L232">232</a> HttpServletRequest http = (HttpServletRequest) request;
<a class="jxr_linenumber" name="L233" href="#L233">233</a> toUse = wrapServletRequest(http);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">return</strong> toUse;
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * Returns a new {@link ShiroHttpServletResponse} instance, wrapping the {@code orig} argument, in order to provide</em>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * correct URL rewriting behavior required by the Servlet Specification when using Shiro-based sessions (and not</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * Servlet Container HTTP-based sessions).</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @param orig the original {@code HttpServletResponse} instance provided by the Servlet Container.</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @param request the {@code ShiroHttpServletRequest} instance wrapping the original request.</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @return the wrapped ServletResponse instance to use during {@link FilterChain} execution.</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">protected</strong> ServletResponse wrapServletResponse(HttpServletResponse orig, <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a> request) {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="ShiroHttpServletResponse" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#ShiroHttpServletResponse">ShiroHttpServletResponse</a>(orig, getServletContext(), request);
<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * Prepares the {@code ServletResponse} instance that will be passed to the {@code FilterChain} for request</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * processing.</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * This implementation delegates to {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)}</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * only if Shiro-based sessions are enabled (that is, !{@link #isHttpSessions()}) and the request instance is a</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * {@link ShiroHttpServletRequest}. This ensures that any URL rewriting that occurs is handled correctly using the</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * Shiro-managed Session's sessionId and not a servlet container session ID.</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * If HTTP-based sessions are enabled (the default), then this method does nothing and just returns the</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * {@code ServletResponse} argument as-is, relying on the default Servlet Container URL rewriting logic.</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @return the {@code ServletResponse} instance that will be passed to the {@code FilterChain} during request processing.</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">protected</strong> ServletResponse prepareServletResponse(ServletRequest request, ServletResponse response, FilterChain chain) {
<a class="jxr_linenumber" name="L272" href="#L272">272</a> ServletResponse toUse = response;
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (!isHttpSessions() &amp;&amp; (request instanceof <a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a>) &amp;&amp;
<a class="jxr_linenumber" name="L274" href="#L274">274</a> (response instanceof HttpServletResponse)) {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_comment">//the ShiroHttpServletResponse exists to support URL rewriting for session ids. This is only needed if</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">//using Shiro sessions (i.e. not simple HttpSession based sessions):</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> toUse = wrapServletResponse((HttpServletResponse) response, (<a name="ShiroHttpServletRequest" href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#ShiroHttpServletRequest">ShiroHttpServletRequest</a>) request);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">return</strong> toUse;
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
<a class="jxr_linenumber" name="L281" href="#L281">281</a>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * Creates a {@link WebSubject} instance to associate with the incoming request/response pair which will be used</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * throughout the request/response execution.</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param request the incoming {@code ServletRequest}</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param response the outgoing {@code ServletResponse}</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @return the {@code WebSubject} instance to associate with the request/response execution</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">protected</strong> <a name="WebSubject" href="../../../../../org/apache/shiro/web/subject/WebSubject.html#WebSubject">WebSubject</a> createSubject(ServletRequest request, ServletResponse response) {
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSubject.Builder(getSecurityManager(), request, response).buildWebSubject();
<a class="jxr_linenumber" name="L293" href="#L293">293</a> }
<a class="jxr_linenumber" name="L294" href="#L294">294</a>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * Updates any 'native' Session's last access time that might exist to the timestamp when this method is called.</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * If native sessions are not enabled (that is, standard Servlet container sessions are being used) or there is no</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * session ({@code subject.getSession(false) == null}), this method does nothing.</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;This method implementation merely calls</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * &lt;code&gt;Session.{@link org.apache.shiro.session.Session#touch() touch}()&lt;/code&gt; on the session.</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * @param request incoming request - ignored, but available to subclasses that might wish to override this method</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @param response outgoing response - ignored, but available to subclasses that might wish to override this method</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> updateSessionLastAccessTime(ServletRequest request, ServletResponse response) {
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">if</strong> (!isHttpSessions()) { <em class="jxr_comment">//'native' sessions</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> Subject subject = SecurityUtils.getSubject();
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_comment">//Subject should never _ever_ be null, but just in case:</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> (subject != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L312" href="#L312">312</a> Session session = subject.getSession(false);
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L315" href="#L315">315</a> session.touch();
<a class="jxr_linenumber" name="L316" href="#L316">316</a> } <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a class="jxr_linenumber" name="L317" href="#L317">317</a> log.error(<span class="jxr_string">"session.touch() method invocation has failed. Unable to update "</span> +
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <span class="jxr_string">"the corresponding session's last access time based on the incoming request."</span>, t);
<a class="jxr_linenumber" name="L319" href="#L319">319</a> }
<a class="jxr_linenumber" name="L320" href="#L320">320</a> }
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
<a class="jxr_linenumber" name="L323" href="#L323">323</a> }
<a class="jxr_linenumber" name="L324" href="#L324">324</a>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * {@code doFilterInternal} implementation that sets-up, executes, and cleans-up a Shiro-filtered request. It</em>
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * performs the following ordered operations:</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #prepareServletRequest(ServletRequest, ServletResponse, FilterChain) Prepares}</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * the incoming {@code ServletRequest} for use during Shiro's processing&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #prepareServletResponse(ServletRequest, ServletResponse, FilterChain) Prepares}</em>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * the outgoing {@code ServletResponse} for use during Shiro's processing&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * &lt;li&gt; {@link #createSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) Creates} a</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * {@link Subject} instance based on the specified request/response pair.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * &lt;li&gt;Finally {@link Subject#execute(Runnable) executes} the</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * {@link #updateSessionLastAccessTime(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} and</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * {@link #executeChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)}</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * methods&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * The {@code Subject.}{@link Subject#execute(Runnable) execute(Runnable)} call in step #4 is used as an</em>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * implementation technique to guarantee proper thread binding and restoration is completed successfully.</em>
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * @param servletRequest the incoming {@code ServletRequest}</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * @param servletResponse the outgoing {@code ServletResponse}</em>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @param chain the container-provided {@code FilterChain} to execute</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @throws IOException if an IO error occurs</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * @throws javax.servlet.ServletException if an Throwable other than an IOException</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doFilterInternal(ServletRequest servletRequest, ServletResponse servletResponse, <strong class="jxr_keyword">final</strong> FilterChain chain)
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">throws</strong> ServletException, IOException {
<a class="jxr_linenumber" name="L352" href="#L352">352</a>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> Throwable t = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L354" href="#L354">354</a>
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">final</strong> ServletRequest request = prepareServletRequest(servletRequest, servletResponse, chain);
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">final</strong> ServletResponse response = prepareServletResponse(request, servletResponse, chain);
<a class="jxr_linenumber" name="L358" href="#L358">358</a>
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">final</strong> Subject subject = createSubject(request, response);
<a class="jxr_linenumber" name="L360" href="#L360">360</a>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_comment">//noinspection unchecked</em>
<a class="jxr_linenumber" name="L362" href="#L362">362</a> subject.execute(<strong class="jxr_keyword">new</strong> Callable() {
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">public</strong> Object call() <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L364" href="#L364">364</a> updateSessionLastAccessTime(request, response);
<a class="jxr_linenumber" name="L365" href="#L365">365</a> executeChain(request, response, chain);
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L367" href="#L367">367</a> }
<a class="jxr_linenumber" name="L368" href="#L368">368</a> });
<a class="jxr_linenumber" name="L369" href="#L369">369</a> } <strong class="jxr_keyword">catch</strong> (ExecutionException ex) {
<a class="jxr_linenumber" name="L370" href="#L370">370</a> t = ex.getCause();
<a class="jxr_linenumber" name="L371" href="#L371">371</a> } <strong class="jxr_keyword">catch</strong> (Throwable throwable) {
<a class="jxr_linenumber" name="L372" href="#L372">372</a> t = throwable;
<a class="jxr_linenumber" name="L373" href="#L373">373</a> }
<a class="jxr_linenumber" name="L374" href="#L374">374</a>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">if</strong> (t != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">if</strong> (t instanceof ServletException) {
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">throw</strong> (ServletException) t;
<a class="jxr_linenumber" name="L378" href="#L378">378</a> }
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">if</strong> (t instanceof IOException) {
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">throw</strong> (IOException) t;
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_comment">//otherwise it's not one of the two exceptions expected by the filter method signature - wrap it in one:</em>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> String msg = <span class="jxr_string">"Filtered request failed."</span>;
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ServletException(msg, t);
<a class="jxr_linenumber" name="L385" href="#L385">385</a> }
<a class="jxr_linenumber" name="L386" href="#L386">386</a> }
<a class="jxr_linenumber" name="L387" href="#L387">387</a>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * Returns the {@code FilterChain} to execute for the given request.</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * The {@code origChain} argument is the</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * original {@code FilterChain} supplied by the Servlet Container, but it may be modified to provide</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * more behavior by pre-pending further chains according to the Shiro configuration.</em>
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * This implementation returns the chain that will actually be executed by acquiring the chain from a</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * {@link #getFilterChainResolver() filterChainResolver}. The resolver determines exactly which chain to</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * execute, typically based on URL configuration. If no chain is returned from the resolver call</em>
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * (returns {@code null}), then the {@code origChain} will be returned by default.</em>
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em>
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * @param origChain the original {@code FilterChain} provided by the Servlet Container</em>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * @return the {@link FilterChain} to execute for the given request</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">protected</strong> FilterChain getExecutionChain(ServletRequest request, ServletResponse response, FilterChain origChain) {
<a class="jxr_linenumber" name="L407" href="#L407">407</a>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> FilterChain chain = origChain;
<a class="jxr_linenumber" name="L409" href="#L409">409</a>
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <a name="FilterChainResolver" href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#FilterChainResolver">FilterChainResolver</a> resolver = getFilterChainResolver();
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">if</strong> (resolver == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L412" href="#L412">412</a> log.debug(<span class="jxr_string">"No FilterChainResolver configured. Returning original FilterChain."</span>);
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">return</strong> origChain;
<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
<a class="jxr_linenumber" name="L415" href="#L415">415</a>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> FilterChain resolved = resolver.getChain(request, response, origChain);
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">if</strong> (resolved != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L418" href="#L418">418</a> log.trace(<span class="jxr_string">"Resolved a configured FilterChain for the current request."</span>);
<a class="jxr_linenumber" name="L419" href="#L419">419</a> chain = resolved;
<a class="jxr_linenumber" name="L420" href="#L420">420</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L421" href="#L421">421</a> log.trace(<span class="jxr_string">"No FilterChain configured for the current request. Using the default."</span>);
<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
<a class="jxr_linenumber" name="L423" href="#L423">423</a>
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">return</strong> chain;
<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
<a class="jxr_linenumber" name="L426" href="#L426">426</a>
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * Executes a {@link FilterChain} for the given request.</em>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * This implementation first delegates to</em>
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * &lt;code&gt;{@link #getExecutionChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) getExecutionChain}&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * to allow the application's Shiro configuration to determine exactly how the chain should execute. The resulting</em>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * value from that call is then executed directly by calling the returned {@code FilterChain}'s</em>
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * {@link FilterChain#doFilter doFilter} method. That is:</em>
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * FilterChain chain = {@link #getExecutionChain}(request, response, origChain);</em>
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * chain.{@link FilterChain#doFilter doFilter}(request,response);&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em>
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em>
<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> * @param origChain the Servlet Container-provided chain that may be wrapped further by an application-configured</em>
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * chain of Filters.</em>
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * @throws IOException if the underlying {@code chain.doFilter} call results in an IOException</em>
<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * @throws ServletException if the underlying {@code chain.doFilter} call results in a ServletException</em>
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeChain(ServletRequest request, ServletResponse response, FilterChain origChain)
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">throws</strong> IOException, ServletException {
<a class="jxr_linenumber" name="L449" href="#L449">449</a> FilterChain chain = getExecutionChain(request, response, origChain);
<a class="jxr_linenumber" name="L450" href="#L450">450</a> chain.doFilter(request, response);
<a class="jxr_linenumber" name="L451" href="#L451">451</a> }
<a class="jxr_linenumber" name="L452" href="#L452">452</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>