| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.servlet;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.StringUtils;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.Filter;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.FilterConfig;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.ServletException;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">/**</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * Base abstract Filter simplifying Filter initialization and {@link #getInitParam(String) access} to init parameters.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * Subclass initialization logic should be performed by overriding the {@link #onFilterConfigSet()} template method.</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * FilterChain execution logic (the</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * {@link #doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)} method</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * is left to subclasses.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> *</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @since 1.0</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> */</a> |
| <span class="sourceLineNo">038</span><a id="line.38">public abstract class AbstractFilter extends ServletContextSupport implements Filter {</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> private static transient final Logger log = LoggerFactory.getLogger(AbstractFilter.class);</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * FilterConfig provided by the Servlet container at start-up.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> */</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> protected FilterConfig filterConfig;</a> |
| <span class="sourceLineNo">046</span><a id="line.46"></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> /**</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * Returns the servlet container specified {@code FilterConfig} instance provided at</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * {@link #init(javax.servlet.FilterConfig) startup}.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> *</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * @return the servlet container specified {@code FilterConfig} instance provided at start-up.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> */</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> public FilterConfig getFilterConfig() {</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> return filterConfig;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> }</a> |
| <span class="sourceLineNo">056</span><a id="line.56"></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> /**</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * Sets the FilterConfig <em>and</em> the {@code ServletContext} as attributes of this class for use by</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * subclasses. That is:</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * <pre></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * this.filterConfig = filterConfig;</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * setServletContext(filterConfig.getServletContext());</pre></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> *</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * @param filterConfig the FilterConfig instance provided by the Servlet container at start-up.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> */</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> public void setFilterConfig(FilterConfig filterConfig) {</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> this.filterConfig = filterConfig;</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> setServletContext(filterConfig.getServletContext());</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> /**</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * Returns the value for the named {@code init-param}, or {@code null} if there was no {@code init-param}</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * specified by that name.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> *</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @param paramName the name of the {@code init-param}</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * @return the value for the named {@code init-param}, or {@code null} if there was no {@code init-param}</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * specified by that name.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> */</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> protected String getInitParam(String paramName) {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> FilterConfig config = getFilterConfig();</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> if (config != null) {</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> return StringUtils.clean(config.getInitParameter(paramName));</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> }</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> return null;</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> }</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> /**</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * Sets the filter's {@link #setFilterConfig filterConfig} and then immediately calls</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * {@link #onFilterConfigSet() onFilterConfigSet()} to trigger any processing a subclass might wish to perform.</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> *</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * @param filterConfig the servlet container supplied FilterConfig instance.</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> * @throws javax.servlet.ServletException if {@link #onFilterConfigSet() onFilterConfigSet()} throws an Exception.</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> */</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> public final void init(FilterConfig filterConfig) throws ServletException {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> setFilterConfig(filterConfig);</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> try {</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> onFilterConfigSet();</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> if (e instanceof ServletException) {</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> throw (ServletException) e;</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> } else {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> if (log.isErrorEnabled()) {</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> log.error("Unable to start Filter: [" + e.getMessage() + "].", e);</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> }</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> throw new ServletException(e);</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> }</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> }</a> |
| <span class="sourceLineNo">109</span><a id="line.109"></a> |
| <span class="sourceLineNo">110</span><a id="line.110"> /**</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> * Template method to be overridden by subclasses to perform initialization logic at start-up. The</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * {@code ServletContext} and {@code FilterConfig} will be accessible</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * (and non-{@code null}) at the time this method is invoked via the</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * {@link #getServletContext() getServletContext()} and {@link #getFilterConfig() getFilterConfig()}</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * methods respectively.</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * <p/></a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * {@code init-param} values may be conveniently obtained via the {@link #getInitParam(String)} method.</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> *</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @throws Exception if the subclass has an error upon initialization.</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> */</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> protected void onFilterConfigSet() throws Exception {</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> }</a> |
| <span class="sourceLineNo">123</span><a id="line.123"></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> /**</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * Default no-op implementation that can be overridden by subclasses for custom cleanup behavior.</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> */</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> public void destroy() {</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> }</a> |
| <span class="sourceLineNo">129</span><a id="line.129"></a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
