| <!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>OncePerRequestFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/OncePerRequestFilter.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." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</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.slf4j.Logger; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Filter base class that guarantees to be just executed once per request,</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * on any servlet container. It provides a {@link #doFilterInternal}</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * method with HttpServletRequest and HttpServletResponse arguments.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * The {@link #getAlreadyFilteredAttributeName} method determines how</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * to identify that a request is already filtered. The default implementation</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * is based on the configured name of the concrete filter instance.</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <h3>Controlling filter execution</h3></em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * 1.2 introduced the {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method and</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * {@link #isEnabled()} property to allow explicit controll over whether the filter executes (or allows passthrough)</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * for any given request.</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <b>NOTE</b> This class was initially borrowed from the Spring framework but has continued modifications.</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</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/OncePerRequestFilter.html">OncePerRequestFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html">NameableFilter</a> { |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Private internal log instance.</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(OncePerRequestFilter.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Suffix that gets appended to the filter name for the "already filtered" request attribute.</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @see #getAlreadyFilteredAttributeName</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ALREADY_FILTERED_SUFFIX = <span class="jxr_string">".FILTERED"</span>; |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Determines generally if this filter should execute or let requests fall through to the next chain element.</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @see #isEnabled()</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enabled = <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//most filters wish to execute when configured, so default to true</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this filter should <em>generally</em><b>*</b> execute for any request,</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * {@code false} if it should let the request/response pass through immediately to the next</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * element in the {@link FilterChain}. The default value is {@code true}, as most filters would inherently need</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * to execute when configured.</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * <b>*</b> This configuration property is for general configuration for any request that comes through</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * the filter. The</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isEnabled(request,response)}</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * method actually determines whether or not if the filter is enabled based on the current request.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @return {@code true} if this filter should <em>generally</em> execute, {@code false} if it should let the</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * request/response pass through immediately to the next element in the {@link FilterChain}.</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEnabled() { |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> enabled; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> } |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Sets whether or not this filter <em>generally</em> executes for any request. See the</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * {@link #isEnabled() isEnabled()} JavaDoc as to what <em>general</em> execution means.</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> <em class="jxr_javadoccomment"> * @param enabled whether or not this filter <em>generally</em> executes.</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEnabled(<strong class="jxr_keyword">boolean</strong> enabled) { |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.enabled = enabled; |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> } |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * This {@code doFilter} implementation stores a request attribute for</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * "already filtered", proceeding without filtering again if the</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * attribute is already there.</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @see #getAlreadyFilteredAttributeName</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @see #shouldNotFilter</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @see #doFilterInternal</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">throws</strong> ServletException, IOException { |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName(); |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> ( request.getAttribute(alreadyFilteredAttributeName) != <strong class="jxr_keyword">null</strong> ) { |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> log.trace(<span class="jxr_string">"Filter '{}' already executed. Proceeding without invoking this filter."</span>, getName()); |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> filterChain.doFilter(request, response); |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> } <strong class="jxr_keyword">else</strong> <em class="jxr_comment">//noinspection deprecation</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (<em class="jxr_comment">/* added in 1.2: */</em> !isEnabled(request, response) || |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">/* retain backwards compatibility: */</em> shouldNotFilter(request) ) { |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> log.debug(<span class="jxr_string">"Filter '{}' is not enabled for the current request. Proceeding without invoking this filter."</span>, |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> getName()); |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> filterChain.doFilter(request, response); |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_comment">// Do invoke this filter...</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> log.trace(<span class="jxr_string">"Filter '{}' not yet executed. Executing now."</span>, getName()); |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> request.setAttribute(alreadyFilteredAttributeName, Boolean.TRUE); |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> doFilterInternal(request, response, filterChain); |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> } <strong class="jxr_keyword">finally</strong> { |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_comment">// Once the request has finished, we're done and we don't</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_comment">// need to mark as 'already filtered' any more.</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> request.removeAttribute(alreadyFilteredAttributeName); |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> } |
| <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> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this filter should filter the specified request, {@code false} if it should let the</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * request/response pass through immediately to the next element in the {@code FilterChain}.</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * This default implementation merely returns the value of {@link #isEnabled() isEnabled()}, which is</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * {@code true} by default (to ensure the filter always executes by default), but it can be overridden by</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * subclasses for request-specific behavior if necessary. For example, a filter could be enabled or disabled</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * based on the request path being accessed.</em> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * <b>Helpful Hint:</b> if your subclass extends {@link org.apache.shiro.web.filter.PathMatchingFilter PathMatchingFilter},</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * you may wish to instead override the</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.filter.PathMatchingFilter#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * PathMatchingFilter.isEnabled(request,response,path,pathSpecificConfig)}</em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * method if you want to make your enable/disable decision based on any path-specific configuration.</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @param request the incoming servlet request</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @param response the outbound servlet response</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</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 class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * request/response pass through immediately to the next element in the {@code FilterChain}.</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @throws IOException in the case of any IO error</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @throws ServletException in the case of any error</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.web.filter.PathMatchingFilter#isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String, Object)</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> @SuppressWarnings({<span class="jxr_string">"UnusedParameters"</span>}) |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isEnabled(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> ServletException, IOException { |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">return</strong> isEnabled(); |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> } |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> |
| <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"> * Return name of the request attribute that identifies that a request has already been filtered.</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * The default implementation takes the configured {@link #getName() name} and appends &quot;{@code .FILTERED}&quot;.</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * If the filter is not fully initialized, it falls back to the implementation's class name.</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @return the name of the request attribute that identifies that a request has already been filtered.</em> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @see #getName</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @see #ALREADY_FILTERED_SUFFIX</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">protected</strong> String getAlreadyFilteredAttributeName() { |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> String name = getName(); |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> name = getClass().getName(); |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> } |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> name + ALREADY_FILTERED_SUFFIX; |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> } |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * Can be overridden in subclasses for custom filtering control,</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * returning <code>true</code> to avoid filtering of the given request.</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * <p>The default implementation always returns <code>false</code>.</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @param request current HTTP request</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * @return whether the given request should <i>not</i> be filtered</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @throws ServletException in case of errors</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @deprecated in favor of overriding {@link #isEnabled(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * for custom behavior. This method will be removed in Shiro 2.0.</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> @Deprecated |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>}) |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> shouldNotFilter(ServletRequest request) <strong class="jxr_keyword">throws</strong> ServletException { |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">return</strong> false; |
| <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> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * Same contract as for</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * {@link #doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)},</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * but guaranteed to be invoked only once per request.</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @param request incoming {@code ServletRequest}</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @param response outgoing {@code ServletResponse}</em> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @param chain the {@code FilterChain} to execute</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @throws ServletException if there is a problem processing the request</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @throws IOException if there is an I/O problem processing the request</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> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> doFilterInternal(ServletRequest request, ServletResponse response, FilterChain chain) |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">throws</strong> ServletException, IOException; |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
