| <!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>AbstractFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/AbstractFilter.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.util.StringUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterConfig; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Base abstract Filter simplifying Filter initialization and {@link #getInitParam(String) access} to init parameters.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Subclass initialization logic should be performed by overriding the {@link #onFilterConfigSet()} template method.</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * FilterChain execution logic (the</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * {@link #doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)} method</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * is left to subclasses.</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="38" href="#38">38</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/AbstractFilter.html">AbstractFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html">ServletContextSupport</a> implements Filter { |
| <a name="39" href="#39">39</a> |
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(AbstractFilter.<strong class="jxr_keyword">class</strong>); |
| <a name="41" href="#41">41</a> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * FilterConfig provided by the Servlet container at start-up.</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">protected</strong> FilterConfig filterConfig; |
| <a name="46" href="#46">46</a> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Returns the servlet container specified {@code FilterConfig} instance provided at</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@link #init(javax.servlet.FilterConfig) startup}.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return the servlet container specified {@code FilterConfig} instance provided at start-up.</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> FilterConfig getFilterConfig() { |
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">return</strong> filterConfig; |
| <a name="55" href="#55">55</a> } |
| <a name="56" href="#56">56</a> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Sets the FilterConfig <em>and</em> the {@code ServletContext} as attributes of this class for use by</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * subclasses. That is:</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * this.filterConfig = filterConfig;</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * setServletContext(filterConfig.getServletContext());</pre></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param filterConfig the FilterConfig instance provided by the Servlet container at start-up.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFilterConfig(FilterConfig filterConfig) { |
| <a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.filterConfig = filterConfig; |
| <a name="68" href="#68">68</a> setServletContext(filterConfig.getServletContext()); |
| <a name="69" href="#69">69</a> } |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Returns the value for the named {@code init-param}, or {@code null} if there was no {@code init-param}</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * specified by that name.</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param paramName the name of the {@code init-param}</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @return the value for the named {@code init-param}, or {@code null} if there was no {@code init-param}</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * specified by that name.</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">protected</strong> String getInitParam(String paramName) { |
| <a name="80" href="#80">80</a> FilterConfig config = getFilterConfig(); |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (config != <strong class="jxr_keyword">null</strong>) { |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> StringUtils.clean(config.getInitParameter(paramName)); |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="85" href="#85">85</a> } |
| <a name="86" href="#86">86</a> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * Sets the filter's {@link #setFilterConfig filterConfig} and then immediately calls</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * {@link #onFilterConfigSet() onFilterConfigSet()} to trigger any processing a subclass might wish to perform.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param filterConfig the servlet container supplied FilterConfig instance.</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @throws javax.servlet.ServletException if {@link #onFilterConfigSet() onFilterConfigSet()} throws an Exception.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> init(FilterConfig filterConfig) <strong class="jxr_keyword">throws</strong> ServletException { |
| <a name="95" href="#95">95</a> setFilterConfig(filterConfig); |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">try</strong> { |
| <a name="97" href="#97">97</a> onFilterConfigSet(); |
| <a name="98" href="#98">98</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (e instanceof ServletException) { |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">throw</strong> (ServletException) e; |
| <a name="101" href="#101">101</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (log.isErrorEnabled()) { |
| <a name="103" href="#103">103</a> log.error(<span class="jxr_string">"Unable to start Filter: ["</span> + e.getMessage() + <span class="jxr_string">"]."</span>, e); |
| <a name="104" href="#104">104</a> } |
| <a name="105" href="#105">105</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ServletException(e); |
| <a name="106" href="#106">106</a> } |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> } |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Template method to be overridden by subclasses to perform initialization logic at start-up. The</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * {@code ServletContext} and {@code FilterConfig} will be accessible</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * (and non-{@code null}) at the time this method is invoked via the</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * {@link #getServletContext() getServletContext()} and {@link #getFilterConfig() getFilterConfig()}</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * methods respectively.</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * {@code init-param} values may be conveniently obtained via the {@link #getInitParam(String)} method.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @throws Exception if the subclass has an error upon initialization.</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">void</strong> onFilterConfigSet() <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="122" href="#122">122</a> } |
| <a name="123" href="#123">123</a> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Default no-op implementation that can be overridden by subclasses for custom cleanup behavior.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() { |
| <a name="128" href="#128">128</a> } |
| <a name="129" href="#129">129</a> |
| <a name="130" href="#130">130</a> |
| <a name="131" href="#131">131</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
