| <!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=ISO-8859-1" /> |
| <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 name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">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 name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.servlet; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.ExecutionException; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.mgt.FilterChainResolver; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.DefaultWebSecurityManager; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.mgt.WebSecurityManager; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.WebSubject; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="31" href="#31">31</a> |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; |
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Callable; |
| <a name="40" href="#40">40</a> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Abstract base class that provides all standard Shiro request filtering behavior and expects</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * subclasses to implement configuration-specific logic (INI, XML, .properties, etc).</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Subclasses should perform configuration and construction logic in an overridden</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@link #init()} method implementation. That implementation should make available any constructed</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * {@code SecurityManager} and {@code FilterChainResolver} by calling</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * {@link #setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager)} and</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@link #setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver)} methods respectively.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <h3>Static SecurityManager</h3></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * By default the {@code SecurityManager} instance enabled by this filter <em>will not</em> be enabled in static</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * memory via the {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}</em> |
| <a name="53" href="#53">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 name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * via instances of this Filter class.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="56" href="#56">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 name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * be easiest to enable the SecurityManager to be available in static memory via the</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * {@link SecurityUtils#getSecurityManager()} method. You can do this by additionally specifying an {@code init-param}:</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;filter&gt;</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * ... other config here ...</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * &lt;init-param&gt;</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;param-name&gt;staticSecurityManagerEnabled&lt;/param-name&gt;</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * &lt;param-value&gt;true&lt;/param-value&gt;</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * &lt;/init-param&gt;</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * &lt;/filter&gt;</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * See the Shiro <a href="<a href="http://shiro.apache.org/subject.html" target="alexandria_uri">http://shiro.apache.org/subject.html</a>">Subject documentation</a> for more information as to</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * if you would do this, particularly the sections on the {@code Subject.Builder} and Thread Association.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://shiro.apache.org/subject.html" target="alexandria_uri">http://shiro.apache.org/subject.html</a>">Subject documentation</a></em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html">AbstractShiroFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html">OncePerRequestFilter</a> { |
| <a name="75" href="#75">75</a> |
| <a name="76" href="#76">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 name="77" href="#77">77</a> |
| <a name="78" href="#78">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 name="79" href="#79">79</a> |
| <a name="80" href="#80">80</a> <em class="jxr_comment">// Reference to the security manager used by this filter</em> |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> securityManager; |
| <a name="82" href="#82">82</a> |
| <a name="83" href="#83">83</a> <em class="jxr_comment">// Used to determine which chain should handle an incoming request/response</em> |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> filterChainResolver; |
| <a name="85" href="#85">85</a> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * Whether or not to bind the constructed SecurityManager instance to static memory (via</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * SecurityUtils.setSecurityManager). This was added to support https://issues.apache.org/jira/browse/SHIRO-287</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> staticSecurityManagerEnabled; |
| <a name="92" href="#92">92</a> |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html">AbstractShiroFilter</a>() { |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.staticSecurityManagerEnabled = false; |
| <a name="95" href="#95">95</a> } |
| <a name="96" href="#96">96</a> |
| <a name="97" href="#97">97</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> getSecurityManager() { |
| <a name="98" href="#98">98</a> <strong class="jxr_keyword">return</strong> securityManager; |
| <a name="99" href="#99">99</a> } |
| <a name="100" href="#100">100</a> |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecurityManager(<a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> sm) { |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">this</strong>.securityManager = sm; |
| <a name="103" href="#103">103</a> } |
| <a name="104" href="#104">104</a> |
| <a name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> getFilterChainResolver() { |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> filterChainResolver; |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterChainResolver(<a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> filterChainResolver) { |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">this</strong>.filterChainResolver = filterChainResolver; |
| <a name="111" href="#111">111</a> } |
| <a name="112" href="#112">112</a> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * to static memory (via</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @return {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a></em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStaticSecurityManagerEnabled() { |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">return</strong> staticSecurityManagerEnabled; |
| <a name="131" href="#131">131</a> } |
| <a name="132" href="#132">132</a> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Sets if the constructed {@link #getSecurityManager() securityManager} reference should be bound</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * The default value is {@code false}.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @param staticSecurityManagerEnabled if the constructed {@link #getSecurityManager() securityManager} reference</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * should be bound to static memory (via</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a></em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStaticSecurityManagerEnabled(<strong class="jxr_keyword">boolean</strong> staticSecurityManagerEnabled) { |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">this</strong>.staticSecurityManagerEnabled = staticSecurityManagerEnabled; |
| <a name="147" href="#147">147</a> } |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">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 name="150" href="#150">150</a> <em class="jxr_comment">//added in 1.2 for SHIRO-287:</em> |
| <a name="151" href="#151">151</a> applyStaticSecurityManagerEnabledConfig(); |
| <a name="152" href="#152">152</a> init(); |
| <a name="153" href="#153">153</a> ensureSecurityManager(); |
| <a name="154" href="#154">154</a> <em class="jxr_comment">//added in 1.2 for SHIRO-287:</em> |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (isStaticSecurityManagerEnabled()) { |
| <a name="156" href="#156">156</a> SecurityUtils.setSecurityManager(getSecurityManager()); |
| <a name="157" href="#157">157</a> } |
| <a name="158" href="#158">158</a> } |
| <a name="159" href="#159">159</a> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="161" href="#161">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 name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * sets the {@link #setStaticSecurityManagerEnabled(boolean)} attribute with the configured value.</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a></em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> applyStaticSecurityManagerEnabledConfig() { |
| <a name="168" href="#168">168</a> String value = getInitParam(STATIC_INIT_PARAM_NAME); |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { |
| <a name="170" href="#170">170</a> Boolean b = Boolean.valueOf(value); |
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">if</strong> (b != <strong class="jxr_keyword">null</strong>) { |
| <a name="172" href="#172">172</a> setStaticSecurityManagerEnabled(b); |
| <a name="173" href="#173">173</a> } |
| <a name="174" href="#174">174</a> } |
| <a name="175" href="#175">175</a> } |
| <a name="176" href="#176">176</a> |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="178" href="#178">178</a> } |
| <a name="179" href="#179">179</a> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * A fallback mechanism called in {@link #onFilterConfigSet()} to ensure that the</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * {@link #getSecurityManager() securityManager} property has been set by configuration, and if not,</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * creates one automatically.</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="185" href="#185">185</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> ensureSecurityManager() { |
| <a name="186" href="#186">186</a> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> securityManager = getSecurityManager(); |
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (securityManager == <strong class="jxr_keyword">null</strong>) { |
| <a name="188" href="#188">188</a> log.info(<span class="jxr_string">"No SecurityManager configured. Creating default."</span>); |
| <a name="189" href="#189">189</a> securityManager = createDefaultSecurityManager(); |
| <a name="190" href="#190">190</a> setSecurityManager(securityManager); |
| <a name="191" href="#191">191</a> } |
| <a name="192" href="#192">192</a> } |
| <a name="193" href="#193">193</a> |
| <a name="194" href="#194">194</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/mgt/WebSecurityManager.html">WebSecurityManager</a> createDefaultSecurityManager() { |
| <a name="195" href="#195">195</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/mgt/DefaultWebSecurityManager.html">DefaultWebSecurityManager</a>(); |
| <a name="196" href="#196">196</a> } |
| <a name="197" href="#197">197</a> |
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHttpSessions() { |
| <a name="199" href="#199">199</a> <strong class="jxr_keyword">return</strong> getSecurityManager().isHttpSessionMode(); |
| <a name="200" href="#200">200</a> } |
| <a name="201" href="#201">201</a> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * Wraps the original HttpServletRequest in a {@link ShiroHttpServletRequest}, which is required for supporting</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * Servlet Specification behavior backed by a {@link org.apache.shiro.subject.Subject Subject} instance.</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @param orig the original Servlet Container-provided incoming {@code HttpServletRequest} instance.</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @return {@link ShiroHttpServletRequest ShiroHttpServletRequest} instance wrapping the original.</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">protected</strong> ServletRequest wrapServletRequest(HttpServletRequest orig) { |
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a>(orig, getServletContext(), isHttpSessions()); |
| <a name="212" href="#212">212</a> } |
| <a name="213" href="#213">213</a> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Prepares the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * processing.</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * If the {@code ServletRequest} is an instance of {@link HttpServletRequest}, the value returned from this method</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * is obtained by calling {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)} to allow Shiro-specific</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * HTTP behavior, otherwise the original {@code ServletRequest} argument is returned.</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * @return the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request processing.</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="228" href="#228">228</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>}) |
| <a name="229" href="#229">229</a> <strong class="jxr_keyword">protected</strong> ServletRequest prepareServletRequest(ServletRequest request, ServletResponse response, FilterChain chain) { |
| <a name="230" href="#230">230</a> ServletRequest toUse = request; |
| <a name="231" href="#231">231</a> <strong class="jxr_keyword">if</strong> (request instanceof HttpServletRequest) { |
| <a name="232" href="#232">232</a> HttpServletRequest http = (HttpServletRequest) request; |
| <a name="233" href="#233">233</a> toUse = wrapServletRequest(http); |
| <a name="234" href="#234">234</a> } |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">return</strong> toUse; |
| <a name="236" href="#236">236</a> } |
| <a name="237" href="#237">237</a> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * Returns a new {@link ShiroHttpServletResponse} instance, wrapping the {@code orig} argument, in order to provide</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * correct URL rewriting behavior required by the Servlet Specification when using Shiro-based sessions (and not</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * Servlet Container HTTP-based sessions).</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * @param orig the original {@code HttpServletResponse} instance provided by the Servlet Container.</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @param request the {@code ShiroHttpServletRequest} instance wrapping the original request.</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @return the wrapped ServletResponse instance to use during {@link FilterChain} execution.</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="248" href="#248">248</a> <strong class="jxr_keyword">protected</strong> ServletResponse wrapServletResponse(HttpServletResponse orig, <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html">ShiroHttpServletRequest</a> request) { |
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html">ShiroHttpServletResponse</a>(orig, getServletContext(), request); |
| <a name="250" href="#250">250</a> } |
| <a name="251" href="#251">251</a> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * Prepares the {@code ServletResponse} instance that will be passed to the {@code FilterChain} for request</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * processing.</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * This implementation delegates to {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)}</em> |
| <a name="257" href="#257">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 name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * {@link ShiroHttpServletRequest}. This ensures that any URL rewriting that occurs is handled correctly using the</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * Shiro-managed Session's sessionId and not a servlet container session ID.</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="261" href="#261">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 name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * {@code ServletResponse} argument as-is, relying on the default Servlet Container URL rewriting logic.</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @return the {@code ServletResponse} instance that will be passed to the {@code FilterChain} during request processing.</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="270" href="#270">270</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>}) |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">protected</strong> ServletResponse prepareServletResponse(ServletRequest request, ServletResponse response, FilterChain chain) { |
| <a name="272" href="#272">272</a> ServletResponse toUse = response; |
| <a name="273" href="#273">273</a> <strong class="jxr_keyword">if</strong> (!isHttpSessions() && (request instanceof ShiroHttpServletRequest) && |
| <a name="274" href="#274">274</a> (response instanceof HttpServletResponse)) { |
| <a name="275" href="#275">275</a> <em class="jxr_comment">//the ShiroHttpServletResponse exists to support URL rewriting for session ids. This is only needed if</em> |
| <a name="276" href="#276">276</a> <em class="jxr_comment">//using Shiro sessions (i.e. not simple HttpSession based sessions):</em> |
| <a name="277" href="#277">277</a> toUse = wrapServletResponse((HttpServletResponse) response, (ShiroHttpServletRequest) request); |
| <a name="278" href="#278">278</a> } |
| <a name="279" href="#279">279</a> <strong class="jxr_keyword">return</strong> toUse; |
| <a name="280" href="#280">280</a> } |
| <a name="281" href="#281">281</a> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="283" href="#283">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 name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * throughout the request/response execution.</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * @param request the incoming {@code ServletRequest}</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * @param response the outgoing {@code ServletResponse}</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * @return the {@code WebSubject} instance to associate with the request/response execution</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="291" href="#291">291</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html">WebSubject</a> createSubject(ServletRequest request, ServletResponse response) { |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> WebSubject.Builder(getSecurityManager(), request, response).buildWebSubject(); |
| <a name="293" href="#293">293</a> } |
| <a name="294" href="#294">294</a> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="296" href="#296">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 name="297" href="#297">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 name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * session ({@code subject.getSession(false) == null}), this method does nothing.</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * <p/>This method implementation merely calls</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * <code>Session.{@link org.apache.shiro.session.Session#touch() touch}()</code> on the session.</em> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * @param request incoming request - ignored, but available to subclasses that might wish to override this method</em> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * @param response outgoing response - ignored, but available to subclasses that might wish to override this method</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="306" href="#306">306</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>}) |
| <a name="307" href="#307">307</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> updateSessionLastAccessTime(ServletRequest request, ServletResponse response) { |
| <a name="308" href="#308">308</a> <strong class="jxr_keyword">if</strong> (!isHttpSessions()) { <em class="jxr_comment">//'native' sessions</em> |
| <a name="309" href="#309">309</a> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = SecurityUtils.getSubject(); |
| <a name="310" href="#310">310</a> <em class="jxr_comment">//Subject should never _ever_ be null, but just in case:</em> |
| <a name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (subject != <strong class="jxr_keyword">null</strong>) { |
| <a name="312" href="#312">312</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="313" href="#313">313</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="314" href="#314">314</a> <strong class="jxr_keyword">try</strong> { |
| <a name="315" href="#315">315</a> session.touch(); |
| <a name="316" href="#316">316</a> } <strong class="jxr_keyword">catch</strong> (Throwable t) { |
| <a name="317" href="#317">317</a> log.error(<span class="jxr_string">"session.touch() method invocation has failed. Unable to update"</span> + |
| <a name="318" href="#318">318</a> <span class="jxr_string">"the corresponding session's last access time based on the incoming request."</span>, t); |
| <a name="319" href="#319">319</a> } |
| <a name="320" href="#320">320</a> } |
| <a name="321" href="#321">321</a> } |
| <a name="322" href="#322">322</a> } |
| <a name="323" href="#323">323</a> } |
| <a name="324" href="#324">324</a> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * {@code doFilterInternal} implementation that sets-up, executes, and cleans-up a Shiro-filtered request. It</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * performs the following ordered operations:</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * <li>{@link #prepareServletRequest(ServletRequest, ServletResponse, FilterChain) Prepares}</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * the incoming {@code ServletRequest} for use during Shiro's processing</li></em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * <li>{@link #prepareServletResponse(ServletRequest, ServletResponse, FilterChain) Prepares}</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * the outgoing {@code ServletResponse} for use during Shiro's processing</li></em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * <li> {@link #createSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) Creates} a</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * {@link Subject} instance based on the specified request/response pair.</li></em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * <li>Finally {@link Subject#execute(Runnable) executes} the</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * {@link #updateSessionLastAccessTime(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} and</em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * {@link #executeChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)}</em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * methods</li></em> |
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="341" href="#341">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 name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * implementation technique to guarantee proper thread binding and restoration is completed successfully.</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * @param servletRequest the incoming {@code ServletRequest}</em> |
| <a name="345" href="#345">345</a> <em class="jxr_javadoccomment"> * @param servletResponse the outgoing {@code ServletResponse}</em> |
| <a name="346" href="#346">346</a> <em class="jxr_javadoccomment"> * @param chain the container-provided {@code FilterChain} to execute</em> |
| <a name="347" href="#347">347</a> <em class="jxr_javadoccomment"> * @throws IOException if an IO error occurs</em> |
| <a name="348" href="#348">348</a> <em class="jxr_javadoccomment"> * @throws javax.servlet.ServletException if an Throwable other than an IOException</em> |
| <a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="350" href="#350">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 name="351" href="#351">351</a> <strong class="jxr_keyword">throws</strong> ServletException, IOException { |
| <a name="352" href="#352">352</a> |
| <a name="353" href="#353">353</a> Throwable t = <strong class="jxr_keyword">null</strong>; |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> <strong class="jxr_keyword">try</strong> { |
| <a name="356" href="#356">356</a> <strong class="jxr_keyword">final</strong> ServletRequest request = prepareServletRequest(servletRequest, servletResponse, chain); |
| <a name="357" href="#357">357</a> <strong class="jxr_keyword">final</strong> ServletResponse response = prepareServletResponse(request, servletResponse, chain); |
| <a name="358" href="#358">358</a> |
| <a name="359" href="#359">359</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = createSubject(request, response); |
| <a name="360" href="#360">360</a> |
| <a name="361" href="#361">361</a> <em class="jxr_comment">//noinspection unchecked</em> |
| <a name="362" href="#362">362</a> subject.execute(<strong class="jxr_keyword">new</strong> Callable() { |
| <a name="363" href="#363">363</a> <strong class="jxr_keyword">public</strong> Object call() <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="364" href="#364">364</a> updateSessionLastAccessTime(request, response); |
| <a name="365" href="#365">365</a> executeChain(request, response, chain); |
| <a name="366" href="#366">366</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="367" href="#367">367</a> } |
| <a name="368" href="#368">368</a> }); |
| <a name="369" href="#369">369</a> } <strong class="jxr_keyword">catch</strong> (ExecutionException ex) { |
| <a name="370" href="#370">370</a> t = ex.getCause(); |
| <a name="371" href="#371">371</a> } <strong class="jxr_keyword">catch</strong> (Throwable throwable) { |
| <a name="372" href="#372">372</a> t = throwable; |
| <a name="373" href="#373">373</a> } |
| <a name="374" href="#374">374</a> |
| <a name="375" href="#375">375</a> <strong class="jxr_keyword">if</strong> (t != <strong class="jxr_keyword">null</strong>) { |
| <a name="376" href="#376">376</a> <strong class="jxr_keyword">if</strong> (t instanceof ServletException) { |
| <a name="377" href="#377">377</a> <strong class="jxr_keyword">throw</strong> (ServletException) t; |
| <a name="378" href="#378">378</a> } |
| <a name="379" href="#379">379</a> <strong class="jxr_keyword">if</strong> (t instanceof IOException) { |
| <a name="380" href="#380">380</a> <strong class="jxr_keyword">throw</strong> (IOException) t; |
| <a name="381" href="#381">381</a> } |
| <a name="382" href="#382">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 name="383" href="#383">383</a> String msg = <span class="jxr_string">"Filtered request failed."</span>; |
| <a name="384" href="#384">384</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ServletException(msg, t); |
| <a name="385" href="#385">385</a> } |
| <a name="386" href="#386">386</a> } |
| <a name="387" href="#387">387</a> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * Returns the {@code FilterChain} to execute for the given request.</em> |
| <a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * The {@code origChain} argument is the</em> |
| <a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * original {@code FilterChain} supplied by the Servlet Container, but it may be modified to provide</em> |
| <a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * more behavior by pre-pending further chains according to the Shiro configuration.</em> |
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * This implementation returns the chain that will actually be executed by acquiring the chain from a</em> |
| <a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * {@link #getFilterChainResolver() filterChainResolver}. The resolver determines exactly which chain to</em> |
| <a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * execute, typically based on URL configuration. If no chain is returned from the resolver call</em> |
| <a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * (returns {@code null}), then the {@code origChain} will be returned by default.</em> |
| <a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="402" href="#402">402</a> <em class="jxr_javadoccomment"> * @param origChain the original {@code FilterChain} provided by the Servlet Container</em> |
| <a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> * @return the {@link FilterChain} to execute for the given request</em> |
| <a name="404" href="#404">404</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="406" href="#406">406</a> <strong class="jxr_keyword">protected</strong> FilterChain getExecutionChain(ServletRequest request, ServletResponse response, FilterChain origChain) { |
| <a name="407" href="#407">407</a> FilterChain chain = origChain; |
| <a name="408" href="#408">408</a> |
| <a name="409" href="#409">409</a> <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html">FilterChainResolver</a> resolver = getFilterChainResolver(); |
| <a name="410" href="#410">410</a> <strong class="jxr_keyword">if</strong> (resolver == <strong class="jxr_keyword">null</strong>) { |
| <a name="411" href="#411">411</a> log.debug(<span class="jxr_string">"No FilterChainResolver configured. Returning original FilterChain."</span>); |
| <a name="412" href="#412">412</a> <strong class="jxr_keyword">return</strong> origChain; |
| <a name="413" href="#413">413</a> } |
| <a name="414" href="#414">414</a> |
| <a name="415" href="#415">415</a> FilterChain resolved = resolver.getChain(request, response, origChain); |
| <a name="416" href="#416">416</a> <strong class="jxr_keyword">if</strong> (resolved != <strong class="jxr_keyword">null</strong>) { |
| <a name="417" href="#417">417</a> log.trace(<span class="jxr_string">"Resolved a configured FilterChain for the current request."</span>); |
| <a name="418" href="#418">418</a> chain = resolved; |
| <a name="419" href="#419">419</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="420" href="#420">420</a> log.trace(<span class="jxr_string">"No FilterChain configured for the current request. Using the default."</span>); |
| <a name="421" href="#421">421</a> } |
| <a name="422" href="#422">422</a> |
| <a name="423" href="#423">423</a> <strong class="jxr_keyword">return</strong> chain; |
| <a name="424" href="#424">424</a> } |
| <a name="425" href="#425">425</a> |
| <a name="426" href="#426">426</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * Executes a {@link FilterChain} for the given request.</em> |
| <a name="428" href="#428">428</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * This implementation first delegates to</em> |
| <a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> * <code>{@link #getExecutionChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) getExecutionChain}</code></em> |
| <a name="431" href="#431">431</a> <em class="jxr_javadoccomment"> * to allow the application's Shiro configuration to determine exactly how the chain should execute. The resulting</em> |
| <a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> * value from that call is then executed directly by calling the returned {@code FilterChain}'s</em> |
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment"> * {@link FilterChain#doFilter doFilter} method. That is:</em> |
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> * FilterChain chain = {@link #getExecutionChain}(request, response, origChain);</em> |
| <a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> * chain.{@link FilterChain#doFilter doFilter}(request,response);</pre></em> |
| <a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * @param origChain the Servlet Container-provided chain that may be wrapped further by an application-configured</em> |
| <a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * chain of Filters.</em> |
| <a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> * @throws IOException if the underlying {@code chain.doFilter} call results in an IOException</em> |
| <a name="443" href="#443">443</a> <em class="jxr_javadoccomment"> * @throws ServletException if the underlying {@code chain.doFilter} call results in a ServletException</em> |
| <a name="444" href="#444">444</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="445" href="#445">445</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="446" href="#446">446</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeChain(ServletRequest request, ServletResponse response, FilterChain origChain) |
| <a name="447" href="#447">447</a> <strong class="jxr_keyword">throws</strong> IOException, ServletException { |
| <a name="448" href="#448">448</a> FilterChain chain = getExecutionChain(request, response, origChain); |
| <a name="449" href="#449">449</a> chain.doFilter(request, response); |
| <a name="450" href="#450">450</a> } |
| <a name="451" href="#451">451</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
