| <!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>PathMatchingFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/filter/PathMatchingFilter.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.filter; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.AntPathMatcher; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.PatternMatcher; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.AdviceFilter; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashMap; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a name="34" href="#34">34</a> |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.shiro.util.StringUtils.split; |
| <a name="36" href="#36">36</a> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p>Base class for Filters that will process only specified paths and allow all others to pass through.</p></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="42" href="#42">42</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/filter/PathMatchingFilter.html">PathMatchingFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/servlet/AdviceFilter.html">AdviceFilter</a> implements <a href="../../../../../org/apache/shiro/web/filter/PathConfigProcessor.html">PathConfigProcessor</a> { |
| <a name="43" href="#43">43</a> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Log available to this class only</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(PathMatchingFilter.<strong class="jxr_keyword">class</strong>); |
| <a name="48" href="#48">48</a> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * PatternMatcher used in determining which paths to react to for a given request.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/PatternMatcher.html">PatternMatcher</a> pathMatcher = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/util/AntPathMatcher.html">AntPathMatcher</a>(); |
| <a name="53" href="#53">53</a> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * A collection of path-to-config entries where the key is a path which this filter should process and</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * the value is the (possibly null) configuration element specific to this Filter for that specific path.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p>To put it another way, the keys are the paths (urls) that this Filter will process.</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <p>The values are filter-specific data that this Filter should use when processing the corresponding</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * key (path). The values can be null if no Filter-specific config was specified for that url.</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">protected</strong> Map<String, Object> appliedPaths = <strong class="jxr_keyword">new</strong> LinkedHashMap<String, Object>(); |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Splits any comma-delmited values that might be found in the <code>config</code> argument and sets the resulting</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * <code>String[]</code> array on the <code>appliedPaths</code> internal Map.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * That is:</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <pre><code></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * String[] values = null;</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * if (config != null) {</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * values = split(config);</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * }</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * this.{@link #appliedPaths appliedPaths}.put(path, values);</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * </code></pre></em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param path the application context path to match for executing this filter.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param config the specified for <em>this particular filter only</em> for the given <code>path</code></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @return this configured filter.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> Filter processPathConfig(String path, String config) { |
| <a name="83" href="#83">83</a> String[] values = <strong class="jxr_keyword">null</strong>; |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> (config != <strong class="jxr_keyword">null</strong>) { |
| <a name="85" href="#85">85</a> values = split(config); |
| <a name="86" href="#86">86</a> } |
| <a name="87" href="#87">87</a> |
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">this</strong>.appliedPaths.put(path, values); |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="90" href="#90">90</a> } |
| <a name="91" href="#91">91</a> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Returns the context path within the application based on the specified <code>request</code>.</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * {@link WebUtils#getPathWithinApplication(javax.servlet.http.HttpServletRequest) WebUtils.getPathWithinApplication(request)},</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * but can be overridden by subclasses for custom logic.</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return the context path within the application.</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">protected</strong> String getPathWithinApplication(ServletRequest request) { |
| <a name="103" href="#103">103</a> <strong class="jxr_keyword">return</strong> WebUtils.getPathWithinApplication(WebUtils.toHttp(request)); |
| <a name="104" href="#104">104</a> } |
| <a name="105" href="#105">105</a> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if the incoming <code>request</code> matches the specified <code>path</code> pattern,</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * The default implementation acquires the <code>request</code>'s path within the application and determines</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * if that matches:</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * <code>String requestURI = {@link #getPathWithinApplication(javax.servlet.ServletRequest) getPathWithinApplication(request)};<br/></em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * return {@link #pathsMatch(String, String) pathsMatch(path,requestURI)}</code></em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @param path the configured url pattern to check the incoming request against.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the incoming <code>request</code> matches the specified <code>path</code> pattern,</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> pathsMatch(String path, ServletRequest request) { |
| <a name="122" href="#122">122</a> String requestURI = getPathWithinApplication(request); |
| <a name="123" href="#123">123</a> log.trace(<span class="jxr_string">"Attempting to match pattern '{}' with current requestURI '{}'..."</span>, path, requestURI); |
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> pathsMatch(path, requestURI); |
| <a name="125" href="#125">125</a> } |
| <a name="126" href="#126">126</a> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if the <code>path</code> matches the specified <code>pattern</code> string,</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Simply delegates to</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * <b><code>this.pathMatcher.{@link PatternMatcher#matches(String, String) matches(pattern,path)}</code></b>,</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * but can be overridden by subclasses for custom matching behavior.</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @param pattern the pattern to match against</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @param path the value to match with the specified <code>pattern</code></em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the <code>path</code> matches the specified <code>pattern</code> string,</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="140" href="#140">140</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> pathsMatch(String pattern, String path) { |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> pathMatcher.matches(pattern, path); |
| <a name="142" href="#142">142</a> } |
| <a name="143" href="#143">143</a> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * Implementation that handles path-matching behavior before a request is evaluated. If the path matches and</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * the filter</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object) isEnabled} for</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * that path/config, the request will be allowed through via the result from</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * {@link #onPreHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) onPreHandle}. If the</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * path does not match or the filter is not enabled for that path, this filter will allow passthrough immediately</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * to allow the {@code FilterChain} to continue executing.</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * In order to retain path-matching functionality, subclasses should not override this method if at all</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * possible, and instead override</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * {@link #onPreHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) onPreHandle} instead.</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @return {@code true} if the filter chain is allowed to continue to execute, {@code false} if a subclass has</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * handled the request explicitly.</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="163" href="#163">163</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> preHandle(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.appliedPaths == <strong class="jxr_keyword">null</strong> || <strong class="jxr_keyword">this</strong>.appliedPaths.isEmpty()) { |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="167" href="#167">167</a> log.trace(<span class="jxr_string">"appliedPaths property is null or empty. This Filter will passthrough immediately."</span>); |
| <a name="168" href="#168">168</a> } |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="170" href="#170">170</a> } |
| <a name="171" href="#171">171</a> |
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">for</strong> (String path : <strong class="jxr_keyword">this</strong>.appliedPaths.keySet()) { |
| <a name="173" href="#173">173</a> <em class="jxr_comment">// If the path does match, then pass on to the subclass implementation for specific checks</em> |
| <a name="174" href="#174">174</a> <em class="jxr_comment">//(first match 'wins'):</em> |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">if</strong> (pathsMatch(path, request)) { |
| <a name="176" href="#176">176</a> log.trace(<span class="jxr_string">"Current requestURI matches pattern '{}'. Determining filter chain execution..."</span>, path); |
| <a name="177" href="#177">177</a> Object config = <strong class="jxr_keyword">this</strong>.appliedPaths.get(path); |
| <a name="178" href="#178">178</a> <strong class="jxr_keyword">return</strong> isFilterChainContinued(request, response, path, config); |
| <a name="179" href="#179">179</a> } |
| <a name="180" href="#180">180</a> } |
| <a name="181" href="#181">181</a> |
| <a name="182" href="#182">182</a> <em class="jxr_comment">//no path matched, allow the request to go through:</em> |
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="184" href="#184">184</a> } |
| <a name="185" href="#185">185</a> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * Simple method to abstract out logic from the preHandle implementation - it was getting a bit unruly.</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="191" href="#191">191</a> @SuppressWarnings({<span class="jxr_string">"JavaDoc"</span>}) |
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isFilterChainContinued(ServletRequest request, ServletResponse response, |
| <a name="193" href="#193">193</a> String path, Object pathConfig) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="194" href="#194">194</a> |
| <a name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> (isEnabled(request, response, path, pathConfig)) { <em class="jxr_comment">//isEnabled check added in 1.2</em> |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="197" href="#197">197</a> log.trace(<span class="jxr_string">"Filter '{}' is enabled for the current request under path '{}' with config [{}]. "</span> + |
| <a name="198" href="#198">198</a> <span class="jxr_string">"Delegating to subclass implementation for 'onPreHandle' check."</span>, |
| <a name="199" href="#199">199</a> <strong class="jxr_keyword">new</strong> Object[]{getName(), path, pathConfig}); |
| <a name="200" href="#200">200</a> } |
| <a name="201" href="#201">201</a> <em class="jxr_comment">//The filter is enabled for this specific request, so delegate to subclass implementations</em> |
| <a name="202" href="#202">202</a> <em class="jxr_comment">//so they can decide if the request should continue through the chain or not:</em> |
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> onPreHandle(request, response, pathConfig); |
| <a name="204" href="#204">204</a> } |
| <a name="205" href="#205">205</a> |
| <a name="206" href="#206">206</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="207" href="#207">207</a> log.trace(<span class="jxr_string">"Filter '{}' is disabled for the current request under path '{}' with config [{}]. "</span> + |
| <a name="208" href="#208">208</a> <span class="jxr_string">"The next element in the FilterChain will be called immediately."</span>, |
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">new</strong> Object[]{getName(), path, pathConfig}); |
| <a name="210" href="#210">210</a> } |
| <a name="211" href="#211">211</a> <em class="jxr_comment">//This filter is disabled for this specific request,</em> |
| <a name="212" href="#212">212</a> <em class="jxr_comment">//return 'true' immediately to indicate that the filter will not process the request</em> |
| <a name="213" href="#213">213</a> <em class="jxr_comment">//and let the request/response to continue through the filter chain:</em> |
| <a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="215" href="#215">215</a> } |
| <a name="216" href="#216">216</a> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * This default implementation always returns {@code true} and should be overridden by subclasses for custom</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * logic if necessary.</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletResponse</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * @return {@code true} if the request should be able to continue, {@code false} if the filter will</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * handle the response directly.</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * @see #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)</em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="229" href="#229">229</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="230" href="#230">230</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="231" href="#231">231</a> } |
| <a name="232" href="#232">232</a> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * Path-matching version of the parent class's</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method, but additionally allows</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * for inspection of any path-specific configuration values corresponding to the specified request. Subclasses</em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * may wish to inspect this additional mapped configuration to determine if the filter is enabled or not.</em> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * This method's default implementation ignores the {@code path} and {@code mappedValue} arguments and merely</em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * returns the value from a call to {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}.</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * It is expected that subclasses override this method if they need to perform enable/disable logic for a specific</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * request based on any path-specific config for the filter instance.</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @param request the incoming servlet request</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @param response the outbound servlet response</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * @param path the path matched for the incoming servlet request that has been configured with the given {@code mappedValue}.</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings for the given {@code path}.</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * @return {@code true} if this filter should filter the specified request, {@code false} if it should let the</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * request/response pass through immediately to the next element in the {@code FilterChain}.</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @throws Exception in the case of any error</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="253" href="#253">253</a> @SuppressWarnings({<span class="jxr_string">"UnusedParameters"</span>}) |
| <a name="254" href="#254">254</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isEnabled(ServletRequest request, ServletResponse response, String path, Object mappedValue) |
| <a name="255" href="#255">255</a> <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="256" href="#256">256</a> <strong class="jxr_keyword">return</strong> isEnabled(request, response); |
| <a name="257" href="#257">257</a> } |
| <a name="258" href="#258">258</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
