| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.http, class: TestServletFilter, class: SimpleFilter"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.http;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static org.junit.Assert.assertEquals;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertNull;</span> |
| <span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.fail;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Random;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.ThreadLocalRandom;</span> |
| <span class="source-line-no">027</span><span id="line-27">import javax.servlet.Filter;</span> |
| <span class="source-line-no">028</span><span id="line-28">import javax.servlet.FilterChain;</span> |
| <span class="source-line-no">029</span><span id="line-29">import javax.servlet.FilterConfig;</span> |
| <span class="source-line-no">030</span><span id="line-30">import javax.servlet.ServletException;</span> |
| <span class="source-line-no">031</span><span id="line-31">import javax.servlet.ServletRequest;</span> |
| <span class="source-line-no">032</span><span id="line-32">import javax.servlet.ServletResponse;</span> |
| <span class="source-line-no">033</span><span id="line-33">import javax.servlet.http.HttpServletRequest;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.HBaseClassTestRule;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.testclassification.MiscTests;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.testclassification.SmallTests;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.net.NetUtils;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.util.StringUtils;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.junit.Assert;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.junit.ClassRule;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.junit.Ignore;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.junit.Test;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.junit.experimental.categories.Category;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.slf4j.Logger;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48">@Category({ MiscTests.class, SmallTests.class })</span> |
| <span class="source-line-no">049</span><span id="line-49">public class TestServletFilter extends HttpServerFunctionalTest {</span> |
| <span class="source-line-no">050</span><span id="line-50"> @ClassRule</span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final HBaseClassTestRule CLASS_RULE =</span> |
| <span class="source-line-no">052</span><span id="line-52"> HBaseClassTestRule.forClass(TestServletFilter.class);</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> private static final Logger LOG = LoggerFactory.getLogger(HttpServer.class);</span> |
| <span class="source-line-no">055</span><span id="line-55"> private static volatile String uri = null;</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /** A very simple filter which record the uri filtered. */</span> |
| <span class="source-line-no">058</span><span id="line-58"> static public class SimpleFilter implements Filter {</span> |
| <span class="source-line-no">059</span><span id="line-59"> private FilterConfig filterConfig = null;</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> @Override</span> |
| <span class="source-line-no">062</span><span id="line-62"> public void init(FilterConfig filterConfig) throws ServletException {</span> |
| <span class="source-line-no">063</span><span id="line-63"> this.filterConfig = filterConfig;</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> @Override</span> |
| <span class="source-line-no">067</span><span id="line-67"> public void destroy() {</span> |
| <span class="source-line-no">068</span><span id="line-68"> this.filterConfig = null;</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> @Override</span> |
| <span class="source-line-no">072</span><span id="line-72"> public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)</span> |
| <span class="source-line-no">073</span><span id="line-73"> throws IOException, ServletException {</span> |
| <span class="source-line-no">074</span><span id="line-74"> if (filterConfig == null) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> return;</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> uri = ((HttpServletRequest) request).getRequestURI();</span> |
| <span class="source-line-no">079</span><span id="line-79"> LOG.info("filtering " + uri);</span> |
| <span class="source-line-no">080</span><span id="line-80"> chain.doFilter(request, response);</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /** Configuration for the filter */</span> |
| <span class="source-line-no">084</span><span id="line-84"> static public class Initializer extends FilterInitializer {</span> |
| <span class="source-line-no">085</span><span id="line-85"> public Initializer() {</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> @Override</span> |
| <span class="source-line-no">089</span><span id="line-89"> public void initFilter(FilterContainer container, Configuration conf) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> container.addFilter("simple", SimpleFilter.class.getName(), null);</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> private static void assertExceptionContains(String string, Throwable t) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> String msg = t.getMessage();</span> |
| <span class="source-line-no">097</span><span id="line-97"> Assert.assertTrue("Expected to find '" + string + "' but got unexpected exception:"</span> |
| <span class="source-line-no">098</span><span id="line-98"> + StringUtils.stringifyException(t), msg.contains(string));</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> @Test</span> |
| <span class="source-line-no">102</span><span id="line-102"> @Ignore</span> |
| <span class="source-line-no">103</span><span id="line-103"> // From stack</span> |
| <span class="source-line-no">104</span><span id="line-104"> // Its a 'foreign' test, one that came in from hadoop when we copy/pasted http</span> |
| <span class="source-line-no">105</span><span id="line-105"> // It's second class. Could comment it out if only failing test (as per @nkeywal – sort of)</span> |
| <span class="source-line-no">106</span><span id="line-106"> public void testServletFilter() throws Exception {</span> |
| <span class="source-line-no">107</span><span id="line-107"> Configuration conf = new Configuration();</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> // start an http server with CountingFilter</span> |
| <span class="source-line-no">110</span><span id="line-110"> conf.set(HttpServer.FILTER_INITIALIZERS_PROPERTY, SimpleFilter.Initializer.class.getName());</span> |
| <span class="source-line-no">111</span><span id="line-111"> HttpServer http = createTestServer(conf);</span> |
| <span class="source-line-no">112</span><span id="line-112"> http.start();</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> final String fsckURL = "/fsck";</span> |
| <span class="source-line-no">115</span><span id="line-115"> final String stacksURL = "/stacks";</span> |
| <span class="source-line-no">116</span><span id="line-116"> final String ajspURL = "/a.jsp";</span> |
| <span class="source-line-no">117</span><span id="line-117"> final String logURL = "/logs/a.log";</span> |
| <span class="source-line-no">118</span><span id="line-118"> final String hadooplogoURL = "/static/hadoop-logo.jpg";</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> final String[] urls = { fsckURL, stacksURL, ajspURL, logURL, hadooplogoURL };</span> |
| <span class="source-line-no">121</span><span id="line-121"> final Random rand = ThreadLocalRandom.current();</span> |
| <span class="source-line-no">122</span><span id="line-122"> final int[] sequence = new int[50];</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> // generate a random sequence and update counts</span> |
| <span class="source-line-no">125</span><span id="line-125"> for (int i = 0; i < sequence.length; i++) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> sequence[i] = rand.nextInt(urls.length);</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> // access the urls as the sequence</span> |
| <span class="source-line-no">130</span><span id="line-130"> final String prefix = "http://" + NetUtils.getHostPortString(http.getConnectorAddress(0));</span> |
| <span class="source-line-no">131</span><span id="line-131"> try {</span> |
| <span class="source-line-no">132</span><span id="line-132"> for (int aSequence : sequence) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> access(prefix + urls[aSequence]);</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> // make sure everything except fsck get filtered</span> |
| <span class="source-line-no">136</span><span id="line-136"> if (aSequence == 0) {</span> |
| <span class="source-line-no">137</span><span id="line-137"> assertNull(uri);</span> |
| <span class="source-line-no">138</span><span id="line-138"> } else {</span> |
| <span class="source-line-no">139</span><span id="line-139"> assertEquals(urls[aSequence], uri);</span> |
| <span class="source-line-no">140</span><span id="line-140"> uri = null;</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"> } finally {</span> |
| <span class="source-line-no">144</span><span id="line-144"> http.stop();</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"></span> |
| <span class="source-line-no">148</span><span id="line-148"> static public class ErrorFilter extends SimpleFilter {</span> |
| <span class="source-line-no">149</span><span id="line-149"> @Override</span> |
| <span class="source-line-no">150</span><span id="line-150"> public void init(FilterConfig arg0) throws ServletException {</span> |
| <span class="source-line-no">151</span><span id="line-151"> throw new ServletException("Throwing the exception from Filter init");</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> /** Configuration for the filter */</span> |
| <span class="source-line-no">155</span><span id="line-155"> static public class Initializer extends FilterInitializer {</span> |
| <span class="source-line-no">156</span><span id="line-156"> public Initializer() {</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> @Override</span> |
| <span class="source-line-no">160</span><span id="line-160"> public void initFilter(FilterContainer container, Configuration conf) {</span> |
| <span class="source-line-no">161</span><span id="line-161"> container.addFilter("simple", ErrorFilter.class.getName(), null);</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> @Test</span> |
| <span class="source-line-no">167</span><span id="line-167"> public void testServletFilterWhenInitThrowsException() throws Exception {</span> |
| <span class="source-line-no">168</span><span id="line-168"> Configuration conf = new Configuration();</span> |
| <span class="source-line-no">169</span><span id="line-169"> // start an http server with ErrorFilter</span> |
| <span class="source-line-no">170</span><span id="line-170"> conf.set(HttpServer.FILTER_INITIALIZERS_PROPERTY, ErrorFilter.Initializer.class.getName());</span> |
| <span class="source-line-no">171</span><span id="line-171"> HttpServer http = createTestServer(conf);</span> |
| <span class="source-line-no">172</span><span id="line-172"> try {</span> |
| <span class="source-line-no">173</span><span id="line-173"> http.start();</span> |
| <span class="source-line-no">174</span><span id="line-174"> fail("expecting exception");</span> |
| <span class="source-line-no">175</span><span id="line-175"> } catch (IOException e) {</span> |
| <span class="source-line-no">176</span><span id="line-176"> assertExceptionContains("Problem starting http server", e);</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Similar to the above test case, except that it uses a different API to add the filter.</span> |
| <span class="source-line-no">182</span><span id="line-182"> * Regression test for HADOOP-8786.</span> |
| <span class="source-line-no">183</span><span id="line-183"> */</span> |
| <span class="source-line-no">184</span><span id="line-184"> @Test</span> |
| <span class="source-line-no">185</span><span id="line-185"> public void testContextSpecificServletFilterWhenInitThrowsException() throws Exception {</span> |
| <span class="source-line-no">186</span><span id="line-186"> Configuration conf = new Configuration();</span> |
| <span class="source-line-no">187</span><span id="line-187"> HttpServer http = createTestServer(conf);</span> |
| <span class="source-line-no">188</span><span id="line-188"> HttpServer.defineFilter(http.webAppContext, "ErrorFilter", ErrorFilter.class.getName(), null,</span> |
| <span class="source-line-no">189</span><span id="line-189"> null);</span> |
| <span class="source-line-no">190</span><span id="line-190"> try {</span> |
| <span class="source-line-no">191</span><span id="line-191"> http.start();</span> |
| <span class="source-line-no">192</span><span id="line-192"> fail("expecting exception");</span> |
| <span class="source-line-no">193</span><span id="line-193"> } catch (IOException e) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> assertExceptionContains("Unable to initialize WebAppContext", e);</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
