blob: 8c75c5d40fd4eff754d309d4829e777acc3cbf07 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.http;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.FileNotFoundException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.InterruptedIOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.PrintStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.BindException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.InetSocketAddress;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.URI;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.net.URISyntaxException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.net.URL;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.nio.file.Files;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.nio.file.Path;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.nio.file.Paths;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.ArrayList;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.Collections;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.Enumeration;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.HashMap;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.util.List;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import java.util.Map;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.util.stream.Collectors;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import javax.servlet.Filter;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import javax.servlet.FilterChain;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import javax.servlet.FilterConfig;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import javax.servlet.Servlet;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import javax.servlet.ServletContext;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import javax.servlet.ServletException;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import javax.servlet.ServletRequest;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import javax.servlet.ServletResponse;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import javax.servlet.http.HttpServlet;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import javax.servlet.http.HttpServletRequest;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import javax.servlet.http.HttpServletRequestWrapper;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import javax.servlet.http.HttpServletResponse;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.HadoopIllegalArgumentException;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.conf.Configuration;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hadoop.fs.CommonConfigurationKeys;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.http.conf.ConfServlet;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.http.log.LogLevel;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.util.Threads;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.hadoop.security.AuthenticationFilterInitializer;<a name="line.59"></a>
<span class="sourceLineNo">060</span>import org.apache.hadoop.security.SecurityUtil;<a name="line.60"></a>
<span class="sourceLineNo">061</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.61"></a>
<span class="sourceLineNo">062</span>import org.apache.hadoop.security.authentication.server.AuthenticationFilter;<a name="line.62"></a>
<span class="sourceLineNo">063</span>import org.apache.hadoop.security.authorize.AccessControlList;<a name="line.63"></a>
<span class="sourceLineNo">064</span>import org.apache.hadoop.security.authorize.ProxyUsers;<a name="line.64"></a>
<span class="sourceLineNo">065</span>import org.apache.hadoop.util.Shell;<a name="line.65"></a>
<span class="sourceLineNo">066</span>import org.apache.hadoop.util.StringUtils;<a name="line.66"></a>
<span class="sourceLineNo">067</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.67"></a>
<span class="sourceLineNo">068</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.68"></a>
<span class="sourceLineNo">069</span>import org.slf4j.Logger;<a name="line.69"></a>
<span class="sourceLineNo">070</span>import org.slf4j.LoggerFactory;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.72"></a>
<span class="sourceLineNo">073</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap;<a name="line.73"></a>
<span class="sourceLineNo">074</span>import org.apache.hbase.thirdparty.com.google.common.collect.Lists;<a name="line.74"></a>
<span class="sourceLineNo">075</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.http.HttpVersion;<a name="line.75"></a>
<span class="sourceLineNo">076</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.Handler;<a name="line.76"></a>
<span class="sourceLineNo">077</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.HttpConfiguration;<a name="line.77"></a>
<span class="sourceLineNo">078</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.HttpConnectionFactory;<a name="line.78"></a>
<span class="sourceLineNo">079</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.RequestLog;<a name="line.79"></a>
<span class="sourceLineNo">080</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.SecureRequestCustomizer;<a name="line.80"></a>
<span class="sourceLineNo">081</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server;<a name="line.81"></a>
<span class="sourceLineNo">082</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.ServerConnector;<a name="line.82"></a>
<span class="sourceLineNo">083</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.SslConnectionFactory;<a name="line.83"></a>
<span class="sourceLineNo">084</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.SymlinkAllowedResourceAliasChecker;<a name="line.84"></a>
<span class="sourceLineNo">085</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.ContextHandlerCollection;<a name="line.85"></a>
<span class="sourceLineNo">086</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.ErrorHandler;<a name="line.86"></a>
<span class="sourceLineNo">087</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.HandlerCollection;<a name="line.87"></a>
<span class="sourceLineNo">088</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.RequestLogHandler;<a name="line.88"></a>
<span class="sourceLineNo">089</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.server.handler.gzip.GzipHandler;<a name="line.89"></a>
<span class="sourceLineNo">090</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.DefaultServlet;<a name="line.90"></a>
<span class="sourceLineNo">091</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.FilterHolder;<a name="line.91"></a>
<span class="sourceLineNo">092</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.FilterMapping;<a name="line.92"></a>
<span class="sourceLineNo">093</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler;<a name="line.93"></a>
<span class="sourceLineNo">094</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletHolder;<a name="line.94"></a>
<span class="sourceLineNo">095</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.util.MultiException;<a name="line.95"></a>
<span class="sourceLineNo">096</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.util.ssl.SslContextFactory;<a name="line.96"></a>
<span class="sourceLineNo">097</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.util.thread.QueuedThreadPool;<a name="line.97"></a>
<span class="sourceLineNo">098</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.webapp.WebAppContext;<a name="line.98"></a>
<span class="sourceLineNo">099</span>import org.apache.hbase.thirdparty.org.glassfish.jersey.server.ResourceConfig;<a name="line.99"></a>
<span class="sourceLineNo">100</span>import org.apache.hbase.thirdparty.org.glassfish.jersey.servlet.ServletContainer;<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>/**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Create a Jetty embedded server to answer http requests. The primary goal is to serve up status<a name="line.103"></a>
<span class="sourceLineNo">104</span> * information for the server. There are three contexts: "/logs/" -&amp;gt; points to the log directory<a name="line.104"></a>
<span class="sourceLineNo">105</span> * "/static/" -&amp;gt; points to common static files (src/webapps/static) "/" -&amp;gt; the jsp server code<a name="line.105"></a>
<span class="sourceLineNo">106</span> * from (src/webapps/&amp;lt;name&amp;gt;)<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span>@InterfaceAudience.Private<a name="line.108"></a>
<span class="sourceLineNo">109</span>@InterfaceStability.Evolving<a name="line.109"></a>
<span class="sourceLineNo">110</span>public class HttpServer implements FilterContainer {<a name="line.110"></a>
<span class="sourceLineNo">111</span> private static final Logger LOG = LoggerFactory.getLogger(HttpServer.class);<a name="line.111"></a>
<span class="sourceLineNo">112</span> private static final String EMPTY_STRING = "";<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> // Jetty's max header size is Character.MAX_VALUE - 1, See ArrayTernaryTrie for more details<a name="line.114"></a>
<span class="sourceLineNo">115</span> // And in newer jetty version, they add a check when creating a server so we must follow this<a name="line.115"></a>
<span class="sourceLineNo">116</span> // limitation otherwise the UTs will fail<a name="line.116"></a>
<span class="sourceLineNo">117</span> private static final int DEFAULT_MAX_HEADER_SIZE = Character.MAX_VALUE - 1;<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> // Add configuration for jetty idle timeout<a name="line.119"></a>
<span class="sourceLineNo">120</span> private static final String HTTP_JETTY_IDLE_TIMEOUT = "hbase.ui.connection.idleTimeout";<a name="line.120"></a>
<span class="sourceLineNo">121</span> // Default jetty idle timeout<a name="line.121"></a>
<span class="sourceLineNo">122</span> private static final long DEFAULT_HTTP_JETTY_IDLE_TIMEOUT = 30000;<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> static final String FILTER_INITIALIZERS_PROPERTY = "hbase.http.filter.initializers";<a name="line.124"></a>
<span class="sourceLineNo">125</span> static final String HTTP_MAX_THREADS = "hbase.http.max.threads";<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> public static final String HTTP_UI_AUTHENTICATION = "hbase.security.authentication.ui";<a name="line.127"></a>
<span class="sourceLineNo">128</span> static final String HTTP_AUTHENTICATION_PREFIX = "hbase.security.authentication.";<a name="line.128"></a>
<span class="sourceLineNo">129</span> static final String HTTP_SPNEGO_AUTHENTICATION_PREFIX = HTTP_AUTHENTICATION_PREFIX + "spnego.";<a name="line.129"></a>
<span class="sourceLineNo">130</span> static final String HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_SUFFIX = "kerberos.principal";<a name="line.130"></a>
<span class="sourceLineNo">131</span> public static final String HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY =<a name="line.131"></a>
<span class="sourceLineNo">132</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_SUFFIX;<a name="line.132"></a>
<span class="sourceLineNo">133</span> static final String HTTP_SPNEGO_AUTHENTICATION_KEYTAB_SUFFIX = "kerberos.keytab";<a name="line.133"></a>
<span class="sourceLineNo">134</span> public static final String HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY =<a name="line.134"></a>
<span class="sourceLineNo">135</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + HTTP_SPNEGO_AUTHENTICATION_KEYTAB_SUFFIX;<a name="line.135"></a>
<span class="sourceLineNo">136</span> static final String HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_SUFFIX = "kerberos.name.rules";<a name="line.136"></a>
<span class="sourceLineNo">137</span> public static final String HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY =<a name="line.137"></a>
<span class="sourceLineNo">138</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_SUFFIX;<a name="line.138"></a>
<span class="sourceLineNo">139</span> static final String HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_SUFFIX =<a name="line.139"></a>
<span class="sourceLineNo">140</span> "kerberos.proxyuser.enable";<a name="line.140"></a>
<span class="sourceLineNo">141</span> public static final String HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_KEY =<a name="line.141"></a>
<span class="sourceLineNo">142</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_SUFFIX;<a name="line.142"></a>
<span class="sourceLineNo">143</span> public static final boolean HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_DEFAULT = false;<a name="line.143"></a>
<span class="sourceLineNo">144</span> static final String HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_SUFFIX = "signature.secret.file";<a name="line.144"></a>
<span class="sourceLineNo">145</span> public static final String HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY =<a name="line.145"></a>
<span class="sourceLineNo">146</span> HTTP_AUTHENTICATION_PREFIX + HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_SUFFIX;<a name="line.146"></a>
<span class="sourceLineNo">147</span> public static final String HTTP_SPNEGO_AUTHENTICATION_ADMIN_USERS_KEY =<a name="line.147"></a>
<span class="sourceLineNo">148</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + "admin.users";<a name="line.148"></a>
<span class="sourceLineNo">149</span> public static final String HTTP_SPNEGO_AUTHENTICATION_ADMIN_GROUPS_KEY =<a name="line.149"></a>
<span class="sourceLineNo">150</span> HTTP_SPNEGO_AUTHENTICATION_PREFIX + "admin.groups";<a name="line.150"></a>
<span class="sourceLineNo">151</span> public static final String HTTP_PRIVILEGED_CONF_KEY =<a name="line.151"></a>
<span class="sourceLineNo">152</span> "hbase.security.authentication.ui.config.protected";<a name="line.152"></a>
<span class="sourceLineNo">153</span> public static final String HTTP_UI_NO_CACHE_ENABLE_KEY = "hbase.http.filter.no-store.enable";<a name="line.153"></a>
<span class="sourceLineNo">154</span> public static final boolean HTTP_PRIVILEGED_CONF_DEFAULT = false;<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> // The ServletContext attribute where the daemon Configuration<a name="line.156"></a>
<span class="sourceLineNo">157</span> // gets stored.<a name="line.157"></a>
<span class="sourceLineNo">158</span> public static final String CONF_CONTEXT_ATTRIBUTE = "hbase.conf";<a name="line.158"></a>
<span class="sourceLineNo">159</span> public static final String ADMINS_ACL = "admins.acl";<a name="line.159"></a>
<span class="sourceLineNo">160</span> public static final String BIND_ADDRESS = "bind.address";<a name="line.160"></a>
<span class="sourceLineNo">161</span> public static final String SPNEGO_FILTER = "SpnegoFilter";<a name="line.161"></a>
<span class="sourceLineNo">162</span> public static final String SPNEGO_PROXYUSER_FILTER = "SpnegoProxyUserFilter";<a name="line.162"></a>
<span class="sourceLineNo">163</span> public static final String NO_CACHE_FILTER = "NoCacheFilter";<a name="line.163"></a>
<span class="sourceLineNo">164</span> public static final String APP_DIR = "webapps";<a name="line.164"></a>
<span class="sourceLineNo">165</span> public static final String HTTP_UI_SHOW_STACKTRACE_KEY = "hbase.ui.show-stack-traces";<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> public static final String METRIC_SERVLETS_CONF_KEY = "hbase.http.metrics.servlets";<a name="line.167"></a>
<span class="sourceLineNo">168</span> public static final String[] METRICS_SERVLETS_DEFAULT = { "jmx", "metrics", "prometheus" };<a name="line.168"></a>
<span class="sourceLineNo">169</span> private static final ImmutableMap&lt;String,<a name="line.169"></a>
<span class="sourceLineNo">170</span> ServletConfig&gt; METRIC_SERVLETS = new ImmutableMap.Builder&lt;String, ServletConfig&gt;()<a name="line.170"></a>
<span class="sourceLineNo">171</span> .put("jmx",<a name="line.171"></a>
<span class="sourceLineNo">172</span> new ServletConfig("jmx", "/jmx", "org.apache.hadoop.hbase.http.jmx.JMXJsonServlet"))<a name="line.172"></a>
<span class="sourceLineNo">173</span> .put("metrics",<a name="line.173"></a>
<span class="sourceLineNo">174</span> // MetricsServlet is deprecated in hadoop 2.8 and removed in 3.0. We shouldn't expect it,<a name="line.174"></a>
<span class="sourceLineNo">175</span> // so pass false so that we don't create a noisy warn during instantiation.<a name="line.175"></a>
<span class="sourceLineNo">176</span> new ServletConfig("metrics", "/metrics", "org.apache.hadoop.metrics.MetricsServlet", false))<a name="line.176"></a>
<span class="sourceLineNo">177</span> .put("prometheus", new ServletConfig("prometheus", "/prometheus",<a name="line.177"></a>
<span class="sourceLineNo">178</span> "org.apache.hadoop.hbase.http.prometheus.PrometheusHadoopServlet"))<a name="line.178"></a>
<span class="sourceLineNo">179</span> .build();<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> private final AccessControlList adminsAcl;<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> protected final Server webServer;<a name="line.183"></a>
<span class="sourceLineNo">184</span> protected String appDir;<a name="line.184"></a>
<span class="sourceLineNo">185</span> protected String logDir;<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> private static final class ListenerInfo {<a name="line.187"></a>
<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
<span class="sourceLineNo">189</span> * Boolean flag to determine whether the HTTP server should clean up the listener in stop().<a name="line.189"></a>
<span class="sourceLineNo">190</span> */<a name="line.190"></a>
<span class="sourceLineNo">191</span> private final boolean isManaged;<a name="line.191"></a>
<span class="sourceLineNo">192</span> private final ServerConnector listener;<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> private ListenerInfo(boolean isManaged, ServerConnector listener) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> this.isManaged = isManaged;<a name="line.195"></a>
<span class="sourceLineNo">196</span> this.listener = listener;<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> private final List&lt;ListenerInfo&gt; listeners = Lists.newArrayList();<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> public List&lt;ServerConnector&gt; getServerConnectors() {<a name="line.202"></a>
<span class="sourceLineNo">203</span> return listeners.stream().map(info -&gt; info.listener).collect(Collectors.toList());<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> protected final WebAppContext webAppContext;<a name="line.206"></a>
<span class="sourceLineNo">207</span> protected final boolean findPort;<a name="line.207"></a>
<span class="sourceLineNo">208</span> protected final Map&lt;ServletContextHandler, Boolean&gt; defaultContexts = new HashMap&lt;&gt;();<a name="line.208"></a>
<span class="sourceLineNo">209</span> protected final List&lt;String&gt; filterNames = new ArrayList&lt;&gt;();<a name="line.209"></a>
<span class="sourceLineNo">210</span> protected final boolean authenticationEnabled;<a name="line.210"></a>
<span class="sourceLineNo">211</span> static final String STATE_DESCRIPTION_ALIVE = " - alive";<a name="line.211"></a>
<span class="sourceLineNo">212</span> static final String STATE_DESCRIPTION_NOT_LIVE = " - not live";<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Class to construct instances of HTTP server with specific options.<a name="line.215"></a>
<span class="sourceLineNo">216</span> */<a name="line.216"></a>
<span class="sourceLineNo">217</span> public static class Builder {<a name="line.217"></a>
<span class="sourceLineNo">218</span> private ArrayList&lt;URI&gt; endpoints = Lists.newArrayList();<a name="line.218"></a>
<span class="sourceLineNo">219</span> private Configuration conf;<a name="line.219"></a>
<span class="sourceLineNo">220</span> private String[] pathSpecs;<a name="line.220"></a>
<span class="sourceLineNo">221</span> private AccessControlList adminsAcl;<a name="line.221"></a>
<span class="sourceLineNo">222</span> private boolean securityEnabled = false;<a name="line.222"></a>
<span class="sourceLineNo">223</span> private String usernameConfKey;<a name="line.223"></a>
<span class="sourceLineNo">224</span> private String keytabConfKey;<a name="line.224"></a>
<span class="sourceLineNo">225</span> private boolean needsClientAuth;<a name="line.225"></a>
<span class="sourceLineNo">226</span> private String excludeCiphers;<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span> private String hostName;<a name="line.228"></a>
<span class="sourceLineNo">229</span> private String appDir = APP_DIR;<a name="line.229"></a>
<span class="sourceLineNo">230</span> private String logDir;<a name="line.230"></a>
<span class="sourceLineNo">231</span> private boolean findPort;<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span> private String trustStore;<a name="line.233"></a>
<span class="sourceLineNo">234</span> private String trustStorePassword;<a name="line.234"></a>
<span class="sourceLineNo">235</span> private String trustStoreType;<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span> private String keyStore;<a name="line.237"></a>
<span class="sourceLineNo">238</span> private String keyStorePassword;<a name="line.238"></a>
<span class="sourceLineNo">239</span> private String keyStoreType;<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> // The -keypass option in keytool<a name="line.241"></a>
<span class="sourceLineNo">242</span> private String keyPassword;<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span> private String kerberosNameRulesKey;<a name="line.244"></a>
<span class="sourceLineNo">245</span> private String signatureSecretFileKey;<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span> /**<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @see #setAppDir(String)<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @deprecated Since 0.99.0. Use builder pattern via {@link #setAppDir(String)} instead.<a name="line.249"></a>
<span class="sourceLineNo">250</span> */<a name="line.250"></a>
<span class="sourceLineNo">251</span> @Deprecated<a name="line.251"></a>
<span class="sourceLineNo">252</span> private String name;<a name="line.252"></a>
<span class="sourceLineNo">253</span> /**<a name="line.253"></a>
<span class="sourceLineNo">254</span> * @see #addEndpoint(URI)<a name="line.254"></a>
<span class="sourceLineNo">255</span> * @deprecated Since 0.99.0. Use builder pattern via {@link #addEndpoint(URI)} instead.<a name="line.255"></a>
<span class="sourceLineNo">256</span> */<a name="line.256"></a>
<span class="sourceLineNo">257</span> @Deprecated<a name="line.257"></a>
<span class="sourceLineNo">258</span> private String bindAddress;<a name="line.258"></a>
<span class="sourceLineNo">259</span> /**<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @see #addEndpoint(URI)<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @deprecated Since 0.99.0. Use builder pattern via {@link #addEndpoint(URI)} instead.<a name="line.261"></a>
<span class="sourceLineNo">262</span> */<a name="line.262"></a>
<span class="sourceLineNo">263</span> @Deprecated<a name="line.263"></a>
<span class="sourceLineNo">264</span> private int port = -1;<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span> /**<a name="line.266"></a>
<span class="sourceLineNo">267</span> * Add an endpoint that the HTTP server should listen to. the endpoint of that the HTTP server<a name="line.267"></a>
<span class="sourceLineNo">268</span> * should listen to. The scheme specifies the protocol (i.e. HTTP / HTTPS), the host specifies<a name="line.268"></a>
<span class="sourceLineNo">269</span> * the binding address, and the port specifies the listening port. Unspecified or zero port<a name="line.269"></a>
<span class="sourceLineNo">270</span> * means that the server can listen to any port.<a name="line.270"></a>
<span class="sourceLineNo">271</span> */<a name="line.271"></a>
<span class="sourceLineNo">272</span> public Builder addEndpoint(URI endpoint) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> endpoints.add(endpoint);<a name="line.273"></a>
<span class="sourceLineNo">274</span> return this;<a name="line.274"></a>
<span class="sourceLineNo">275</span> }<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span> /**<a name="line.277"></a>
<span class="sourceLineNo">278</span> * Set the hostname of the http server. The host name is used to resolve the _HOST field in<a name="line.278"></a>
<span class="sourceLineNo">279</span> * Kerberos principals. The hostname of the first listener will be used if the name is<a name="line.279"></a>
<span class="sourceLineNo">280</span> * unspecified.<a name="line.280"></a>
<span class="sourceLineNo">281</span> */<a name="line.281"></a>
<span class="sourceLineNo">282</span> public Builder hostName(String hostName) {<a name="line.282"></a>
<span class="sourceLineNo">283</span> this.hostName = hostName;<a name="line.283"></a>
<span class="sourceLineNo">284</span> return this;<a name="line.284"></a>
<span class="sourceLineNo">285</span> }<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span> public Builder trustStore(String location, String password, String type) {<a name="line.287"></a>
<span class="sourceLineNo">288</span> this.trustStore = location;<a name="line.288"></a>
<span class="sourceLineNo">289</span> this.trustStorePassword = password;<a name="line.289"></a>
<span class="sourceLineNo">290</span> this.trustStoreType = type;<a name="line.290"></a>
<span class="sourceLineNo">291</span> return this;<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span> public Builder keyStore(String location, String password, String type) {<a name="line.294"></a>
<span class="sourceLineNo">295</span> this.keyStore = location;<a name="line.295"></a>
<span class="sourceLineNo">296</span> this.keyStorePassword = password;<a name="line.296"></a>
<span class="sourceLineNo">297</span> this.keyStoreType = type;<a name="line.297"></a>
<span class="sourceLineNo">298</span> return this;<a name="line.298"></a>
<span class="sourceLineNo">299</span> }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span> public Builder keyPassword(String password) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> this.keyPassword = password;<a name="line.302"></a>
<span class="sourceLineNo">303</span> return this;<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span> /**<a name="line.306"></a>
<span class="sourceLineNo">307</span> * Specify whether the server should authorize the client in SSL connections.<a name="line.307"></a>
<span class="sourceLineNo">308</span> */<a name="line.308"></a>
<span class="sourceLineNo">309</span> public Builder needsClientAuth(boolean value) {<a name="line.309"></a>
<span class="sourceLineNo">310</span> this.needsClientAuth = value;<a name="line.310"></a>
<span class="sourceLineNo">311</span> return this;<a name="line.311"></a>
<span class="sourceLineNo">312</span> }<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span> /**<a name="line.314"></a>
<span class="sourceLineNo">315</span> * @see #setAppDir(String)<a name="line.315"></a>
<span class="sourceLineNo">316</span> * @deprecated Since 0.99.0. Use {@link #setAppDir(String)} instead.<a name="line.316"></a>
<span class="sourceLineNo">317</span> */<a name="line.317"></a>
<span class="sourceLineNo">318</span> @Deprecated<a name="line.318"></a>
<span class="sourceLineNo">319</span> public Builder setName(String name) {<a name="line.319"></a>
<span class="sourceLineNo">320</span> this.name = name;<a name="line.320"></a>
<span class="sourceLineNo">321</span> return this;<a name="line.321"></a>
<span class="sourceLineNo">322</span> }<a name="line.322"></a>
<span class="sourceLineNo">323</span><a name="line.323"></a>
<span class="sourceLineNo">324</span> /**<a name="line.324"></a>
<span class="sourceLineNo">325</span> * @see #addEndpoint(URI)<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @deprecated Since 0.99.0. Use {@link #addEndpoint(URI)} instead.<a name="line.326"></a>
<span class="sourceLineNo">327</span> */<a name="line.327"></a>
<span class="sourceLineNo">328</span> @Deprecated<a name="line.328"></a>
<span class="sourceLineNo">329</span> public Builder setBindAddress(String bindAddress) {<a name="line.329"></a>
<span class="sourceLineNo">330</span> this.bindAddress = bindAddress;<a name="line.330"></a>
<span class="sourceLineNo">331</span> return this;<a name="line.331"></a>
<span class="sourceLineNo">332</span> }<a name="line.332"></a>
<span class="sourceLineNo">333</span><a name="line.333"></a>
<span class="sourceLineNo">334</span> /**<a name="line.334"></a>
<span class="sourceLineNo">335</span> * @see #addEndpoint(URI)<a name="line.335"></a>
<span class="sourceLineNo">336</span> * @deprecated Since 0.99.0. Use {@link #addEndpoint(URI)} instead.<a name="line.336"></a>
<span class="sourceLineNo">337</span> */<a name="line.337"></a>
<span class="sourceLineNo">338</span> @Deprecated<a name="line.338"></a>
<span class="sourceLineNo">339</span> public Builder setPort(int port) {<a name="line.339"></a>
<span class="sourceLineNo">340</span> this.port = port;<a name="line.340"></a>
<span class="sourceLineNo">341</span> return this;<a name="line.341"></a>
<span class="sourceLineNo">342</span> }<a name="line.342"></a>
<span class="sourceLineNo">343</span><a name="line.343"></a>
<span class="sourceLineNo">344</span> public Builder setFindPort(boolean findPort) {<a name="line.344"></a>
<span class="sourceLineNo">345</span> this.findPort = findPort;<a name="line.345"></a>
<span class="sourceLineNo">346</span> return this;<a name="line.346"></a>
<span class="sourceLineNo">347</span> }<a name="line.347"></a>
<span class="sourceLineNo">348</span><a name="line.348"></a>
<span class="sourceLineNo">349</span> public Builder setConf(Configuration conf) {<a name="line.349"></a>
<span class="sourceLineNo">350</span> this.conf = conf;<a name="line.350"></a>
<span class="sourceLineNo">351</span> return this;<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<a name="line.352"></a>
<span class="sourceLineNo">353</span><a name="line.353"></a>
<span class="sourceLineNo">354</span> public Builder setPathSpec(String[] pathSpec) {<a name="line.354"></a>
<span class="sourceLineNo">355</span> this.pathSpecs = pathSpec;<a name="line.355"></a>
<span class="sourceLineNo">356</span> return this;<a name="line.356"></a>
<span class="sourceLineNo">357</span> }<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> public Builder setACL(AccessControlList acl) {<a name="line.359"></a>
<span class="sourceLineNo">360</span> this.adminsAcl = acl;<a name="line.360"></a>
<span class="sourceLineNo">361</span> return this;<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> public Builder setSecurityEnabled(boolean securityEnabled) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> this.securityEnabled = securityEnabled;<a name="line.365"></a>
<span class="sourceLineNo">366</span> return this;<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span> public Builder setUsernameConfKey(String usernameConfKey) {<a name="line.369"></a>
<span class="sourceLineNo">370</span> this.usernameConfKey = usernameConfKey;<a name="line.370"></a>
<span class="sourceLineNo">371</span> return this;<a name="line.371"></a>
<span class="sourceLineNo">372</span> }<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span> public Builder setKeytabConfKey(String keytabConfKey) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> this.keytabConfKey = keytabConfKey;<a name="line.375"></a>
<span class="sourceLineNo">376</span> return this;<a name="line.376"></a>
<span class="sourceLineNo">377</span> }<a name="line.377"></a>
<span class="sourceLineNo">378</span><a name="line.378"></a>
<span class="sourceLineNo">379</span> public Builder setKerberosNameRulesKey(String kerberosNameRulesKey) {<a name="line.379"></a>
<span class="sourceLineNo">380</span> this.kerberosNameRulesKey = kerberosNameRulesKey;<a name="line.380"></a>
<span class="sourceLineNo">381</span> return this;<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> public Builder setSignatureSecretFileKey(String signatureSecretFileKey) {<a name="line.384"></a>
<span class="sourceLineNo">385</span> this.signatureSecretFileKey = signatureSecretFileKey;<a name="line.385"></a>
<span class="sourceLineNo">386</span> return this;<a name="line.386"></a>
<span class="sourceLineNo">387</span> }<a name="line.387"></a>
<span class="sourceLineNo">388</span><a name="line.388"></a>
<span class="sourceLineNo">389</span> public Builder setAppDir(String appDir) {<a name="line.389"></a>
<span class="sourceLineNo">390</span> this.appDir = appDir;<a name="line.390"></a>
<span class="sourceLineNo">391</span> return this;<a name="line.391"></a>
<span class="sourceLineNo">392</span> }<a name="line.392"></a>
<span class="sourceLineNo">393</span><a name="line.393"></a>
<span class="sourceLineNo">394</span> public Builder setLogDir(String logDir) {<a name="line.394"></a>
<span class="sourceLineNo">395</span> this.logDir = logDir;<a name="line.395"></a>
<span class="sourceLineNo">396</span> return this;<a name="line.396"></a>
<span class="sourceLineNo">397</span> }<a name="line.397"></a>
<span class="sourceLineNo">398</span><a name="line.398"></a>
<span class="sourceLineNo">399</span> public void excludeCiphers(String excludeCiphers) {<a name="line.399"></a>
<span class="sourceLineNo">400</span> this.excludeCiphers = excludeCiphers;<a name="line.400"></a>
<span class="sourceLineNo">401</span> }<a name="line.401"></a>
<span class="sourceLineNo">402</span><a name="line.402"></a>
<span class="sourceLineNo">403</span> public HttpServer build() throws IOException {<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span> // Do we still need to assert this non null name if it is deprecated?<a name="line.405"></a>
<span class="sourceLineNo">406</span> if (this.name == null) {<a name="line.406"></a>
<span class="sourceLineNo">407</span> throw new HadoopIllegalArgumentException("name is not set");<a name="line.407"></a>
<span class="sourceLineNo">408</span> }<a name="line.408"></a>
<span class="sourceLineNo">409</span><a name="line.409"></a>
<span class="sourceLineNo">410</span> // Make the behavior compatible with deprecated interfaces<a name="line.410"></a>
<span class="sourceLineNo">411</span> if (bindAddress != null &amp;&amp; port != -1) {<a name="line.411"></a>
<span class="sourceLineNo">412</span> try {<a name="line.412"></a>
<span class="sourceLineNo">413</span> endpoints.add(0, new URI("http", "", bindAddress, port, "", "", ""));<a name="line.413"></a>
<span class="sourceLineNo">414</span> } catch (URISyntaxException e) {<a name="line.414"></a>
<span class="sourceLineNo">415</span> throw new HadoopIllegalArgumentException("Invalid endpoint: " + e);<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span> }<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span> if (endpoints.isEmpty()) {<a name="line.419"></a>
<span class="sourceLineNo">420</span> throw new HadoopIllegalArgumentException("No endpoints specified");<a name="line.420"></a>
<span class="sourceLineNo">421</span> }<a name="line.421"></a>
<span class="sourceLineNo">422</span><a name="line.422"></a>
<span class="sourceLineNo">423</span> if (hostName == null) {<a name="line.423"></a>
<span class="sourceLineNo">424</span> hostName = endpoints.get(0).getHost();<a name="line.424"></a>
<span class="sourceLineNo">425</span> }<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> if (this.conf == null) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> conf = new Configuration();<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> HttpServer server = new HttpServer(this);<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span> for (URI ep : endpoints) {<a name="line.433"></a>
<span class="sourceLineNo">434</span> ServerConnector listener = null;<a name="line.434"></a>
<span class="sourceLineNo">435</span> String scheme = ep.getScheme();<a name="line.435"></a>
<span class="sourceLineNo">436</span> HttpConfiguration httpConfig = new HttpConfiguration();<a name="line.436"></a>
<span class="sourceLineNo">437</span> httpConfig.setSecureScheme("https");<a name="line.437"></a>
<span class="sourceLineNo">438</span> httpConfig.setHeaderCacheSize(DEFAULT_MAX_HEADER_SIZE);<a name="line.438"></a>
<span class="sourceLineNo">439</span> httpConfig.setResponseHeaderSize(DEFAULT_MAX_HEADER_SIZE);<a name="line.439"></a>
<span class="sourceLineNo">440</span> httpConfig.setRequestHeaderSize(DEFAULT_MAX_HEADER_SIZE);<a name="line.440"></a>
<span class="sourceLineNo">441</span> httpConfig.setSendServerVersion(false);<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span> if ("http".equals(scheme)) {<a name="line.443"></a>
<span class="sourceLineNo">444</span> listener = new ServerConnector(server.webServer, new HttpConnectionFactory(httpConfig));<a name="line.444"></a>
<span class="sourceLineNo">445</span> } else if ("https".equals(scheme)) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> HttpConfiguration httpsConfig = new HttpConfiguration(httpConfig);<a name="line.446"></a>
<span class="sourceLineNo">447</span> httpsConfig.addCustomizer(new SecureRequestCustomizer());<a name="line.447"></a>
<span class="sourceLineNo">448</span> SslContextFactory.Server sslCtxFactory = new SslContextFactory.Server();<a name="line.448"></a>
<span class="sourceLineNo">449</span> sslCtxFactory.setNeedClientAuth(needsClientAuth);<a name="line.449"></a>
<span class="sourceLineNo">450</span> sslCtxFactory.setKeyManagerPassword(keyPassword);<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> if (keyStore != null) {<a name="line.452"></a>
<span class="sourceLineNo">453</span> sslCtxFactory.setKeyStorePath(keyStore);<a name="line.453"></a>
<span class="sourceLineNo">454</span> sslCtxFactory.setKeyStoreType(keyStoreType);<a name="line.454"></a>
<span class="sourceLineNo">455</span> sslCtxFactory.setKeyStorePassword(keyStorePassword);<a name="line.455"></a>
<span class="sourceLineNo">456</span> }<a name="line.456"></a>
<span class="sourceLineNo">457</span><a name="line.457"></a>
<span class="sourceLineNo">458</span> if (trustStore != null) {<a name="line.458"></a>
<span class="sourceLineNo">459</span> sslCtxFactory.setTrustStorePath(trustStore);<a name="line.459"></a>
<span class="sourceLineNo">460</span> sslCtxFactory.setTrustStoreType(trustStoreType);<a name="line.460"></a>
<span class="sourceLineNo">461</span> sslCtxFactory.setTrustStorePassword(trustStorePassword);<a name="line.461"></a>
<span class="sourceLineNo">462</span> }<a name="line.462"></a>
<span class="sourceLineNo">463</span><a name="line.463"></a>
<span class="sourceLineNo">464</span> if (excludeCiphers != null &amp;&amp; !excludeCiphers.trim().isEmpty()) {<a name="line.464"></a>
<span class="sourceLineNo">465</span> sslCtxFactory.setExcludeCipherSuites(StringUtils.getTrimmedStrings(excludeCiphers));<a name="line.465"></a>
<span class="sourceLineNo">466</span> LOG.debug("Excluded SSL Cipher List:" + excludeCiphers);<a name="line.466"></a>
<span class="sourceLineNo">467</span> }<a name="line.467"></a>
<span class="sourceLineNo">468</span><a name="line.468"></a>
<span class="sourceLineNo">469</span> listener = new ServerConnector(server.webServer,<a name="line.469"></a>
<span class="sourceLineNo">470</span> new SslConnectionFactory(sslCtxFactory, HttpVersion.HTTP_1_1.toString()),<a name="line.470"></a>
<span class="sourceLineNo">471</span> new HttpConnectionFactory(httpsConfig));<a name="line.471"></a>
<span class="sourceLineNo">472</span> } else {<a name="line.472"></a>
<span class="sourceLineNo">473</span> throw new HadoopIllegalArgumentException("unknown scheme for endpoint:" + ep);<a name="line.473"></a>
<span class="sourceLineNo">474</span> }<a name="line.474"></a>
<span class="sourceLineNo">475</span><a name="line.475"></a>
<span class="sourceLineNo">476</span> // default settings for connector<a name="line.476"></a>
<span class="sourceLineNo">477</span> listener.setAcceptQueueSize(128);<a name="line.477"></a>
<span class="sourceLineNo">478</span> // config idle timeout for jetty<a name="line.478"></a>
<span class="sourceLineNo">479</span> listener<a name="line.479"></a>
<span class="sourceLineNo">480</span> .setIdleTimeout(conf.getLong(HTTP_JETTY_IDLE_TIMEOUT, DEFAULT_HTTP_JETTY_IDLE_TIMEOUT));<a name="line.480"></a>
<span class="sourceLineNo">481</span> if (Shell.WINDOWS) {<a name="line.481"></a>
<span class="sourceLineNo">482</span> // result of setting the SO_REUSEADDR flag is different on Windows<a name="line.482"></a>
<span class="sourceLineNo">483</span> // http://msdn.microsoft.com/en-us/library/ms740621(v=vs.85).aspx<a name="line.483"></a>
<span class="sourceLineNo">484</span> // without this 2 NN's can start on the same machine and listen on<a name="line.484"></a>
<span class="sourceLineNo">485</span> // the same port with indeterminate routing of incoming requests to them<a name="line.485"></a>
<span class="sourceLineNo">486</span> listener.setReuseAddress(false);<a name="line.486"></a>
<span class="sourceLineNo">487</span> }<a name="line.487"></a>
<span class="sourceLineNo">488</span><a name="line.488"></a>
<span class="sourceLineNo">489</span> listener.setHost(ep.getHost());<a name="line.489"></a>
<span class="sourceLineNo">490</span> listener.setPort(ep.getPort() == -1 ? 0 : ep.getPort());<a name="line.490"></a>
<span class="sourceLineNo">491</span> server.addManagedListener(listener);<a name="line.491"></a>
<span class="sourceLineNo">492</span> }<a name="line.492"></a>
<span class="sourceLineNo">493</span><a name="line.493"></a>
<span class="sourceLineNo">494</span> server.loadListeners();<a name="line.494"></a>
<span class="sourceLineNo">495</span> return server;<a name="line.495"></a>
<span class="sourceLineNo">496</span><a name="line.496"></a>
<span class="sourceLineNo">497</span> }<a name="line.497"></a>
<span class="sourceLineNo">498</span><a name="line.498"></a>
<span class="sourceLineNo">499</span> }<a name="line.499"></a>
<span class="sourceLineNo">500</span><a name="line.500"></a>
<span class="sourceLineNo">501</span> /**<a name="line.501"></a>
<span class="sourceLineNo">502</span> * @see #HttpServer(String, String, int, boolean, Configuration)<a name="line.502"></a>
<span class="sourceLineNo">503</span> * @deprecated Since 0.99.0<a name="line.503"></a>
<span class="sourceLineNo">504</span> */<a name="line.504"></a>
<span class="sourceLineNo">505</span> @Deprecated<a name="line.505"></a>
<span class="sourceLineNo">506</span> public HttpServer(String name, String bindAddress, int port, boolean findPort)<a name="line.506"></a>
<span class="sourceLineNo">507</span> throws IOException {<a name="line.507"></a>
<span class="sourceLineNo">508</span> this(name, bindAddress, port, findPort, new Configuration());<a name="line.508"></a>
<span class="sourceLineNo">509</span> }<a name="line.509"></a>
<span class="sourceLineNo">510</span><a name="line.510"></a>
<span class="sourceLineNo">511</span> /**<a name="line.511"></a>
<span class="sourceLineNo">512</span> * Create a status server on the given port. Allows you to specify the path specifications that<a name="line.512"></a>
<span class="sourceLineNo">513</span> * this server will be serving so that they will be added to the filters properly.<a name="line.513"></a>
<span class="sourceLineNo">514</span> * @param name The name of the server<a name="line.514"></a>
<span class="sourceLineNo">515</span> * @param bindAddress The address for this server<a name="line.515"></a>
<span class="sourceLineNo">516</span> * @param port The port to use on the server<a name="line.516"></a>
<span class="sourceLineNo">517</span> * @param findPort whether the server should start at the given port and increment by 1 until<a name="line.517"></a>
<span class="sourceLineNo">518</span> * it finds a free port.<a name="line.518"></a>
<span class="sourceLineNo">519</span> * @param conf Configuration<a name="line.519"></a>
<span class="sourceLineNo">520</span> * @param pathSpecs Path specifications that this httpserver will be serving. These will be<a name="line.520"></a>
<span class="sourceLineNo">521</span> * added to any filters.<a name="line.521"></a>
<span class="sourceLineNo">522</span> * @deprecated Since 0.99.0<a name="line.522"></a>
<span class="sourceLineNo">523</span> */<a name="line.523"></a>
<span class="sourceLineNo">524</span> @Deprecated<a name="line.524"></a>
<span class="sourceLineNo">525</span> public HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf,<a name="line.525"></a>
<span class="sourceLineNo">526</span> String[] pathSpecs) throws IOException {<a name="line.526"></a>
<span class="sourceLineNo">527</span> this(name, bindAddress, port, findPort, conf, null, pathSpecs);<a name="line.527"></a>
<span class="sourceLineNo">528</span> }<a name="line.528"></a>
<span class="sourceLineNo">529</span><a name="line.529"></a>
<span class="sourceLineNo">530</span> /**<a name="line.530"></a>
<span class="sourceLineNo">531</span> * Create a status server on the given port. The jsp scripts are taken from<a name="line.531"></a>
<span class="sourceLineNo">532</span> * src/webapps/&amp;lt;name&amp;gt;.<a name="line.532"></a>
<span class="sourceLineNo">533</span> * @param name The name of the server<a name="line.533"></a>
<span class="sourceLineNo">534</span> * @param port The port to use on the server<a name="line.534"></a>
<span class="sourceLineNo">535</span> * @param findPort whether the server should start at the given port and increment by 1 until it<a name="line.535"></a>
<span class="sourceLineNo">536</span> * finds a free port.<a name="line.536"></a>
<span class="sourceLineNo">537</span> * @param conf Configuration<a name="line.537"></a>
<span class="sourceLineNo">538</span> * @deprecated Since 0.99.0<a name="line.538"></a>
<span class="sourceLineNo">539</span> */<a name="line.539"></a>
<span class="sourceLineNo">540</span> @Deprecated<a name="line.540"></a>
<span class="sourceLineNo">541</span> public HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf)<a name="line.541"></a>
<span class="sourceLineNo">542</span> throws IOException {<a name="line.542"></a>
<span class="sourceLineNo">543</span> this(name, bindAddress, port, findPort, conf, null, null);<a name="line.543"></a>
<span class="sourceLineNo">544</span> }<a name="line.544"></a>
<span class="sourceLineNo">545</span><a name="line.545"></a>
<span class="sourceLineNo">546</span> /**<a name="line.546"></a>
<span class="sourceLineNo">547</span> * Creates a status server on the given port. The JSP scripts are taken from<a name="line.547"></a>
<span class="sourceLineNo">548</span> * src/webapp&amp;lt;name&amp;gt;.<a name="line.548"></a>
<span class="sourceLineNo">549</span> * @param name the name of the server<a name="line.549"></a>
<span class="sourceLineNo">550</span> * @param bindAddress the address for this server<a name="line.550"></a>
<span class="sourceLineNo">551</span> * @param port the port to use on the server<a name="line.551"></a>
<span class="sourceLineNo">552</span> * @param findPort whether the server should start at the given port and increment by 1 until<a name="line.552"></a>
<span class="sourceLineNo">553</span> * it finds a free port<a name="line.553"></a>
<span class="sourceLineNo">554</span> * @param conf the configuration to use<a name="line.554"></a>
<span class="sourceLineNo">555</span> * @param adminsAcl {@link AccessControlList} of the admins<a name="line.555"></a>
<span class="sourceLineNo">556</span> * @throws IOException when creating the server fails<a name="line.556"></a>
<span class="sourceLineNo">557</span> * @deprecated Since 0.99.0<a name="line.557"></a>
<span class="sourceLineNo">558</span> */<a name="line.558"></a>
<span class="sourceLineNo">559</span> @Deprecated<a name="line.559"></a>
<span class="sourceLineNo">560</span> public HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf,<a name="line.560"></a>
<span class="sourceLineNo">561</span> AccessControlList adminsAcl) throws IOException {<a name="line.561"></a>
<span class="sourceLineNo">562</span> this(name, bindAddress, port, findPort, conf, adminsAcl, null);<a name="line.562"></a>
<span class="sourceLineNo">563</span> }<a name="line.563"></a>
<span class="sourceLineNo">564</span><a name="line.564"></a>
<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
<span class="sourceLineNo">566</span> * Create a status server on the given port. The jsp scripts are taken from<a name="line.566"></a>
<span class="sourceLineNo">567</span> * src/webapps/&amp;lt;name&amp;gt;.<a name="line.567"></a>
<span class="sourceLineNo">568</span> * @param name The name of the server<a name="line.568"></a>
<span class="sourceLineNo">569</span> * @param bindAddress The address for this server<a name="line.569"></a>
<span class="sourceLineNo">570</span> * @param port The port to use on the server<a name="line.570"></a>
<span class="sourceLineNo">571</span> * @param findPort whether the server should start at the given port and increment by 1 until<a name="line.571"></a>
<span class="sourceLineNo">572</span> * it finds a free port.<a name="line.572"></a>
<span class="sourceLineNo">573</span> * @param conf Configuration<a name="line.573"></a>
<span class="sourceLineNo">574</span> * @param adminsAcl {@link AccessControlList} of the admins<a name="line.574"></a>
<span class="sourceLineNo">575</span> * @param pathSpecs Path specifications that this httpserver will be serving. These will be<a name="line.575"></a>
<span class="sourceLineNo">576</span> * added to any filters.<a name="line.576"></a>
<span class="sourceLineNo">577</span> * @deprecated Since 0.99.0<a name="line.577"></a>
<span class="sourceLineNo">578</span> */<a name="line.578"></a>
<span class="sourceLineNo">579</span> @Deprecated<a name="line.579"></a>
<span class="sourceLineNo">580</span> public HttpServer(String name, String bindAddress, int port, boolean findPort, Configuration conf,<a name="line.580"></a>
<span class="sourceLineNo">581</span> AccessControlList adminsAcl, String[] pathSpecs) throws IOException {<a name="line.581"></a>
<span class="sourceLineNo">582</span> this(new Builder().setName(name).addEndpoint(URI.create("http://" + bindAddress + ":" + port))<a name="line.582"></a>
<span class="sourceLineNo">583</span> .setFindPort(findPort).setConf(conf).setACL(adminsAcl).setPathSpec(pathSpecs));<a name="line.583"></a>
<span class="sourceLineNo">584</span> }<a name="line.584"></a>
<span class="sourceLineNo">585</span><a name="line.585"></a>
<span class="sourceLineNo">586</span> private HttpServer(final Builder b) throws IOException {<a name="line.586"></a>
<span class="sourceLineNo">587</span> this.appDir = b.appDir;<a name="line.587"></a>
<span class="sourceLineNo">588</span> this.logDir = b.logDir;<a name="line.588"></a>
<span class="sourceLineNo">589</span> final String appDir = getWebAppsPath(b.name);<a name="line.589"></a>
<span class="sourceLineNo">590</span><a name="line.590"></a>
<span class="sourceLineNo">591</span> int maxThreads = b.conf.getInt(HTTP_MAX_THREADS, 16);<a name="line.591"></a>
<span class="sourceLineNo">592</span> // If HTTP_MAX_THREADS is less than or equal to 0, QueueThreadPool() will use the<a name="line.592"></a>
<span class="sourceLineNo">593</span> // default value (currently 200).<a name="line.593"></a>
<span class="sourceLineNo">594</span> QueuedThreadPool threadPool =<a name="line.594"></a>
<span class="sourceLineNo">595</span> maxThreads &lt;= 0 ? new QueuedThreadPool() : new QueuedThreadPool(maxThreads);<a name="line.595"></a>
<span class="sourceLineNo">596</span> threadPool.setDaemon(true);<a name="line.596"></a>
<span class="sourceLineNo">597</span> this.webServer = new Server(threadPool);<a name="line.597"></a>
<span class="sourceLineNo">598</span><a name="line.598"></a>
<span class="sourceLineNo">599</span> this.adminsAcl = b.adminsAcl;<a name="line.599"></a>
<span class="sourceLineNo">600</span> this.webAppContext = createWebAppContext(b.name, b.conf, adminsAcl, appDir);<a name="line.600"></a>
<span class="sourceLineNo">601</span> this.findPort = b.findPort;<a name="line.601"></a>
<span class="sourceLineNo">602</span> this.authenticationEnabled = b.securityEnabled;<a name="line.602"></a>
<span class="sourceLineNo">603</span> initializeWebServer(b.name, b.hostName, b.conf, b.pathSpecs, b);<a name="line.603"></a>
<span class="sourceLineNo">604</span> this.webServer.setHandler(buildGzipHandler(this.webServer.getHandler()));<a name="line.604"></a>
<span class="sourceLineNo">605</span> }<a name="line.605"></a>
<span class="sourceLineNo">606</span><a name="line.606"></a>
<span class="sourceLineNo">607</span> private void initializeWebServer(String name, String hostName, Configuration conf,<a name="line.607"></a>
<span class="sourceLineNo">608</span> String[] pathSpecs, HttpServer.Builder b) throws FileNotFoundException, IOException {<a name="line.608"></a>
<span class="sourceLineNo">609</span><a name="line.609"></a>
<span class="sourceLineNo">610</span> Preconditions.checkNotNull(webAppContext);<a name="line.610"></a>
<span class="sourceLineNo">611</span><a name="line.611"></a>
<span class="sourceLineNo">612</span> HandlerCollection handlerCollection = new HandlerCollection();<a name="line.612"></a>
<span class="sourceLineNo">613</span><a name="line.613"></a>
<span class="sourceLineNo">614</span> ContextHandlerCollection contexts = new ContextHandlerCollection();<a name="line.614"></a>
<span class="sourceLineNo">615</span> RequestLog requestLog = HttpRequestLog.getRequestLog(name);<a name="line.615"></a>
<span class="sourceLineNo">616</span><a name="line.616"></a>
<span class="sourceLineNo">617</span> if (requestLog != null) {<a name="line.617"></a>
<span class="sourceLineNo">618</span> RequestLogHandler requestLogHandler = new RequestLogHandler();<a name="line.618"></a>
<span class="sourceLineNo">619</span> requestLogHandler.setRequestLog(requestLog);<a name="line.619"></a>
<span class="sourceLineNo">620</span> handlerCollection.addHandler(requestLogHandler);<a name="line.620"></a>
<span class="sourceLineNo">621</span> }<a name="line.621"></a>
<span class="sourceLineNo">622</span><a name="line.622"></a>
<span class="sourceLineNo">623</span> final String appDir = getWebAppsPath(name);<a name="line.623"></a>
<span class="sourceLineNo">624</span><a name="line.624"></a>
<span class="sourceLineNo">625</span> handlerCollection.addHandler(contexts);<a name="line.625"></a>
<span class="sourceLineNo">626</span> handlerCollection.addHandler(webAppContext);<a name="line.626"></a>
<span class="sourceLineNo">627</span><a name="line.627"></a>
<span class="sourceLineNo">628</span> webServer.setHandler(handlerCollection);<a name="line.628"></a>
<span class="sourceLineNo">629</span><a name="line.629"></a>
<span class="sourceLineNo">630</span> webAppContext.setAttribute(ADMINS_ACL, adminsAcl);<a name="line.630"></a>
<span class="sourceLineNo">631</span><a name="line.631"></a>
<span class="sourceLineNo">632</span> // Default apps need to be set first, so that all filters are applied to them.<a name="line.632"></a>
<span class="sourceLineNo">633</span> // Because they're added to defaultContexts, we need them there before we start<a name="line.633"></a>
<span class="sourceLineNo">634</span> // adding filters<a name="line.634"></a>
<span class="sourceLineNo">635</span> addDefaultApps(contexts, appDir, conf);<a name="line.635"></a>
<span class="sourceLineNo">636</span><a name="line.636"></a>
<span class="sourceLineNo">637</span> addGlobalFilter("safety", QuotingInputFilter.class.getName(), null);<a name="line.637"></a>
<span class="sourceLineNo">638</span><a name="line.638"></a>
<span class="sourceLineNo">639</span> addGlobalFilter("clickjackingprevention", ClickjackingPreventionFilter.class.getName(),<a name="line.639"></a>
<span class="sourceLineNo">640</span> ClickjackingPreventionFilter.getDefaultParameters(conf));<a name="line.640"></a>
<span class="sourceLineNo">641</span><a name="line.641"></a>
<span class="sourceLineNo">642</span> HttpConfig httpConfig = new HttpConfig(conf);<a name="line.642"></a>
<span class="sourceLineNo">643</span><a name="line.643"></a>
<span class="sourceLineNo">644</span> addGlobalFilter("securityheaders", SecurityHeadersFilter.class.getName(),<a name="line.644"></a>
<span class="sourceLineNo">645</span> SecurityHeadersFilter.getDefaultParameters(conf, httpConfig.isSecure()));<a name="line.645"></a>
<span class="sourceLineNo">646</span><a name="line.646"></a>
<span class="sourceLineNo">647</span> // But security needs to be enabled prior to adding the other servlets<a name="line.647"></a>
<span class="sourceLineNo">648</span> if (authenticationEnabled) {<a name="line.648"></a>
<span class="sourceLineNo">649</span> initSpnego(conf, hostName, b.usernameConfKey, b.keytabConfKey, b.kerberosNameRulesKey,<a name="line.649"></a>
<span class="sourceLineNo">650</span> b.signatureSecretFileKey);<a name="line.650"></a>
<span class="sourceLineNo">651</span> }<a name="line.651"></a>
<span class="sourceLineNo">652</span><a name="line.652"></a>
<span class="sourceLineNo">653</span> final FilterInitializer[] initializers = getFilterInitializers(conf);<a name="line.653"></a>
<span class="sourceLineNo">654</span> if (initializers != null) {<a name="line.654"></a>
<span class="sourceLineNo">655</span> conf = new Configuration(conf);<a name="line.655"></a>
<span class="sourceLineNo">656</span> conf.set(BIND_ADDRESS, hostName);<a name="line.656"></a>
<span class="sourceLineNo">657</span> for (FilterInitializer c : initializers) {<a name="line.657"></a>
<span class="sourceLineNo">658</span> c.initFilter(this, conf);<a name="line.658"></a>
<span class="sourceLineNo">659</span> }<a name="line.659"></a>
<span class="sourceLineNo">660</span> }<a name="line.660"></a>
<span class="sourceLineNo">661</span><a name="line.661"></a>
<span class="sourceLineNo">662</span> addDefaultServlets(contexts, conf);<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span> if (pathSpecs != null) {<a name="line.664"></a>
<span class="sourceLineNo">665</span> for (String path : pathSpecs) {<a name="line.665"></a>
<span class="sourceLineNo">666</span> LOG.info("adding path spec: " + path);<a name="line.666"></a>
<span class="sourceLineNo">667</span> addFilterPathMapping(path, webAppContext);<a name="line.667"></a>
<span class="sourceLineNo">668</span> }<a name="line.668"></a>
<span class="sourceLineNo">669</span> }<a name="line.669"></a>
<span class="sourceLineNo">670</span> // Check if disable stack trace property is configured<a name="line.670"></a>
<span class="sourceLineNo">671</span> if (!conf.getBoolean(HTTP_UI_SHOW_STACKTRACE_KEY, true)) {<a name="line.671"></a>
<span class="sourceLineNo">672</span> // Disable stack traces for server errors in UI<a name="line.672"></a>
<span class="sourceLineNo">673</span> webServer.setErrorHandler(new ErrorHandler());<a name="line.673"></a>
<span class="sourceLineNo">674</span> webServer.getErrorHandler().setShowStacks(false);<a name="line.674"></a>
<span class="sourceLineNo">675</span> // Disable stack traces for web app errors in UI<a name="line.675"></a>
<span class="sourceLineNo">676</span> webAppContext.getErrorHandler().setShowStacks(false);<a name="line.676"></a>
<span class="sourceLineNo">677</span> }<a name="line.677"></a>
<span class="sourceLineNo">678</span> }<a name="line.678"></a>
<span class="sourceLineNo">679</span><a name="line.679"></a>
<span class="sourceLineNo">680</span> private void addManagedListener(ServerConnector connector) {<a name="line.680"></a>
<span class="sourceLineNo">681</span> listeners.add(new ListenerInfo(true, connector));<a name="line.681"></a>
<span class="sourceLineNo">682</span> }<a name="line.682"></a>
<span class="sourceLineNo">683</span><a name="line.683"></a>
<span class="sourceLineNo">684</span> private static WebAppContext createWebAppContext(String name, Configuration conf,<a name="line.684"></a>
<span class="sourceLineNo">685</span> AccessControlList adminsAcl, final String appDir) {<a name="line.685"></a>
<span class="sourceLineNo">686</span> WebAppContext ctx = new WebAppContext();<a name="line.686"></a>
<span class="sourceLineNo">687</span> ctx.setDisplayName(name);<a name="line.687"></a>
<span class="sourceLineNo">688</span> ctx.setContextPath("/");<a name="line.688"></a>
<span class="sourceLineNo">689</span> ctx.setWar(appDir + "/" + name);<a name="line.689"></a>
<span class="sourceLineNo">690</span> ctx.getServletContext().setAttribute(CONF_CONTEXT_ATTRIBUTE, conf);<a name="line.690"></a>
<span class="sourceLineNo">691</span> // for org.apache.hadoop.metrics.MetricsServlet<a name="line.691"></a>
<span class="sourceLineNo">692</span> ctx.getServletContext().setAttribute(org.apache.hadoop.http.HttpServer2.CONF_CONTEXT_ATTRIBUTE,<a name="line.692"></a>
<span class="sourceLineNo">693</span> conf);<a name="line.693"></a>
<span class="sourceLineNo">694</span> ctx.getServletContext().setAttribute(ADMINS_ACL, adminsAcl);<a name="line.694"></a>
<span class="sourceLineNo">695</span> addNoCacheFilter(ctx, conf);<a name="line.695"></a>
<span class="sourceLineNo">696</span> return ctx;<a name="line.696"></a>
<span class="sourceLineNo">697</span> }<a name="line.697"></a>
<span class="sourceLineNo">698</span><a name="line.698"></a>
<span class="sourceLineNo">699</span> /**<a name="line.699"></a>
<span class="sourceLineNo">700</span> * Construct and configure an instance of {@link GzipHandler}. With complex<a name="line.700"></a>
<span class="sourceLineNo">701</span> * multi-{@link WebAppContext} configurations, it's easiest to apply this handler directly to the<a name="line.701"></a>
<span class="sourceLineNo">702</span> * instance of {@link Server} near the end of its configuration, something like<a name="line.702"></a>
<span class="sourceLineNo">703</span> *<a name="line.703"></a>
<span class="sourceLineNo">704</span> * &lt;pre&gt;<a name="line.704"></a>
<span class="sourceLineNo">705</span> * Server server = new Server();<a name="line.705"></a>
<span class="sourceLineNo">706</span> * // ...<a name="line.706"></a>
<span class="sourceLineNo">707</span> * server.setHandler(buildGzipHandler(server.getHandler()));<a name="line.707"></a>
<span class="sourceLineNo">708</span> * server.start();<a name="line.708"></a>
<span class="sourceLineNo">709</span> * &lt;/pre&gt;<a name="line.709"></a>
<span class="sourceLineNo">710</span> */<a name="line.710"></a>
<span class="sourceLineNo">711</span> public static GzipHandler buildGzipHandler(final Handler wrapped) {<a name="line.711"></a>
<span class="sourceLineNo">712</span> final GzipHandler gzipHandler = new GzipHandler();<a name="line.712"></a>
<span class="sourceLineNo">713</span> gzipHandler.setHandler(wrapped);<a name="line.713"></a>
<span class="sourceLineNo">714</span> return gzipHandler;<a name="line.714"></a>
<span class="sourceLineNo">715</span> }<a name="line.715"></a>
<span class="sourceLineNo">716</span><a name="line.716"></a>
<span class="sourceLineNo">717</span> private static void addNoCacheFilter(ServletContextHandler ctxt, Configuration conf) {<a name="line.717"></a>
<span class="sourceLineNo">718</span> if (conf.getBoolean(HTTP_UI_NO_CACHE_ENABLE_KEY, false)) {<a name="line.718"></a>
<span class="sourceLineNo">719</span> Map&lt;String, String&gt; filterConfig =<a name="line.719"></a>
<span class="sourceLineNo">720</span> AuthenticationFilterInitializer.getFilterConfigMap(conf, "hbase.http.filter.");<a name="line.720"></a>
<span class="sourceLineNo">721</span> defineFilter(ctxt, NO_CACHE_FILTER, NoCacheFilter.class.getName(), filterConfig,<a name="line.721"></a>
<span class="sourceLineNo">722</span> new String[] { "/*" });<a name="line.722"></a>
<span class="sourceLineNo">723</span> } else {<a name="line.723"></a>
<span class="sourceLineNo">724</span> defineFilter(ctxt, NO_CACHE_FILTER, NoCacheFilter.class.getName(),<a name="line.724"></a>
<span class="sourceLineNo">725</span> Collections.&lt;String, String&gt; emptyMap(), new String[] { "/*" });<a name="line.725"></a>
<span class="sourceLineNo">726</span> }<a name="line.726"></a>
<span class="sourceLineNo">727</span> }<a name="line.727"></a>
<span class="sourceLineNo">728</span><a name="line.728"></a>
<span class="sourceLineNo">729</span> /** Get an array of FilterConfiguration specified in the conf */<a name="line.729"></a>
<span class="sourceLineNo">730</span> private static FilterInitializer[] getFilterInitializers(Configuration conf) {<a name="line.730"></a>
<span class="sourceLineNo">731</span> if (conf == null) {<a name="line.731"></a>
<span class="sourceLineNo">732</span> return null;<a name="line.732"></a>
<span class="sourceLineNo">733</span> }<a name="line.733"></a>
<span class="sourceLineNo">734</span><a name="line.734"></a>
<span class="sourceLineNo">735</span> Class&lt;?&gt;[] classes = conf.getClasses(FILTER_INITIALIZERS_PROPERTY);<a name="line.735"></a>
<span class="sourceLineNo">736</span> if (classes == null) {<a name="line.736"></a>
<span class="sourceLineNo">737</span> return null;<a name="line.737"></a>
<span class="sourceLineNo">738</span> }<a name="line.738"></a>
<span class="sourceLineNo">739</span><a name="line.739"></a>
<span class="sourceLineNo">740</span> FilterInitializer[] initializers = new FilterInitializer[classes.length];<a name="line.740"></a>
<span class="sourceLineNo">741</span> for (int i = 0; i &lt; classes.length; i++) {<a name="line.741"></a>
<span class="sourceLineNo">742</span> initializers[i] = (FilterInitializer) ReflectionUtils.newInstance(classes[i]);<a name="line.742"></a>
<span class="sourceLineNo">743</span> }<a name="line.743"></a>
<span class="sourceLineNo">744</span> return initializers;<a name="line.744"></a>
<span class="sourceLineNo">745</span> }<a name="line.745"></a>
<span class="sourceLineNo">746</span><a name="line.746"></a>
<span class="sourceLineNo">747</span> /**<a name="line.747"></a>
<span class="sourceLineNo">748</span> * Add default apps.<a name="line.748"></a>
<span class="sourceLineNo">749</span> * @param appDir The application directory<a name="line.749"></a>
<span class="sourceLineNo">750</span> */<a name="line.750"></a>
<span class="sourceLineNo">751</span> protected void addDefaultApps(ContextHandlerCollection parent, final String appDir,<a name="line.751"></a>
<span class="sourceLineNo">752</span> Configuration conf) {<a name="line.752"></a>
<span class="sourceLineNo">753</span> // set up the context for "/logs/" if "hadoop.log.dir" property is defined.<a name="line.753"></a>
<span class="sourceLineNo">754</span> String logDir = this.logDir;<a name="line.754"></a>
<span class="sourceLineNo">755</span> if (logDir == null) {<a name="line.755"></a>
<span class="sourceLineNo">756</span> logDir = System.getProperty("hadoop.log.dir");<a name="line.756"></a>
<span class="sourceLineNo">757</span> }<a name="line.757"></a>
<span class="sourceLineNo">758</span> if (logDir != null) {<a name="line.758"></a>
<span class="sourceLineNo">759</span> ServletContextHandler logContext = new ServletContextHandler(parent, "/logs");<a name="line.759"></a>
<span class="sourceLineNo">760</span> logContext.addServlet(AdminAuthorizedServlet.class, "/*");<a name="line.760"></a>
<span class="sourceLineNo">761</span> logContext.setResourceBase(logDir);<a name="line.761"></a>
<span class="sourceLineNo">762</span> logContext.setDisplayName("logs");<a name="line.762"></a>
<span class="sourceLineNo">763</span> configureAliasChecks(logContext,<a name="line.763"></a>
<span class="sourceLineNo">764</span> conf.getBoolean(ServerConfigurationKeys.HBASE_JETTY_LOGS_SERVE_ALIASES,<a name="line.764"></a>
<span class="sourceLineNo">765</span> ServerConfigurationKeys.DEFAULT_HBASE_JETTY_LOGS_SERVE_ALIASES));<a name="line.765"></a>
<span class="sourceLineNo">766</span> setContextAttributes(logContext, conf);<a name="line.766"></a>
<span class="sourceLineNo">767</span> addNoCacheFilter(logContext, conf);<a name="line.767"></a>
<span class="sourceLineNo">768</span> defaultContexts.put(logContext, true);<a name="line.768"></a>
<span class="sourceLineNo">769</span> }<a name="line.769"></a>
<span class="sourceLineNo">770</span> // set up the context for "/static/*"<a name="line.770"></a>
<span class="sourceLineNo">771</span> ServletContextHandler staticContext = new ServletContextHandler(parent, "/static");<a name="line.771"></a>
<span class="sourceLineNo">772</span> staticContext.setResourceBase(appDir + "/static");<a name="line.772"></a>
<span class="sourceLineNo">773</span> staticContext.addServlet(DefaultServlet.class, "/*");<a name="line.773"></a>
<span class="sourceLineNo">774</span> staticContext.setDisplayName("static");<a name="line.774"></a>
<span class="sourceLineNo">775</span> setContextAttributes(staticContext, conf);<a name="line.775"></a>
<span class="sourceLineNo">776</span> defaultContexts.put(staticContext, true);<a name="line.776"></a>
<span class="sourceLineNo">777</span> }<a name="line.777"></a>
<span class="sourceLineNo">778</span><a name="line.778"></a>
<span class="sourceLineNo">779</span> /**<a name="line.779"></a>
<span class="sourceLineNo">780</span> * This method configures the alias checks for the given ServletContextHandler based on the<a name="line.780"></a>
<span class="sourceLineNo">781</span> * provided value of shouldServeAlias.&lt;br&gt;<a name="line.781"></a>
<span class="sourceLineNo">782</span> * If shouldServeAlias is set to true, it checks if SymlinkAllowedResourceAliasChecker is already<a name="line.782"></a>
<span class="sourceLineNo">783</span> * a part of the alias check list. If it is already a part of the list, no changes are made, else,<a name="line.783"></a>
<span class="sourceLineNo">784</span> * it adds it to the list.&lt;br&gt;<a name="line.784"></a>
<span class="sourceLineNo">785</span> * If shouldServeAlias is set to false, it clears all alias checks from the<a name="line.785"></a>
<span class="sourceLineNo">786</span> * ServletContextHandler.&lt;br&gt;<a name="line.786"></a>
<span class="sourceLineNo">787</span> * .<a name="line.787"></a>
<span class="sourceLineNo">788</span> * @param context The ServletContextHandler whose alias checks are to be configured<a name="line.788"></a>
<span class="sourceLineNo">789</span> * @param shouldServeAlias Whether aliases should be allowed or not<a name="line.789"></a>
<span class="sourceLineNo">790</span> */<a name="line.790"></a>
<span class="sourceLineNo">791</span> private void configureAliasChecks(ServletContextHandler context, boolean shouldServeAlias) {<a name="line.791"></a>
<span class="sourceLineNo">792</span> if (shouldServeAlias) {<a name="line.792"></a>
<span class="sourceLineNo">793</span> Class aliasCheckerClass = SymlinkAllowedResourceAliasChecker.class;<a name="line.793"></a>
<span class="sourceLineNo">794</span> // check if SymlinkAllowedResourceAliasChecker is already part of alias check list<a name="line.794"></a>
<span class="sourceLineNo">795</span> // NOTE: we are doing this because this is already present in the context (by default)<a name="line.795"></a>
<span class="sourceLineNo">796</span> if (context.getAliasChecks().stream().anyMatch(aliasCheckerClass::isInstance)) {<a name="line.796"></a>
<span class="sourceLineNo">797</span> LOG.debug("{} is already part of alias check list", aliasCheckerClass.getName());<a name="line.797"></a>
<span class="sourceLineNo">798</span> } else {<a name="line.798"></a>
<span class="sourceLineNo">799</span> context.addAliasCheck(new SymlinkAllowedResourceAliasChecker(context));<a name="line.799"></a>
<span class="sourceLineNo">800</span> LOG.debug("{} added to the alias check list", aliasCheckerClass.getName());<a name="line.800"></a>
<span class="sourceLineNo">801</span> }<a name="line.801"></a>
<span class="sourceLineNo">802</span> LOG.info("Serving aliases allowed for /logs context");<a name="line.802"></a>
<span class="sourceLineNo">803</span> } else {<a name="line.803"></a>
<span class="sourceLineNo">804</span> // if aliasing is disabled, then we should clear the alias check list<a name="line.804"></a>
<span class="sourceLineNo">805</span> context.clearAliasChecks();<a name="line.805"></a>
<span class="sourceLineNo">806</span> LOG.info("Serving aliases disabled for /logs context");<a name="line.806"></a>
<span class="sourceLineNo">807</span> }<a name="line.807"></a>
<span class="sourceLineNo">808</span> }<a name="line.808"></a>
<span class="sourceLineNo">809</span><a name="line.809"></a>
<span class="sourceLineNo">810</span> private void setContextAttributes(ServletContextHandler context, Configuration conf) {<a name="line.810"></a>
<span class="sourceLineNo">811</span> context.getServletContext().setAttribute(CONF_CONTEXT_ATTRIBUTE, conf);<a name="line.811"></a>
<span class="sourceLineNo">812</span> context.getServletContext().setAttribute(ADMINS_ACL, adminsAcl);<a name="line.812"></a>
<span class="sourceLineNo">813</span> }<a name="line.813"></a>
<span class="sourceLineNo">814</span><a name="line.814"></a>
<span class="sourceLineNo">815</span> /**<a name="line.815"></a>
<span class="sourceLineNo">816</span> * Add default servlets.<a name="line.816"></a>
<span class="sourceLineNo">817</span> */<a name="line.817"></a>
<span class="sourceLineNo">818</span> protected void addDefaultServlets(ContextHandlerCollection contexts, Configuration conf)<a name="line.818"></a>
<span class="sourceLineNo">819</span> throws IOException {<a name="line.819"></a>
<span class="sourceLineNo">820</span> // set up default servlets<a name="line.820"></a>
<span class="sourceLineNo">821</span> addPrivilegedServlet("stacks", "/stacks", StackServlet.class);<a name="line.821"></a>
<span class="sourceLineNo">822</span> addPrivilegedServlet("logLevel", "/logLevel", LogLevel.Servlet.class);<a name="line.822"></a>
<span class="sourceLineNo">823</span><a name="line.823"></a>
<span class="sourceLineNo">824</span> // While we don't expect users to have sensitive information in their configuration, they<a name="line.824"></a>
<span class="sourceLineNo">825</span> // might. Give them an option to not expose the service configuration to all users.<a name="line.825"></a>
<span class="sourceLineNo">826</span> if (conf.getBoolean(HTTP_PRIVILEGED_CONF_KEY, HTTP_PRIVILEGED_CONF_DEFAULT)) {<a name="line.826"></a>
<span class="sourceLineNo">827</span> addPrivilegedServlet("conf", "/conf", ConfServlet.class);<a name="line.827"></a>
<span class="sourceLineNo">828</span> } else {<a name="line.828"></a>
<span class="sourceLineNo">829</span> addUnprivilegedServlet("conf", "/conf", ConfServlet.class);<a name="line.829"></a>
<span class="sourceLineNo">830</span> }<a name="line.830"></a>
<span class="sourceLineNo">831</span> final String asyncProfilerHome = ProfileServlet.getAsyncProfilerHome();<a name="line.831"></a>
<span class="sourceLineNo">832</span> if (asyncProfilerHome != null &amp;&amp; !asyncProfilerHome.trim().isEmpty()) {<a name="line.832"></a>
<span class="sourceLineNo">833</span> addPrivilegedServlet("prof", "/prof", ProfileServlet.class);<a name="line.833"></a>
<span class="sourceLineNo">834</span> Path tmpDir = Paths.get(ProfileServlet.OUTPUT_DIR);<a name="line.834"></a>
<span class="sourceLineNo">835</span> if (Files.notExists(tmpDir)) {<a name="line.835"></a>
<span class="sourceLineNo">836</span> Files.createDirectories(tmpDir);<a name="line.836"></a>
<span class="sourceLineNo">837</span> }<a name="line.837"></a>
<span class="sourceLineNo">838</span> ServletContextHandler genCtx = new ServletContextHandler(contexts, "/prof-output-hbase");<a name="line.838"></a>
<span class="sourceLineNo">839</span> genCtx.addServlet(ProfileOutputServlet.class, "/*");<a name="line.839"></a>
<span class="sourceLineNo">840</span> genCtx.setResourceBase(tmpDir.toAbsolutePath().toString());<a name="line.840"></a>
<span class="sourceLineNo">841</span> genCtx.setDisplayName("prof-output-hbase");<a name="line.841"></a>
<span class="sourceLineNo">842</span> } else {<a name="line.842"></a>
<span class="sourceLineNo">843</span> addUnprivilegedServlet("prof", "/prof", ProfileServlet.DisabledServlet.class);<a name="line.843"></a>
<span class="sourceLineNo">844</span> LOG.info("ASYNC_PROFILER_HOME environment variable and async.profiler.home system property "<a name="line.844"></a>
<span class="sourceLineNo">845</span> + "not specified. Disabling /prof endpoint.");<a name="line.845"></a>
<span class="sourceLineNo">846</span> }<a name="line.846"></a>
<span class="sourceLineNo">847</span><a name="line.847"></a>
<span class="sourceLineNo">848</span> /* register metrics servlets */<a name="line.848"></a>
<span class="sourceLineNo">849</span> String[] enabledServlets = conf.getStrings(METRIC_SERVLETS_CONF_KEY, METRICS_SERVLETS_DEFAULT);<a name="line.849"></a>
<span class="sourceLineNo">850</span> for (String enabledServlet : enabledServlets) {<a name="line.850"></a>
<span class="sourceLineNo">851</span> ServletConfig servletConfig = METRIC_SERVLETS.get(enabledServlet);<a name="line.851"></a>
<span class="sourceLineNo">852</span> if (servletConfig != null) {<a name="line.852"></a>
<span class="sourceLineNo">853</span> try {<a name="line.853"></a>
<span class="sourceLineNo">854</span> Class&lt;?&gt; clz = Class.forName(servletConfig.getClazz());<a name="line.854"></a>
<span class="sourceLineNo">855</span> addPrivilegedServlet(servletConfig.getName(), servletConfig.getPathSpec(),<a name="line.855"></a>
<span class="sourceLineNo">856</span> clz.asSubclass(HttpServlet.class));<a name="line.856"></a>
<span class="sourceLineNo">857</span> } catch (Exception e) {<a name="line.857"></a>
<span class="sourceLineNo">858</span> if (servletConfig.isExpected()) {<a name="line.858"></a>
<span class="sourceLineNo">859</span> // metrics are not critical to read/write, so an exception here shouldn't be fatal<a name="line.859"></a>
<span class="sourceLineNo">860</span> // if the class was expected we should warn though<a name="line.860"></a>
<span class="sourceLineNo">861</span> LOG.warn("Couldn't register the servlet " + enabledServlet, e);<a name="line.861"></a>
<span class="sourceLineNo">862</span> }<a name="line.862"></a>
<span class="sourceLineNo">863</span> }<a name="line.863"></a>
<span class="sourceLineNo">864</span> }<a name="line.864"></a>
<span class="sourceLineNo">865</span> }<a name="line.865"></a>
<span class="sourceLineNo">866</span> }<a name="line.866"></a>
<span class="sourceLineNo">867</span><a name="line.867"></a>
<span class="sourceLineNo">868</span> /**<a name="line.868"></a>
<span class="sourceLineNo">869</span> * Set a value in the webapp context. These values are available to the jsp pages as<a name="line.869"></a>
<span class="sourceLineNo">870</span> * "application.getAttribute(name)".<a name="line.870"></a>
<span class="sourceLineNo">871</span> * @param name The name of the attribute<a name="line.871"></a>
<span class="sourceLineNo">872</span> * @param value The value of the attribute<a name="line.872"></a>
<span class="sourceLineNo">873</span> */<a name="line.873"></a>
<span class="sourceLineNo">874</span> public void setAttribute(String name, Object value) {<a name="line.874"></a>
<span class="sourceLineNo">875</span> webAppContext.setAttribute(name, value);<a name="line.875"></a>
<span class="sourceLineNo">876</span> }<a name="line.876"></a>
<span class="sourceLineNo">877</span><a name="line.877"></a>
<span class="sourceLineNo">878</span> /**<a name="line.878"></a>
<span class="sourceLineNo">879</span> * Add a Jersey resource package.<a name="line.879"></a>
<span class="sourceLineNo">880</span> * @param packageName The Java package name containing the Jersey resource.<a name="line.880"></a>
<span class="sourceLineNo">881</span> * @param pathSpec The path spec for the servlet<a name="line.881"></a>
<span class="sourceLineNo">882</span> */<a name="line.882"></a>
<span class="sourceLineNo">883</span> public void addJerseyResourcePackage(final String packageName, final String pathSpec) {<a name="line.883"></a>
<span class="sourceLineNo">884</span> LOG.info("addJerseyResourcePackage: packageName=" + packageName + ", pathSpec=" + pathSpec);<a name="line.884"></a>
<span class="sourceLineNo">885</span><a name="line.885"></a>
<span class="sourceLineNo">886</span> ResourceConfig application = new ResourceConfig().packages(packageName);<a name="line.886"></a>
<span class="sourceLineNo">887</span> final ServletHolder sh = new ServletHolder(new ServletContainer(application));<a name="line.887"></a>
<span class="sourceLineNo">888</span> webAppContext.addServlet(sh, pathSpec);<a name="line.888"></a>
<span class="sourceLineNo">889</span> }<a name="line.889"></a>
<span class="sourceLineNo">890</span><a name="line.890"></a>
<span class="sourceLineNo">891</span> /**<a name="line.891"></a>
<span class="sourceLineNo">892</span> * Adds a servlet in the server that any user can access. This method differs from<a name="line.892"></a>
<span class="sourceLineNo">893</span> * {@link #addPrivilegedServlet(String, String, Class)} in that any authenticated user can<a name="line.893"></a>
<span class="sourceLineNo">894</span> * interact with the servlet added by this method.<a name="line.894"></a>
<span class="sourceLineNo">895</span> * @param name The name of the servlet (can be passed as null)<a name="line.895"></a>
<span class="sourceLineNo">896</span> * @param pathSpec The path spec for the servlet<a name="line.896"></a>
<span class="sourceLineNo">897</span> * @param clazz The servlet class<a name="line.897"></a>
<span class="sourceLineNo">898</span> */<a name="line.898"></a>
<span class="sourceLineNo">899</span> public void addUnprivilegedServlet(String name, String pathSpec,<a name="line.899"></a>
<span class="sourceLineNo">900</span> Class&lt;? extends HttpServlet&gt; clazz) {<a name="line.900"></a>
<span class="sourceLineNo">901</span> addServletWithAuth(name, pathSpec, clazz, false);<a name="line.901"></a>
<span class="sourceLineNo">902</span> }<a name="line.902"></a>
<span class="sourceLineNo">903</span><a name="line.903"></a>
<span class="sourceLineNo">904</span> /**<a name="line.904"></a>
<span class="sourceLineNo">905</span> * Adds a servlet in the server that any user can access. This method differs from<a name="line.905"></a>
<span class="sourceLineNo">906</span> * {@link #addPrivilegedServlet(String, ServletHolder)} in that any authenticated user can<a name="line.906"></a>
<span class="sourceLineNo">907</span> * interact with the servlet added by this method.<a name="line.907"></a>
<span class="sourceLineNo">908</span> * @param pathSpec The path spec for the servlet<a name="line.908"></a>
<span class="sourceLineNo">909</span> * @param holder The servlet holder<a name="line.909"></a>
<span class="sourceLineNo">910</span> */<a name="line.910"></a>
<span class="sourceLineNo">911</span> public void addUnprivilegedServlet(String pathSpec, ServletHolder holder) {<a name="line.911"></a>
<span class="sourceLineNo">912</span> addServletWithAuth(pathSpec, holder, false);<a name="line.912"></a>
<span class="sourceLineNo">913</span> }<a name="line.913"></a>
<span class="sourceLineNo">914</span><a name="line.914"></a>
<span class="sourceLineNo">915</span> /**<a name="line.915"></a>
<span class="sourceLineNo">916</span> * Adds a servlet in the server that only administrators can access. This method differs from<a name="line.916"></a>
<span class="sourceLineNo">917</span> * {@link #addUnprivilegedServlet(String, String, Class)} in that only those authenticated user<a name="line.917"></a>
<span class="sourceLineNo">918</span> * who are identified as administrators can interact with the servlet added by this method.<a name="line.918"></a>
<span class="sourceLineNo">919</span> */<a name="line.919"></a>
<span class="sourceLineNo">920</span> public void addPrivilegedServlet(String name, String pathSpec,<a name="line.920"></a>
<span class="sourceLineNo">921</span> Class&lt;? extends HttpServlet&gt; clazz) {<a name="line.921"></a>
<span class="sourceLineNo">922</span> addServletWithAuth(name, pathSpec, clazz, true);<a name="line.922"></a>
<span class="sourceLineNo">923</span> }<a name="line.923"></a>
<span class="sourceLineNo">924</span><a name="line.924"></a>
<span class="sourceLineNo">925</span> /**<a name="line.925"></a>
<span class="sourceLineNo">926</span> * Adds a servlet in the server that only administrators can access. This method differs from<a name="line.926"></a>
<span class="sourceLineNo">927</span> * {@link #addUnprivilegedServlet(String, ServletHolder)} in that only those authenticated user<a name="line.927"></a>
<span class="sourceLineNo">928</span> * who are identified as administrators can interact with the servlet added by this method.<a name="line.928"></a>
<span class="sourceLineNo">929</span> */<a name="line.929"></a>
<span class="sourceLineNo">930</span> public void addPrivilegedServlet(String pathSpec, ServletHolder holder) {<a name="line.930"></a>
<span class="sourceLineNo">931</span> addServletWithAuth(pathSpec, holder, true);<a name="line.931"></a>
<span class="sourceLineNo">932</span> }<a name="line.932"></a>
<span class="sourceLineNo">933</span><a name="line.933"></a>
<span class="sourceLineNo">934</span> /**<a name="line.934"></a>
<span class="sourceLineNo">935</span> * Internal method to add a servlet to the HTTP server. Developers should not call this method<a name="line.935"></a>
<span class="sourceLineNo">936</span> * directly, but invoke it via {@link #addUnprivilegedServlet(String, String, Class)} or<a name="line.936"></a>
<span class="sourceLineNo">937</span> * {@link #addPrivilegedServlet(String, String, Class)}.<a name="line.937"></a>
<span class="sourceLineNo">938</span> */<a name="line.938"></a>
<span class="sourceLineNo">939</span> void addServletWithAuth(String name, String pathSpec, Class&lt;? extends HttpServlet&gt; clazz,<a name="line.939"></a>
<span class="sourceLineNo">940</span> boolean requireAuthz) {<a name="line.940"></a>
<span class="sourceLineNo">941</span> addInternalServlet(name, pathSpec, clazz, requireAuthz);<a name="line.941"></a>
<span class="sourceLineNo">942</span> addFilterPathMapping(pathSpec, webAppContext);<a name="line.942"></a>
<span class="sourceLineNo">943</span> }<a name="line.943"></a>
<span class="sourceLineNo">944</span><a name="line.944"></a>
<span class="sourceLineNo">945</span> /**<a name="line.945"></a>
<span class="sourceLineNo">946</span> * Internal method to add a servlet to the HTTP server. Developers should not call this method<a name="line.946"></a>
<span class="sourceLineNo">947</span> * directly, but invoke it via {@link #addUnprivilegedServlet(String, ServletHolder)} or<a name="line.947"></a>
<span class="sourceLineNo">948</span> * {@link #addPrivilegedServlet(String, ServletHolder)}.<a name="line.948"></a>
<span class="sourceLineNo">949</span> */<a name="line.949"></a>
<span class="sourceLineNo">950</span> void addServletWithAuth(String pathSpec, ServletHolder holder, boolean requireAuthz) {<a name="line.950"></a>
<span class="sourceLineNo">951</span> addInternalServlet(pathSpec, holder, requireAuthz);<a name="line.951"></a>
<span class="sourceLineNo">952</span> addFilterPathMapping(pathSpec, webAppContext);<a name="line.952"></a>
<span class="sourceLineNo">953</span> }<a name="line.953"></a>
<span class="sourceLineNo">954</span><a name="line.954"></a>
<span class="sourceLineNo">955</span> /**<a name="line.955"></a>
<span class="sourceLineNo">956</span> * Add an internal servlet in the server, specifying whether or not to protect with Kerberos<a name="line.956"></a>
<span class="sourceLineNo">957</span> * authentication. Note: This method is to be used for adding servlets that facilitate internal<a name="line.957"></a>
<span class="sourceLineNo">958</span> * communication and not for user facing functionality. For servlets added using this method,<a name="line.958"></a>
<span class="sourceLineNo">959</span> * filters (except internal Kerberos filters) are not enabled.<a name="line.959"></a>
<span class="sourceLineNo">960</span> * @param name The name of the {@link Servlet} (can be passed as null)<a name="line.960"></a>
<span class="sourceLineNo">961</span> * @param pathSpec The path spec for the {@link Servlet}<a name="line.961"></a>
<span class="sourceLineNo">962</span> * @param clazz The {@link Servlet} class<a name="line.962"></a>
<span class="sourceLineNo">963</span> * @param requireAuthz Require Kerberos authenticate to access servlet<a name="line.963"></a>
<span class="sourceLineNo">964</span> */<a name="line.964"></a>
<span class="sourceLineNo">965</span> void addInternalServlet(String name, String pathSpec, Class&lt;? extends HttpServlet&gt; clazz,<a name="line.965"></a>
<span class="sourceLineNo">966</span> boolean requireAuthz) {<a name="line.966"></a>
<span class="sourceLineNo">967</span> ServletHolder holder = new ServletHolder(clazz);<a name="line.967"></a>
<span class="sourceLineNo">968</span> if (name != null) {<a name="line.968"></a>
<span class="sourceLineNo">969</span> holder.setName(name);<a name="line.969"></a>
<span class="sourceLineNo">970</span> }<a name="line.970"></a>
<span class="sourceLineNo">971</span> addInternalServlet(pathSpec, holder, requireAuthz);<a name="line.971"></a>
<span class="sourceLineNo">972</span> }<a name="line.972"></a>
<span class="sourceLineNo">973</span><a name="line.973"></a>
<span class="sourceLineNo">974</span> /**<a name="line.974"></a>
<span class="sourceLineNo">975</span> * Add an internal servlet in the server, specifying whether or not to protect with Kerberos<a name="line.975"></a>
<span class="sourceLineNo">976</span> * authentication. Note: This method is to be used for adding servlets that facilitate internal<a name="line.976"></a>
<span class="sourceLineNo">977</span> * communication and not for user facing functionality. For servlets added using this method,<a name="line.977"></a>
<span class="sourceLineNo">978</span> * filters (except internal Kerberos filters) are not enabled.<a name="line.978"></a>
<span class="sourceLineNo">979</span> * @param pathSpec The path spec for the {@link Servlet}<a name="line.979"></a>
<span class="sourceLineNo">980</span> * @param holder The object providing the {@link Servlet} instance<a name="line.980"></a>
<span class="sourceLineNo">981</span> * @param requireAuthz Require Kerberos authenticate to access servlet<a name="line.981"></a>
<span class="sourceLineNo">982</span> */<a name="line.982"></a>
<span class="sourceLineNo">983</span> void addInternalServlet(String pathSpec, ServletHolder holder, boolean requireAuthz) {<a name="line.983"></a>
<span class="sourceLineNo">984</span> if (authenticationEnabled &amp;&amp; requireAuthz) {<a name="line.984"></a>
<span class="sourceLineNo">985</span> FilterHolder filter = new FilterHolder(AdminAuthorizedFilter.class);<a name="line.985"></a>
<span class="sourceLineNo">986</span> filter.setName(AdminAuthorizedFilter.class.getSimpleName());<a name="line.986"></a>
<span class="sourceLineNo">987</span> FilterMapping fmap = new FilterMapping();<a name="line.987"></a>
<span class="sourceLineNo">988</span> fmap.setPathSpec(pathSpec);<a name="line.988"></a>
<span class="sourceLineNo">989</span> fmap.setDispatches(FilterMapping.ALL);<a name="line.989"></a>
<span class="sourceLineNo">990</span> fmap.setFilterName(AdminAuthorizedFilter.class.getSimpleName());<a name="line.990"></a>
<span class="sourceLineNo">991</span> webAppContext.getServletHandler().addFilter(filter, fmap);<a name="line.991"></a>
<span class="sourceLineNo">992</span> }<a name="line.992"></a>
<span class="sourceLineNo">993</span> webAppContext.getSessionHandler().getSessionCookieConfig().setHttpOnly(true);<a name="line.993"></a>
<span class="sourceLineNo">994</span> webAppContext.getSessionHandler().getSessionCookieConfig().setSecure(true);<a name="line.994"></a>
<span class="sourceLineNo">995</span> webAppContext.addServlet(holder, pathSpec);<a name="line.995"></a>
<span class="sourceLineNo">996</span> }<a name="line.996"></a>
<span class="sourceLineNo">997</span><a name="line.997"></a>
<span class="sourceLineNo">998</span> @Override<a name="line.998"></a>
<span class="sourceLineNo">999</span> public void addFilter(String name, String classname, Map&lt;String, String&gt; parameters) {<a name="line.999"></a>
<span class="sourceLineNo">1000</span> final String[] USER_FACING_URLS = { "*.html", "*.jsp" };<a name="line.1000"></a>
<span class="sourceLineNo">1001</span> defineFilter(webAppContext, name, classname, parameters, USER_FACING_URLS);<a name="line.1001"></a>
<span class="sourceLineNo">1002</span> LOG.info("Added filter " + name + " (class=" + classname + ") to context "<a name="line.1002"></a>
<span class="sourceLineNo">1003</span> + webAppContext.getDisplayName());<a name="line.1003"></a>
<span class="sourceLineNo">1004</span> final String[] ALL_URLS = { "/*" };<a name="line.1004"></a>
<span class="sourceLineNo">1005</span> for (Map.Entry&lt;ServletContextHandler, Boolean&gt; e : defaultContexts.entrySet()) {<a name="line.1005"></a>
<span class="sourceLineNo">1006</span> if (e.getValue()) {<a name="line.1006"></a>
<span class="sourceLineNo">1007</span> ServletContextHandler handler = e.getKey();<a name="line.1007"></a>
<span class="sourceLineNo">1008</span> defineFilter(handler, name, classname, parameters, ALL_URLS);<a name="line.1008"></a>
<span class="sourceLineNo">1009</span> LOG.info("Added filter " + name + " (class=" + classname + ") to context "<a name="line.1009"></a>
<span class="sourceLineNo">1010</span> + handler.getDisplayName());<a name="line.1010"></a>
<span class="sourceLineNo">1011</span> }<a name="line.1011"></a>
<span class="sourceLineNo">1012</span> }<a name="line.1012"></a>
<span class="sourceLineNo">1013</span> filterNames.add(name);<a name="line.1013"></a>
<span class="sourceLineNo">1014</span> }<a name="line.1014"></a>
<span class="sourceLineNo">1015</span><a name="line.1015"></a>
<span class="sourceLineNo">1016</span> @Override<a name="line.1016"></a>
<span class="sourceLineNo">1017</span> public void addGlobalFilter(String name, String classname, Map&lt;String, String&gt; parameters) {<a name="line.1017"></a>
<span class="sourceLineNo">1018</span> final String[] ALL_URLS = { "/*" };<a name="line.1018"></a>
<span class="sourceLineNo">1019</span> defineFilter(webAppContext, name, classname, parameters, ALL_URLS);<a name="line.1019"></a>
<span class="sourceLineNo">1020</span> for (ServletContextHandler ctx : defaultContexts.keySet()) {<a name="line.1020"></a>
<span class="sourceLineNo">1021</span> defineFilter(ctx, name, classname, parameters, ALL_URLS);<a name="line.1021"></a>
<span class="sourceLineNo">1022</span> }<a name="line.1022"></a>
<span class="sourceLineNo">1023</span> LOG.info("Added global filter '" + name + "' (class=" + classname + ")");<a name="line.1023"></a>
<span class="sourceLineNo">1024</span> }<a name="line.1024"></a>
<span class="sourceLineNo">1025</span><a name="line.1025"></a>
<span class="sourceLineNo">1026</span> /**<a name="line.1026"></a>
<span class="sourceLineNo">1027</span> * Define a filter for a context and set up default url mappings.<a name="line.1027"></a>
<span class="sourceLineNo">1028</span> */<a name="line.1028"></a>
<span class="sourceLineNo">1029</span> public static void defineFilter(ServletContextHandler handler, String name, String classname,<a name="line.1029"></a>
<span class="sourceLineNo">1030</span> Map&lt;String, String&gt; parameters, String[] urls) {<a name="line.1030"></a>
<span class="sourceLineNo">1031</span> FilterHolder holder = new FilterHolder();<a name="line.1031"></a>
<span class="sourceLineNo">1032</span> holder.setName(name);<a name="line.1032"></a>
<span class="sourceLineNo">1033</span> holder.setClassName(classname);<a name="line.1033"></a>
<span class="sourceLineNo">1034</span> if (parameters != null) {<a name="line.1034"></a>
<span class="sourceLineNo">1035</span> holder.setInitParameters(parameters);<a name="line.1035"></a>
<span class="sourceLineNo">1036</span> }<a name="line.1036"></a>
<span class="sourceLineNo">1037</span> FilterMapping fmap = new FilterMapping();<a name="line.1037"></a>
<span class="sourceLineNo">1038</span> fmap.setPathSpecs(urls);<a name="line.1038"></a>
<span class="sourceLineNo">1039</span> fmap.setDispatches(FilterMapping.ALL);<a name="line.1039"></a>
<span class="sourceLineNo">1040</span> fmap.setFilterName(name);<a name="line.1040"></a>
<span class="sourceLineNo">1041</span> handler.getServletHandler().addFilter(holder, fmap);<a name="line.1041"></a>
<span class="sourceLineNo">1042</span> }<a name="line.1042"></a>
<span class="sourceLineNo">1043</span><a name="line.1043"></a>
<span class="sourceLineNo">1044</span> /**<a name="line.1044"></a>
<span class="sourceLineNo">1045</span> * Add the path spec to the filter path mapping.<a name="line.1045"></a>
<span class="sourceLineNo">1046</span> * @param pathSpec The path spec<a name="line.1046"></a>
<span class="sourceLineNo">1047</span> * @param webAppCtx The WebApplicationContext to add to<a name="line.1047"></a>
<span class="sourceLineNo">1048</span> */<a name="line.1048"></a>
<span class="sourceLineNo">1049</span> protected void addFilterPathMapping(String pathSpec, WebAppContext webAppCtx) {<a name="line.1049"></a>
<span class="sourceLineNo">1050</span> for (String name : filterNames) {<a name="line.1050"></a>
<span class="sourceLineNo">1051</span> FilterMapping fmap = new FilterMapping();<a name="line.1051"></a>
<span class="sourceLineNo">1052</span> fmap.setPathSpec(pathSpec);<a name="line.1052"></a>
<span class="sourceLineNo">1053</span> fmap.setFilterName(name);<a name="line.1053"></a>
<span class="sourceLineNo">1054</span> fmap.setDispatches(FilterMapping.ALL);<a name="line.1054"></a>
<span class="sourceLineNo">1055</span> webAppCtx.getServletHandler().addFilterMapping(fmap);<a name="line.1055"></a>
<span class="sourceLineNo">1056</span> }<a name="line.1056"></a>
<span class="sourceLineNo">1057</span> }<a name="line.1057"></a>
<span class="sourceLineNo">1058</span><a name="line.1058"></a>
<span class="sourceLineNo">1059</span> /**<a name="line.1059"></a>
<span class="sourceLineNo">1060</span> * Get the value in the webapp context.<a name="line.1060"></a>
<span class="sourceLineNo">1061</span> * @param name The name of the attribute<a name="line.1061"></a>
<span class="sourceLineNo">1062</span> * @return The value of the attribute<a name="line.1062"></a>
<span class="sourceLineNo">1063</span> */<a name="line.1063"></a>
<span class="sourceLineNo">1064</span> public Object getAttribute(String name) {<a name="line.1064"></a>
<span class="sourceLineNo">1065</span> return webAppContext.getAttribute(name);<a name="line.1065"></a>
<span class="sourceLineNo">1066</span> }<a name="line.1066"></a>
<span class="sourceLineNo">1067</span><a name="line.1067"></a>
<span class="sourceLineNo">1068</span> public WebAppContext getWebAppContext() {<a name="line.1068"></a>
<span class="sourceLineNo">1069</span> return this.webAppContext;<a name="line.1069"></a>
<span class="sourceLineNo">1070</span> }<a name="line.1070"></a>
<span class="sourceLineNo">1071</span><a name="line.1071"></a>
<span class="sourceLineNo">1072</span> public String getWebAppsPath(String appName) throws FileNotFoundException {<a name="line.1072"></a>
<span class="sourceLineNo">1073</span> return getWebAppsPath(this.appDir, appName);<a name="line.1073"></a>
<span class="sourceLineNo">1074</span> }<a name="line.1074"></a>
<span class="sourceLineNo">1075</span><a name="line.1075"></a>
<span class="sourceLineNo">1076</span> /**<a name="line.1076"></a>
<span class="sourceLineNo">1077</span> * Get the pathname to the webapps files.<a name="line.1077"></a>
<span class="sourceLineNo">1078</span> * @param appName eg "secondary" or "datanode"<a name="line.1078"></a>
<span class="sourceLineNo">1079</span> * @return the pathname as a URL<a name="line.1079"></a>
<span class="sourceLineNo">1080</span> * @throws FileNotFoundException if 'webapps' directory cannot be found on CLASSPATH.<a name="line.1080"></a>
<span class="sourceLineNo">1081</span> */<a name="line.1081"></a>
<span class="sourceLineNo">1082</span> protected String getWebAppsPath(String webapps, String appName) throws FileNotFoundException {<a name="line.1082"></a>
<span class="sourceLineNo">1083</span> URL url = getClass().getClassLoader().getResource(webapps + "/" + appName);<a name="line.1083"></a>
<span class="sourceLineNo">1084</span><a name="line.1084"></a>
<span class="sourceLineNo">1085</span> if (url == null) {<a name="line.1085"></a>
<span class="sourceLineNo">1086</span> throw new FileNotFoundException(webapps + "/" + appName + " not found in CLASSPATH");<a name="line.1086"></a>
<span class="sourceLineNo">1087</span> }<a name="line.1087"></a>
<span class="sourceLineNo">1088</span><a name="line.1088"></a>
<span class="sourceLineNo">1089</span> String urlString = url.toString();<a name="line.1089"></a>
<span class="sourceLineNo">1090</span> return urlString.substring(0, urlString.lastIndexOf('/'));<a name="line.1090"></a>
<span class="sourceLineNo">1091</span> }<a name="line.1091"></a>
<span class="sourceLineNo">1092</span><a name="line.1092"></a>
<span class="sourceLineNo">1093</span> /**<a name="line.1093"></a>
<span class="sourceLineNo">1094</span> * Get the port that the server is on<a name="line.1094"></a>
<span class="sourceLineNo">1095</span> * @return the port<a name="line.1095"></a>
<span class="sourceLineNo">1096</span> * @deprecated Since 0.99.0<a name="line.1096"></a>
<span class="sourceLineNo">1097</span> */<a name="line.1097"></a>
<span class="sourceLineNo">1098</span> @Deprecated<a name="line.1098"></a>
<span class="sourceLineNo">1099</span> public int getPort() {<a name="line.1099"></a>
<span class="sourceLineNo">1100</span> return ((ServerConnector) webServer.getConnectors()[0]).getLocalPort();<a name="line.1100"></a>
<span class="sourceLineNo">1101</span> }<a name="line.1101"></a>
<span class="sourceLineNo">1102</span><a name="line.1102"></a>
<span class="sourceLineNo">1103</span> /**<a name="line.1103"></a>
<span class="sourceLineNo">1104</span> * Get the address that corresponds to a particular connector.<a name="line.1104"></a>
<span class="sourceLineNo">1105</span> * @return the corresponding address for the connector, or null if there's no such connector or<a name="line.1105"></a>
<span class="sourceLineNo">1106</span> * the connector is not bounded.<a name="line.1106"></a>
<span class="sourceLineNo">1107</span> */<a name="line.1107"></a>
<span class="sourceLineNo">1108</span> public InetSocketAddress getConnectorAddress(int index) {<a name="line.1108"></a>
<span class="sourceLineNo">1109</span> Preconditions.checkArgument(index &gt;= 0);<a name="line.1109"></a>
<span class="sourceLineNo">1110</span><a name="line.1110"></a>
<span class="sourceLineNo">1111</span> if (index &gt; webServer.getConnectors().length) {<a name="line.1111"></a>
<span class="sourceLineNo">1112</span> return null;<a name="line.1112"></a>
<span class="sourceLineNo">1113</span> }<a name="line.1113"></a>
<span class="sourceLineNo">1114</span><a name="line.1114"></a>
<span class="sourceLineNo">1115</span> ServerConnector c = (ServerConnector) webServer.getConnectors()[index];<a name="line.1115"></a>
<span class="sourceLineNo">1116</span> if (c.getLocalPort() == -1 || c.getLocalPort() == -2) {<a name="line.1116"></a>
<span class="sourceLineNo">1117</span> // -1 if the connector has not been opened<a name="line.1117"></a>
<span class="sourceLineNo">1118</span> // -2 if it has been closed<a name="line.1118"></a>
<span class="sourceLineNo">1119</span> return null;<a name="line.1119"></a>
<span class="sourceLineNo">1120</span> }<a name="line.1120"></a>
<span class="sourceLineNo">1121</span><a name="line.1121"></a>
<span class="sourceLineNo">1122</span> return new InetSocketAddress(c.getHost(), c.getLocalPort());<a name="line.1122"></a>
<span class="sourceLineNo">1123</span> }<a name="line.1123"></a>
<span class="sourceLineNo">1124</span><a name="line.1124"></a>
<span class="sourceLineNo">1125</span> /**<a name="line.1125"></a>
<span class="sourceLineNo">1126</span> * Set the min, max number of worker threads (simultaneous connections).<a name="line.1126"></a>
<span class="sourceLineNo">1127</span> */<a name="line.1127"></a>
<span class="sourceLineNo">1128</span> public void setThreads(int min, int max) {<a name="line.1128"></a>
<span class="sourceLineNo">1129</span> QueuedThreadPool pool = (QueuedThreadPool) webServer.getThreadPool();<a name="line.1129"></a>
<span class="sourceLineNo">1130</span> pool.setMinThreads(min);<a name="line.1130"></a>
<span class="sourceLineNo">1131</span> pool.setMaxThreads(max);<a name="line.1131"></a>
<span class="sourceLineNo">1132</span> }<a name="line.1132"></a>
<span class="sourceLineNo">1133</span><a name="line.1133"></a>
<span class="sourceLineNo">1134</span> private void initSpnego(Configuration conf, String hostName, String usernameConfKey,<a name="line.1134"></a>
<span class="sourceLineNo">1135</span> String keytabConfKey, String kerberosNameRuleKey, String signatureSecretKeyFileKey)<a name="line.1135"></a>
<span class="sourceLineNo">1136</span> throws IOException {<a name="line.1136"></a>
<span class="sourceLineNo">1137</span> Map&lt;String, String&gt; params = new HashMap&lt;&gt;();<a name="line.1137"></a>
<span class="sourceLineNo">1138</span> String principalInConf = getOrEmptyString(conf, usernameConfKey);<a name="line.1138"></a>
<span class="sourceLineNo">1139</span> if (!principalInConf.isEmpty()) {<a name="line.1139"></a>
<span class="sourceLineNo">1140</span> params.put(HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_SUFFIX,<a name="line.1140"></a>
<span class="sourceLineNo">1141</span> SecurityUtil.getServerPrincipal(principalInConf, hostName));<a name="line.1141"></a>
<span class="sourceLineNo">1142</span> }<a name="line.1142"></a>
<span class="sourceLineNo">1143</span> String httpKeytab = getOrEmptyString(conf, keytabConfKey);<a name="line.1143"></a>
<span class="sourceLineNo">1144</span> if (!httpKeytab.isEmpty()) {<a name="line.1144"></a>
<span class="sourceLineNo">1145</span> params.put(HTTP_SPNEGO_AUTHENTICATION_KEYTAB_SUFFIX, httpKeytab);<a name="line.1145"></a>
<span class="sourceLineNo">1146</span> }<a name="line.1146"></a>
<span class="sourceLineNo">1147</span> String kerberosNameRule = getOrEmptyString(conf, kerberosNameRuleKey);<a name="line.1147"></a>
<span class="sourceLineNo">1148</span> if (!kerberosNameRule.isEmpty()) {<a name="line.1148"></a>
<span class="sourceLineNo">1149</span> params.put(HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_SUFFIX, kerberosNameRule);<a name="line.1149"></a>
<span class="sourceLineNo">1150</span> }<a name="line.1150"></a>
<span class="sourceLineNo">1151</span> String signatureSecretKeyFile = getOrEmptyString(conf, signatureSecretKeyFileKey);<a name="line.1151"></a>
<span class="sourceLineNo">1152</span> if (!signatureSecretKeyFile.isEmpty()) {<a name="line.1152"></a>
<span class="sourceLineNo">1153</span> params.put(HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_SUFFIX, signatureSecretKeyFile);<a name="line.1153"></a>
<span class="sourceLineNo">1154</span> }<a name="line.1154"></a>
<span class="sourceLineNo">1155</span> params.put(AuthenticationFilter.AUTH_TYPE, "kerberos");<a name="line.1155"></a>
<span class="sourceLineNo">1156</span><a name="line.1156"></a>
<span class="sourceLineNo">1157</span> // Verify that the required options were provided<a name="line.1157"></a>
<span class="sourceLineNo">1158</span> if (<a name="line.1158"></a>
<span class="sourceLineNo">1159</span> isMissing(params.get(HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_SUFFIX))<a name="line.1159"></a>
<span class="sourceLineNo">1160</span> || isMissing(params.get(HTTP_SPNEGO_AUTHENTICATION_KEYTAB_SUFFIX))<a name="line.1160"></a>
<span class="sourceLineNo">1161</span> ) {<a name="line.1161"></a>
<span class="sourceLineNo">1162</span> throw new IllegalArgumentException(<a name="line.1162"></a>
<span class="sourceLineNo">1163</span> usernameConfKey + " and " + keytabConfKey + " are both required in the configuration "<a name="line.1163"></a>
<span class="sourceLineNo">1164</span> + "to enable SPNEGO/Kerberos authentication for the Web UI");<a name="line.1164"></a>
<span class="sourceLineNo">1165</span> }<a name="line.1165"></a>
<span class="sourceLineNo">1166</span><a name="line.1166"></a>
<span class="sourceLineNo">1167</span> if (<a name="line.1167"></a>
<span class="sourceLineNo">1168</span> conf.getBoolean(HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_KEY,<a name="line.1168"></a>
<span class="sourceLineNo">1169</span> HTTP_SPNEGO_AUTHENTICATION_PROXYUSER_ENABLE_DEFAULT)<a name="line.1169"></a>
<span class="sourceLineNo">1170</span> ) {<a name="line.1170"></a>
<span class="sourceLineNo">1171</span> // Copy/rename standard hadoop proxyuser settings to filter<a name="line.1171"></a>
<span class="sourceLineNo">1172</span> for (Map.Entry&lt;String, String&gt; proxyEntry : conf<a name="line.1172"></a>
<span class="sourceLineNo">1173</span> .getPropsWithPrefix(ProxyUsers.CONF_HADOOP_PROXYUSER).entrySet()) {<a name="line.1173"></a>
<span class="sourceLineNo">1174</span> params.put(ProxyUserAuthenticationFilter.PROXYUSER_PREFIX + proxyEntry.getKey(),<a name="line.1174"></a>
<span class="sourceLineNo">1175</span> proxyEntry.getValue());<a name="line.1175"></a>
<span class="sourceLineNo">1176</span> }<a name="line.1176"></a>
<span class="sourceLineNo">1177</span> addGlobalFilter(SPNEGO_PROXYUSER_FILTER, ProxyUserAuthenticationFilter.class.getName(),<a name="line.1177"></a>
<span class="sourceLineNo">1178</span> params);<a name="line.1178"></a>
<span class="sourceLineNo">1179</span> } else {<a name="line.1179"></a>
<span class="sourceLineNo">1180</span> addGlobalFilter(SPNEGO_FILTER, AuthenticationFilter.class.getName(), params);<a name="line.1180"></a>
<span class="sourceLineNo">1181</span> }<a name="line.1181"></a>
<span class="sourceLineNo">1182</span> }<a name="line.1182"></a>
<span class="sourceLineNo">1183</span><a name="line.1183"></a>
<span class="sourceLineNo">1184</span> /**<a name="line.1184"></a>
<span class="sourceLineNo">1185</span> * Returns true if the argument is non-null and not whitespace<a name="line.1185"></a>
<span class="sourceLineNo">1186</span> */<a name="line.1186"></a>
<span class="sourceLineNo">1187</span> private boolean isMissing(String value) {<a name="line.1187"></a>
<span class="sourceLineNo">1188</span> if (null == value) {<a name="line.1188"></a>
<span class="sourceLineNo">1189</span> return true;<a name="line.1189"></a>
<span class="sourceLineNo">1190</span> }<a name="line.1190"></a>
<span class="sourceLineNo">1191</span> return value.trim().isEmpty();<a name="line.1191"></a>
<span class="sourceLineNo">1192</span> }<a name="line.1192"></a>
<span class="sourceLineNo">1193</span><a name="line.1193"></a>
<span class="sourceLineNo">1194</span> /**<a name="line.1194"></a>
<span class="sourceLineNo">1195</span> * Extracts the value for the given key from the configuration of returns a string of zero length.<a name="line.1195"></a>
<span class="sourceLineNo">1196</span> */<a name="line.1196"></a>
<span class="sourceLineNo">1197</span> private String getOrEmptyString(Configuration conf, String key) {<a name="line.1197"></a>
<span class="sourceLineNo">1198</span> if (null == key) {<a name="line.1198"></a>
<span class="sourceLineNo">1199</span> return EMPTY_STRING;<a name="line.1199"></a>
<span class="sourceLineNo">1200</span> }<a name="line.1200"></a>
<span class="sourceLineNo">1201</span> final String value = conf.get(key.trim());<a name="line.1201"></a>
<span class="sourceLineNo">1202</span> return null == value ? EMPTY_STRING : value;<a name="line.1202"></a>
<span class="sourceLineNo">1203</span> }<a name="line.1203"></a>
<span class="sourceLineNo">1204</span><a name="line.1204"></a>
<span class="sourceLineNo">1205</span> /**<a name="line.1205"></a>
<span class="sourceLineNo">1206</span> * Start the server. Does not wait for the server to start.<a name="line.1206"></a>
<span class="sourceLineNo">1207</span> */<a name="line.1207"></a>
<span class="sourceLineNo">1208</span> public void start() throws IOException {<a name="line.1208"></a>
<span class="sourceLineNo">1209</span> try {<a name="line.1209"></a>
<span class="sourceLineNo">1210</span> try {<a name="line.1210"></a>
<span class="sourceLineNo">1211</span> openListeners();<a name="line.1211"></a>
<span class="sourceLineNo">1212</span> webServer.start();<a name="line.1212"></a>
<span class="sourceLineNo">1213</span> } catch (IOException ex) {<a name="line.1213"></a>
<span class="sourceLineNo">1214</span> LOG.info("HttpServer.start() threw a non Bind IOException", ex);<a name="line.1214"></a>
<span class="sourceLineNo">1215</span> throw ex;<a name="line.1215"></a>
<span class="sourceLineNo">1216</span> } catch (MultiException ex) {<a name="line.1216"></a>
<span class="sourceLineNo">1217</span> LOG.info("HttpServer.start() threw a MultiException", ex);<a name="line.1217"></a>
<span class="sourceLineNo">1218</span> throw ex;<a name="line.1218"></a>
<span class="sourceLineNo">1219</span> }<a name="line.1219"></a>
<span class="sourceLineNo">1220</span> // Make sure there is no handler failures.<a name="line.1220"></a>
<span class="sourceLineNo">1221</span> Handler[] handlers = webServer.getHandlers();<a name="line.1221"></a>
<span class="sourceLineNo">1222</span> for (int i = 0; i &lt; handlers.length; i++) {<a name="line.1222"></a>
<span class="sourceLineNo">1223</span> if (handlers[i].isFailed()) {<a name="line.1223"></a>
<span class="sourceLineNo">1224</span> throw new IOException("Problem in starting http server. Server handlers failed");<a name="line.1224"></a>
<span class="sourceLineNo">1225</span> }<a name="line.1225"></a>
<span class="sourceLineNo">1226</span> }<a name="line.1226"></a>
<span class="sourceLineNo">1227</span> // Make sure there are no errors initializing the context.<a name="line.1227"></a>
<span class="sourceLineNo">1228</span> Throwable unavailableException = webAppContext.getUnavailableException();<a name="line.1228"></a>
<span class="sourceLineNo">1229</span> if (unavailableException != null) {<a name="line.1229"></a>
<span class="sourceLineNo">1230</span> // Have to stop the webserver, or else its non-daemon threads<a name="line.1230"></a>
<span class="sourceLineNo">1231</span> // will hang forever.<a name="line.1231"></a>
<span class="sourceLineNo">1232</span> webServer.stop();<a name="line.1232"></a>
<span class="sourceLineNo">1233</span> throw new IOException("Unable to initialize WebAppContext", unavailableException);<a name="line.1233"></a>
<span class="sourceLineNo">1234</span> }<a name="line.1234"></a>
<span class="sourceLineNo">1235</span> } catch (IOException e) {<a name="line.1235"></a>
<span class="sourceLineNo">1236</span> throw e;<a name="line.1236"></a>
<span class="sourceLineNo">1237</span> } catch (InterruptedException e) {<a name="line.1237"></a>
<span class="sourceLineNo">1238</span> throw (IOException) new InterruptedIOException("Interrupted while starting HTTP server")<a name="line.1238"></a>
<span class="sourceLineNo">1239</span> .initCause(e);<a name="line.1239"></a>
<span class="sourceLineNo">1240</span> } catch (Exception e) {<a name="line.1240"></a>
<span class="sourceLineNo">1241</span> throw new IOException("Problem starting http server", e);<a name="line.1241"></a>
<span class="sourceLineNo">1242</span> }<a name="line.1242"></a>
<span class="sourceLineNo">1243</span> }<a name="line.1243"></a>
<span class="sourceLineNo">1244</span><a name="line.1244"></a>
<span class="sourceLineNo">1245</span> private void loadListeners() {<a name="line.1245"></a>
<span class="sourceLineNo">1246</span> for (ListenerInfo li : listeners) {<a name="line.1246"></a>
<span class="sourceLineNo">1247</span> webServer.addConnector(li.listener);<a name="line.1247"></a>
<span class="sourceLineNo">1248</span> }<a name="line.1248"></a>
<span class="sourceLineNo">1249</span> }<a name="line.1249"></a>
<span class="sourceLineNo">1250</span><a name="line.1250"></a>
<span class="sourceLineNo">1251</span> /**<a name="line.1251"></a>
<span class="sourceLineNo">1252</span> * Open the main listener for the server<a name="line.1252"></a>
<span class="sourceLineNo">1253</span> * @throws Exception if the listener cannot be opened or the appropriate port is already in use<a name="line.1253"></a>
<span class="sourceLineNo">1254</span> */<a name="line.1254"></a>
<span class="sourceLineNo">1255</span> void openListeners() throws Exception {<a name="line.1255"></a>
<span class="sourceLineNo">1256</span> for (ListenerInfo li : listeners) {<a name="line.1256"></a>
<span class="sourceLineNo">1257</span> ServerConnector listener = li.listener;<a name="line.1257"></a>
<span class="sourceLineNo">1258</span> if (!li.isManaged || (li.listener.getLocalPort() != -1 &amp;&amp; li.listener.getLocalPort() != -2)) {<a name="line.1258"></a>
<span class="sourceLineNo">1259</span> // This listener is either started externally, or has not been opened, or has been closed<a name="line.1259"></a>
<span class="sourceLineNo">1260</span> continue;<a name="line.1260"></a>
<span class="sourceLineNo">1261</span> }<a name="line.1261"></a>
<span class="sourceLineNo">1262</span> int port = listener.getPort();<a name="line.1262"></a>
<span class="sourceLineNo">1263</span> while (true) {<a name="line.1263"></a>
<span class="sourceLineNo">1264</span> // jetty has a bug where you can't reopen a listener that previously<a name="line.1264"></a>
<span class="sourceLineNo">1265</span> // failed to open w/o issuing a close first, even if the port is changed<a name="line.1265"></a>
<span class="sourceLineNo">1266</span> try {<a name="line.1266"></a>
<span class="sourceLineNo">1267</span> listener.close();<a name="line.1267"></a>
<span class="sourceLineNo">1268</span> listener.open();<a name="line.1268"></a>
<span class="sourceLineNo">1269</span> LOG.info("Jetty bound to port " + listener.getLocalPort());<a name="line.1269"></a>
<span class="sourceLineNo">1270</span> break;<a name="line.1270"></a>
<span class="sourceLineNo">1271</span> } catch (IOException ex) {<a name="line.1271"></a>
<span class="sourceLineNo">1272</span> if (!(ex instanceof BindException) &amp;&amp; !(ex.getCause() instanceof BindException)) {<a name="line.1272"></a>
<span class="sourceLineNo">1273</span> throw ex;<a name="line.1273"></a>
<span class="sourceLineNo">1274</span> }<a name="line.1274"></a>
<span class="sourceLineNo">1275</span> if (port == 0 || !findPort) {<a name="line.1275"></a>
<span class="sourceLineNo">1276</span> BindException be =<a name="line.1276"></a>
<span class="sourceLineNo">1277</span> new BindException("Port in use: " + listener.getHost() + ":" + listener.getPort());<a name="line.1277"></a>
<span class="sourceLineNo">1278</span> be.initCause(ex);<a name="line.1278"></a>
<span class="sourceLineNo">1279</span> throw be;<a name="line.1279"></a>
<span class="sourceLineNo">1280</span> }<a name="line.1280"></a>
<span class="sourceLineNo">1281</span> }<a name="line.1281"></a>
<span class="sourceLineNo">1282</span> // try the next port number<a name="line.1282"></a>
<span class="sourceLineNo">1283</span> listener.setPort(++port);<a name="line.1283"></a>
<span class="sourceLineNo">1284</span> Thread.sleep(100);<a name="line.1284"></a>
<span class="sourceLineNo">1285</span> }<a name="line.1285"></a>
<span class="sourceLineNo">1286</span> }<a name="line.1286"></a>
<span class="sourceLineNo">1287</span> }<a name="line.1287"></a>
<span class="sourceLineNo">1288</span><a name="line.1288"></a>
<span class="sourceLineNo">1289</span> /**<a name="line.1289"></a>
<span class="sourceLineNo">1290</span> * stop the server<a name="line.1290"></a>
<span class="sourceLineNo">1291</span> */<a name="line.1291"></a>
<span class="sourceLineNo">1292</span> public void stop() throws Exception {<a name="line.1292"></a>
<span class="sourceLineNo">1293</span> MultiException exception = null;<a name="line.1293"></a>
<span class="sourceLineNo">1294</span> for (ListenerInfo li : listeners) {<a name="line.1294"></a>
<span class="sourceLineNo">1295</span> if (!li.isManaged) {<a name="line.1295"></a>
<span class="sourceLineNo">1296</span> continue;<a name="line.1296"></a>
<span class="sourceLineNo">1297</span> }<a name="line.1297"></a>
<span class="sourceLineNo">1298</span><a name="line.1298"></a>
<span class="sourceLineNo">1299</span> try {<a name="line.1299"></a>
<span class="sourceLineNo">1300</span> li.listener.close();<a name="line.1300"></a>
<span class="sourceLineNo">1301</span> } catch (Exception e) {<a name="line.1301"></a>
<span class="sourceLineNo">1302</span> LOG.error("Error while stopping listener for webapp" + webAppContext.getDisplayName(), e);<a name="line.1302"></a>
<span class="sourceLineNo">1303</span> exception = addMultiException(exception, e);<a name="line.1303"></a>
<span class="sourceLineNo">1304</span> }<a name="line.1304"></a>
<span class="sourceLineNo">1305</span> }<a name="line.1305"></a>
<span class="sourceLineNo">1306</span><a name="line.1306"></a>
<span class="sourceLineNo">1307</span> try {<a name="line.1307"></a>
<span class="sourceLineNo">1308</span> // clear &amp; stop webAppContext attributes to avoid memory leaks.<a name="line.1308"></a>
<span class="sourceLineNo">1309</span> webAppContext.clearAttributes();<a name="line.1309"></a>
<span class="sourceLineNo">1310</span> webAppContext.stop();<a name="line.1310"></a>
<span class="sourceLineNo">1311</span> } catch (Exception e) {<a name="line.1311"></a>
<span class="sourceLineNo">1312</span> LOG.error("Error while stopping web app context for webapp " + webAppContext.getDisplayName(),<a name="line.1312"></a>
<span class="sourceLineNo">1313</span> e);<a name="line.1313"></a>
<span class="sourceLineNo">1314</span> exception = addMultiException(exception, e);<a name="line.1314"></a>
<span class="sourceLineNo">1315</span> }<a name="line.1315"></a>
<span class="sourceLineNo">1316</span><a name="line.1316"></a>
<span class="sourceLineNo">1317</span> try {<a name="line.1317"></a>
<span class="sourceLineNo">1318</span> webServer.stop();<a name="line.1318"></a>
<span class="sourceLineNo">1319</span> } catch (Exception e) {<a name="line.1319"></a>
<span class="sourceLineNo">1320</span> LOG.error("Error while stopping web server for webapp " + webAppContext.getDisplayName(), e);<a name="line.1320"></a>
<span class="sourceLineNo">1321</span> exception = addMultiException(exception, e);<a name="line.1321"></a>
<span class="sourceLineNo">1322</span> }<a name="line.1322"></a>
<span class="sourceLineNo">1323</span><a name="line.1323"></a>
<span class="sourceLineNo">1324</span> if (exception != null) {<a name="line.1324"></a>
<span class="sourceLineNo">1325</span> exception.ifExceptionThrow();<a name="line.1325"></a>
<span class="sourceLineNo">1326</span> }<a name="line.1326"></a>
<span class="sourceLineNo">1327</span><a name="line.1327"></a>
<span class="sourceLineNo">1328</span> }<a name="line.1328"></a>
<span class="sourceLineNo">1329</span><a name="line.1329"></a>
<span class="sourceLineNo">1330</span> private MultiException addMultiException(MultiException exception, Exception e) {<a name="line.1330"></a>
<span class="sourceLineNo">1331</span> if (exception == null) {<a name="line.1331"></a>
<span class="sourceLineNo">1332</span> exception = new MultiException();<a name="line.1332"></a>
<span class="sourceLineNo">1333</span> }<a name="line.1333"></a>
<span class="sourceLineNo">1334</span> exception.add(e);<a name="line.1334"></a>
<span class="sourceLineNo">1335</span> return exception;<a name="line.1335"></a>
<span class="sourceLineNo">1336</span> }<a name="line.1336"></a>
<span class="sourceLineNo">1337</span><a name="line.1337"></a>
<span class="sourceLineNo">1338</span> public void join() throws InterruptedException {<a name="line.1338"></a>
<span class="sourceLineNo">1339</span> webServer.join();<a name="line.1339"></a>
<span class="sourceLineNo">1340</span> }<a name="line.1340"></a>
<span class="sourceLineNo">1341</span><a name="line.1341"></a>
<span class="sourceLineNo">1342</span> /**<a name="line.1342"></a>
<span class="sourceLineNo">1343</span> * Test for the availability of the web server<a name="line.1343"></a>
<span class="sourceLineNo">1344</span> * @return true if the web server is started, false otherwise<a name="line.1344"></a>
<span class="sourceLineNo">1345</span> */<a name="line.1345"></a>
<span class="sourceLineNo">1346</span> public boolean isAlive() {<a name="line.1346"></a>
<span class="sourceLineNo">1347</span> return webServer != null &amp;&amp; webServer.isStarted();<a name="line.1347"></a>
<span class="sourceLineNo">1348</span> }<a name="line.1348"></a>
<span class="sourceLineNo">1349</span><a name="line.1349"></a>
<span class="sourceLineNo">1350</span> /**<a name="line.1350"></a>
<span class="sourceLineNo">1351</span> * Return the host and port of the HttpServer, if live<a name="line.1351"></a>
<span class="sourceLineNo">1352</span> * @return the classname and any HTTP URL<a name="line.1352"></a>
<span class="sourceLineNo">1353</span> */<a name="line.1353"></a>
<span class="sourceLineNo">1354</span> @Override<a name="line.1354"></a>
<span class="sourceLineNo">1355</span> public String toString() {<a name="line.1355"></a>
<span class="sourceLineNo">1356</span> if (listeners.isEmpty()) {<a name="line.1356"></a>
<span class="sourceLineNo">1357</span> return "Inactive HttpServer";<a name="line.1357"></a>
<span class="sourceLineNo">1358</span> } else {<a name="line.1358"></a>
<span class="sourceLineNo">1359</span> StringBuilder sb = new StringBuilder("HttpServer (")<a name="line.1359"></a>
<span class="sourceLineNo">1360</span> .append(isAlive() ? STATE_DESCRIPTION_ALIVE : STATE_DESCRIPTION_NOT_LIVE)<a name="line.1360"></a>
<span class="sourceLineNo">1361</span> .append("), listening at:");<a name="line.1361"></a>
<span class="sourceLineNo">1362</span> for (ListenerInfo li : listeners) {<a name="line.1362"></a>
<span class="sourceLineNo">1363</span> ServerConnector l = li.listener;<a name="line.1363"></a>
<span class="sourceLineNo">1364</span> sb.append(l.getHost()).append(":").append(l.getPort()).append("/,");<a name="line.1364"></a>
<span class="sourceLineNo">1365</span> }<a name="line.1365"></a>
<span class="sourceLineNo">1366</span> return sb.toString();<a name="line.1366"></a>
<span class="sourceLineNo">1367</span> }<a name="line.1367"></a>
<span class="sourceLineNo">1368</span> }<a name="line.1368"></a>
<span class="sourceLineNo">1369</span><a name="line.1369"></a>
<span class="sourceLineNo">1370</span> /**<a name="line.1370"></a>
<span class="sourceLineNo">1371</span> * Checks the user has privileges to access to instrumentation servlets.<a name="line.1371"></a>
<span class="sourceLineNo">1372</span> * &lt;p&gt;<a name="line.1372"></a>
<span class="sourceLineNo">1373</span> * If &lt;code&gt;hadoop.security.instrumentation.requires.admin&lt;/code&gt; is set to FALSE (default value)<a name="line.1373"></a>
<span class="sourceLineNo">1374</span> * it always returns TRUE.<a name="line.1374"></a>
<span class="sourceLineNo">1375</span> * &lt;/p&gt;<a name="line.1375"></a>
<span class="sourceLineNo">1376</span> * &lt;p&gt;<a name="line.1376"></a>
<span class="sourceLineNo">1377</span> * If &lt;code&gt;hadoop.security.instrumentation.requires.admin&lt;/code&gt; is set to TRUE it will check<a name="line.1377"></a>
<span class="sourceLineNo">1378</span> * that if the current user is in the admin ACLS. If the user is in the admin ACLs it returns<a name="line.1378"></a>
<span class="sourceLineNo">1379</span> * TRUE, otherwise it returns FALSE.<a name="line.1379"></a>
<span class="sourceLineNo">1380</span> * &lt;/p&gt;<a name="line.1380"></a>
<span class="sourceLineNo">1381</span> * @param servletContext the servlet context.<a name="line.1381"></a>
<span class="sourceLineNo">1382</span> * @param request the servlet request.<a name="line.1382"></a>
<span class="sourceLineNo">1383</span> * @param response the servlet response.<a name="line.1383"></a>
<span class="sourceLineNo">1384</span> * @return TRUE/FALSE based on the logic decribed above.<a name="line.1384"></a>
<span class="sourceLineNo">1385</span> */<a name="line.1385"></a>
<span class="sourceLineNo">1386</span> public static boolean isInstrumentationAccessAllowed(ServletContext servletContext,<a name="line.1386"></a>
<span class="sourceLineNo">1387</span> HttpServletRequest request, HttpServletResponse response) throws IOException {<a name="line.1387"></a>
<span class="sourceLineNo">1388</span> Configuration conf = (Configuration) servletContext.getAttribute(CONF_CONTEXT_ATTRIBUTE);<a name="line.1388"></a>
<span class="sourceLineNo">1389</span><a name="line.1389"></a>
<span class="sourceLineNo">1390</span> boolean access = true;<a name="line.1390"></a>
<span class="sourceLineNo">1391</span> boolean adminAccess = conf<a name="line.1391"></a>
<span class="sourceLineNo">1392</span> .getBoolean(CommonConfigurationKeys.HADOOP_SECURITY_INSTRUMENTATION_REQUIRES_ADMIN, false);<a name="line.1392"></a>
<span class="sourceLineNo">1393</span> if (adminAccess) {<a name="line.1393"></a>
<span class="sourceLineNo">1394</span> access = hasAdministratorAccess(servletContext, request, response);<a name="line.1394"></a>
<span class="sourceLineNo">1395</span> }<a name="line.1395"></a>
<span class="sourceLineNo">1396</span> return access;<a name="line.1396"></a>
<span class="sourceLineNo">1397</span> }<a name="line.1397"></a>
<span class="sourceLineNo">1398</span><a name="line.1398"></a>
<span class="sourceLineNo">1399</span> /**<a name="line.1399"></a>
<span class="sourceLineNo">1400</span> * Does the user sending the HttpServletRequest has the administrator ACLs? If it isn't the case,<a name="line.1400"></a>
<span class="sourceLineNo">1401</span> * response will be modified to send an error to the user.<a name="line.1401"></a>
<span class="sourceLineNo">1402</span> * @param servletContext the {@link ServletContext} to use<a name="line.1402"></a>
<span class="sourceLineNo">1403</span> * @param request the {@link HttpServletRequest} to check<a name="line.1403"></a>
<span class="sourceLineNo">1404</span> * @param response used to send the error response if user does not have admin access.<a name="line.1404"></a>
<span class="sourceLineNo">1405</span> * @return true if admin-authorized, false otherwise<a name="line.1405"></a>
<span class="sourceLineNo">1406</span> * @throws IOException if an unauthenticated or unauthorized user tries to access the page<a name="line.1406"></a>
<span class="sourceLineNo">1407</span> */<a name="line.1407"></a>
<span class="sourceLineNo">1408</span> public static boolean hasAdministratorAccess(ServletContext servletContext,<a name="line.1408"></a>
<span class="sourceLineNo">1409</span> HttpServletRequest request, HttpServletResponse response) throws IOException {<a name="line.1409"></a>
<span class="sourceLineNo">1410</span> Configuration conf = (Configuration) servletContext.getAttribute(CONF_CONTEXT_ATTRIBUTE);<a name="line.1410"></a>
<span class="sourceLineNo">1411</span> AccessControlList acl = (AccessControlList) servletContext.getAttribute(ADMINS_ACL);<a name="line.1411"></a>
<span class="sourceLineNo">1412</span><a name="line.1412"></a>
<span class="sourceLineNo">1413</span> return hasAdministratorAccess(conf, acl, request, response);<a name="line.1413"></a>
<span class="sourceLineNo">1414</span> }<a name="line.1414"></a>
<span class="sourceLineNo">1415</span><a name="line.1415"></a>
<span class="sourceLineNo">1416</span> public static boolean hasAdministratorAccess(Configuration conf, AccessControlList acl,<a name="line.1416"></a>
<span class="sourceLineNo">1417</span> HttpServletRequest request, HttpServletResponse response) throws IOException {<a name="line.1417"></a>
<span class="sourceLineNo">1418</span> // If there is no authorization, anybody has administrator access.<a name="line.1418"></a>
<span class="sourceLineNo">1419</span> if (!conf.getBoolean(CommonConfigurationKeys.HADOOP_SECURITY_AUTHORIZATION, false)) {<a name="line.1419"></a>
<span class="sourceLineNo">1420</span> return true;<a name="line.1420"></a>
<span class="sourceLineNo">1421</span> }<a name="line.1421"></a>
<span class="sourceLineNo">1422</span><a name="line.1422"></a>
<span class="sourceLineNo">1423</span> String remoteUser = request.getRemoteUser();<a name="line.1423"></a>
<span class="sourceLineNo">1424</span> if (remoteUser == null) {<a name="line.1424"></a>
<span class="sourceLineNo">1425</span> response.sendError(HttpServletResponse.SC_UNAUTHORIZED,<a name="line.1425"></a>
<span class="sourceLineNo">1426</span> "Unauthenticated users are not " + "authorized to access this page.");<a name="line.1426"></a>
<span class="sourceLineNo">1427</span> return false;<a name="line.1427"></a>
<span class="sourceLineNo">1428</span> }<a name="line.1428"></a>
<span class="sourceLineNo">1429</span><a name="line.1429"></a>
<span class="sourceLineNo">1430</span> if (acl != null &amp;&amp; !userHasAdministratorAccess(acl, remoteUser)) {<a name="line.1430"></a>
<span class="sourceLineNo">1431</span> response.sendError(HttpServletResponse.SC_FORBIDDEN,<a name="line.1431"></a>
<span class="sourceLineNo">1432</span> "User " + remoteUser + " is unauthorized to access this page.");<a name="line.1432"></a>
<span class="sourceLineNo">1433</span> return false;<a name="line.1433"></a>
<span class="sourceLineNo">1434</span> }<a name="line.1434"></a>
<span class="sourceLineNo">1435</span><a name="line.1435"></a>
<span class="sourceLineNo">1436</span> return true;<a name="line.1436"></a>
<span class="sourceLineNo">1437</span> }<a name="line.1437"></a>
<span class="sourceLineNo">1438</span><a name="line.1438"></a>
<span class="sourceLineNo">1439</span> /**<a name="line.1439"></a>
<span class="sourceLineNo">1440</span> * Get the admin ACLs from the given ServletContext and check if the given user is in the ACL.<a name="line.1440"></a>
<span class="sourceLineNo">1441</span> * @param servletContext the context containing the admin ACL.<a name="line.1441"></a>
<span class="sourceLineNo">1442</span> * @param remoteUser the remote user to check for.<a name="line.1442"></a>
<span class="sourceLineNo">1443</span> * @return true if the user is present in the ACL, false if no ACL is set or the user is not<a name="line.1443"></a>
<span class="sourceLineNo">1444</span> * present<a name="line.1444"></a>
<span class="sourceLineNo">1445</span> */<a name="line.1445"></a>
<span class="sourceLineNo">1446</span> public static boolean userHasAdministratorAccess(ServletContext servletContext,<a name="line.1446"></a>
<span class="sourceLineNo">1447</span> String remoteUser) {<a name="line.1447"></a>
<span class="sourceLineNo">1448</span> AccessControlList adminsAcl = (AccessControlList) servletContext.getAttribute(ADMINS_ACL);<a name="line.1448"></a>
<span class="sourceLineNo">1449</span> return userHasAdministratorAccess(adminsAcl, remoteUser);<a name="line.1449"></a>
<span class="sourceLineNo">1450</span> }<a name="line.1450"></a>
<span class="sourceLineNo">1451</span><a name="line.1451"></a>
<span class="sourceLineNo">1452</span> public static boolean userHasAdministratorAccess(AccessControlList acl, String remoteUser) {<a name="line.1452"></a>
<span class="sourceLineNo">1453</span> UserGroupInformation remoteUserUGI = UserGroupInformation.createRemoteUser(remoteUser);<a name="line.1453"></a>
<span class="sourceLineNo">1454</span> return acl != null &amp;&amp; acl.isUserAllowed(remoteUserUGI);<a name="line.1454"></a>
<span class="sourceLineNo">1455</span> }<a name="line.1455"></a>
<span class="sourceLineNo">1456</span><a name="line.1456"></a>
<span class="sourceLineNo">1457</span> /**<a name="line.1457"></a>
<span class="sourceLineNo">1458</span> * A very simple servlet to serve up a text representation of the current stack traces. It both<a name="line.1458"></a>
<span class="sourceLineNo">1459</span> * returns the stacks to the caller and logs them. Currently the stack traces are done<a name="line.1459"></a>
<span class="sourceLineNo">1460</span> * sequentially rather than exactly the same data.<a name="line.1460"></a>
<span class="sourceLineNo">1461</span> */<a name="line.1461"></a>
<span class="sourceLineNo">1462</span> public static class StackServlet extends HttpServlet {<a name="line.1462"></a>
<span class="sourceLineNo">1463</span> private static final long serialVersionUID = -6284183679759467039L;<a name="line.1463"></a>
<span class="sourceLineNo">1464</span><a name="line.1464"></a>
<span class="sourceLineNo">1465</span> @Override<a name="line.1465"></a>
<span class="sourceLineNo">1466</span> public void doGet(HttpServletRequest request, HttpServletResponse response)<a name="line.1466"></a>
<span class="sourceLineNo">1467</span> throws ServletException, IOException {<a name="line.1467"></a>
<span class="sourceLineNo">1468</span> if (!HttpServer.isInstrumentationAccessAllowed(getServletContext(), request, response)) {<a name="line.1468"></a>
<span class="sourceLineNo">1469</span> return;<a name="line.1469"></a>
<span class="sourceLineNo">1470</span> }<a name="line.1470"></a>
<span class="sourceLineNo">1471</span> response.setContentType("text/plain; charset=UTF-8");<a name="line.1471"></a>
<span class="sourceLineNo">1472</span> try (PrintStream out = new PrintStream(response.getOutputStream(), false, "UTF-8")) {<a name="line.1472"></a>
<span class="sourceLineNo">1473</span> Threads.printThreadInfo(out, "");<a name="line.1473"></a>
<span class="sourceLineNo">1474</span> out.flush();<a name="line.1474"></a>
<span class="sourceLineNo">1475</span> }<a name="line.1475"></a>
<span class="sourceLineNo">1476</span> ReflectionUtils.logThreadInfo(LOG, "jsp requested", 1);<a name="line.1476"></a>
<span class="sourceLineNo">1477</span> }<a name="line.1477"></a>
<span class="sourceLineNo">1478</span> }<a name="line.1478"></a>
<span class="sourceLineNo">1479</span><a name="line.1479"></a>
<span class="sourceLineNo">1480</span> /**<a name="line.1480"></a>
<span class="sourceLineNo">1481</span> * A Servlet input filter that quotes all HTML active characters in the parameter names and<a name="line.1481"></a>
<span class="sourceLineNo">1482</span> * values. The goal is to quote the characters to make all of the servlets resistant to cross-site<a name="line.1482"></a>
<span class="sourceLineNo">1483</span> * scripting attacks.<a name="line.1483"></a>
<span class="sourceLineNo">1484</span> */<a name="line.1484"></a>
<span class="sourceLineNo">1485</span> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.1485"></a>
<span class="sourceLineNo">1486</span> public static class QuotingInputFilter implements Filter {<a name="line.1486"></a>
<span class="sourceLineNo">1487</span> private FilterConfig config;<a name="line.1487"></a>
<span class="sourceLineNo">1488</span><a name="line.1488"></a>
<span class="sourceLineNo">1489</span> public static class RequestQuoter extends HttpServletRequestWrapper {<a name="line.1489"></a>
<span class="sourceLineNo">1490</span> private final HttpServletRequest rawRequest;<a name="line.1490"></a>
<span class="sourceLineNo">1491</span><a name="line.1491"></a>
<span class="sourceLineNo">1492</span> public RequestQuoter(HttpServletRequest rawRequest) {<a name="line.1492"></a>
<span class="sourceLineNo">1493</span> super(rawRequest);<a name="line.1493"></a>
<span class="sourceLineNo">1494</span> this.rawRequest = rawRequest;<a name="line.1494"></a>
<span class="sourceLineNo">1495</span> }<a name="line.1495"></a>
<span class="sourceLineNo">1496</span><a name="line.1496"></a>
<span class="sourceLineNo">1497</span> /**<a name="line.1497"></a>
<span class="sourceLineNo">1498</span> * Return the set of parameter names, quoting each name.<a name="line.1498"></a>
<span class="sourceLineNo">1499</span> */<a name="line.1499"></a>
<span class="sourceLineNo">1500</span> @Override<a name="line.1500"></a>
<span class="sourceLineNo">1501</span> public Enumeration&lt;String&gt; getParameterNames() {<a name="line.1501"></a>
<span class="sourceLineNo">1502</span> return new Enumeration&lt;String&gt;() {<a name="line.1502"></a>
<span class="sourceLineNo">1503</span> private Enumeration&lt;String&gt; rawIterator = rawRequest.getParameterNames();<a name="line.1503"></a>
<span class="sourceLineNo">1504</span><a name="line.1504"></a>
<span class="sourceLineNo">1505</span> @Override<a name="line.1505"></a>
<span class="sourceLineNo">1506</span> public boolean hasMoreElements() {<a name="line.1506"></a>
<span class="sourceLineNo">1507</span> return rawIterator.hasMoreElements();<a name="line.1507"></a>
<span class="sourceLineNo">1508</span> }<a name="line.1508"></a>
<span class="sourceLineNo">1509</span><a name="line.1509"></a>
<span class="sourceLineNo">1510</span> @Override<a name="line.1510"></a>
<span class="sourceLineNo">1511</span> public String nextElement() {<a name="line.1511"></a>
<span class="sourceLineNo">1512</span> return HtmlQuoting.quoteHtmlChars(rawIterator.nextElement());<a name="line.1512"></a>
<span class="sourceLineNo">1513</span> }<a name="line.1513"></a>
<span class="sourceLineNo">1514</span> };<a name="line.1514"></a>
<span class="sourceLineNo">1515</span> }<a name="line.1515"></a>
<span class="sourceLineNo">1516</span><a name="line.1516"></a>
<span class="sourceLineNo">1517</span> /**<a name="line.1517"></a>
<span class="sourceLineNo">1518</span> * Unquote the name and quote the value.<a name="line.1518"></a>
<span class="sourceLineNo">1519</span> */<a name="line.1519"></a>
<span class="sourceLineNo">1520</span> @Override<a name="line.1520"></a>
<span class="sourceLineNo">1521</span> public String getParameter(String name) {<a name="line.1521"></a>
<span class="sourceLineNo">1522</span> return HtmlQuoting<a name="line.1522"></a>
<span class="sourceLineNo">1523</span> .quoteHtmlChars(rawRequest.getParameter(HtmlQuoting.unquoteHtmlChars(name)));<a name="line.1523"></a>
<span class="sourceLineNo">1524</span> }<a name="line.1524"></a>
<span class="sourceLineNo">1525</span><a name="line.1525"></a>
<span class="sourceLineNo">1526</span> @Override<a name="line.1526"></a>
<span class="sourceLineNo">1527</span> public String[] getParameterValues(String name) {<a name="line.1527"></a>
<span class="sourceLineNo">1528</span> String unquoteName = HtmlQuoting.unquoteHtmlChars(name);<a name="line.1528"></a>
<span class="sourceLineNo">1529</span> String[] unquoteValue = rawRequest.getParameterValues(unquoteName);<a name="line.1529"></a>
<span class="sourceLineNo">1530</span> if (unquoteValue == null) {<a name="line.1530"></a>
<span class="sourceLineNo">1531</span> return null;<a name="line.1531"></a>
<span class="sourceLineNo">1532</span> }<a name="line.1532"></a>
<span class="sourceLineNo">1533</span> String[] result = new String[unquoteValue.length];<a name="line.1533"></a>
<span class="sourceLineNo">1534</span> for (int i = 0; i &lt; result.length; ++i) {<a name="line.1534"></a>
<span class="sourceLineNo">1535</span> result[i] = HtmlQuoting.quoteHtmlChars(unquoteValue[i]);<a name="line.1535"></a>
<span class="sourceLineNo">1536</span> }<a name="line.1536"></a>
<span class="sourceLineNo">1537</span> return result;<a name="line.1537"></a>
<span class="sourceLineNo">1538</span> }<a name="line.1538"></a>
<span class="sourceLineNo">1539</span><a name="line.1539"></a>
<span class="sourceLineNo">1540</span> @Override<a name="line.1540"></a>
<span class="sourceLineNo">1541</span> public Map&lt;String, String[]&gt; getParameterMap() {<a name="line.1541"></a>
<span class="sourceLineNo">1542</span> Map&lt;String, String[]&gt; result = new HashMap&lt;&gt;();<a name="line.1542"></a>
<span class="sourceLineNo">1543</span> Map&lt;String, String[]&gt; raw = rawRequest.getParameterMap();<a name="line.1543"></a>
<span class="sourceLineNo">1544</span> for (Map.Entry&lt;String, String[]&gt; item : raw.entrySet()) {<a name="line.1544"></a>
<span class="sourceLineNo">1545</span> String[] rawValue = item.getValue();<a name="line.1545"></a>
<span class="sourceLineNo">1546</span> String[] cookedValue = new String[rawValue.length];<a name="line.1546"></a>
<span class="sourceLineNo">1547</span> for (int i = 0; i &lt; rawValue.length; ++i) {<a name="line.1547"></a>
<span class="sourceLineNo">1548</span> cookedValue[i] = HtmlQuoting.quoteHtmlChars(rawValue[i]);<a name="line.1548"></a>
<span class="sourceLineNo">1549</span> }<a name="line.1549"></a>
<span class="sourceLineNo">1550</span> result.put(HtmlQuoting.quoteHtmlChars(item.getKey()), cookedValue);<a name="line.1550"></a>
<span class="sourceLineNo">1551</span> }<a name="line.1551"></a>
<span class="sourceLineNo">1552</span> return result;<a name="line.1552"></a>
<span class="sourceLineNo">1553</span> }<a name="line.1553"></a>
<span class="sourceLineNo">1554</span><a name="line.1554"></a>
<span class="sourceLineNo">1555</span> /**<a name="line.1555"></a>
<span class="sourceLineNo">1556</span> * Quote the url so that users specifying the HOST HTTP header can't inject attacks.<a name="line.1556"></a>
<span class="sourceLineNo">1557</span> */<a name="line.1557"></a>
<span class="sourceLineNo">1558</span> @Override<a name="line.1558"></a>
<span class="sourceLineNo">1559</span> public StringBuffer getRequestURL() {<a name="line.1559"></a>
<span class="sourceLineNo">1560</span> String url = rawRequest.getRequestURL().toString();<a name="line.1560"></a>
<span class="sourceLineNo">1561</span> return new StringBuffer(HtmlQuoting.quoteHtmlChars(url));<a name="line.1561"></a>
<span class="sourceLineNo">1562</span> }<a name="line.1562"></a>
<span class="sourceLineNo">1563</span><a name="line.1563"></a>
<span class="sourceLineNo">1564</span> /**<a name="line.1564"></a>
<span class="sourceLineNo">1565</span> * Quote the server name so that users specifying the HOST HTTP header can't inject attacks.<a name="line.1565"></a>
<span class="sourceLineNo">1566</span> */<a name="line.1566"></a>
<span class="sourceLineNo">1567</span> @Override<a name="line.1567"></a>
<span class="sourceLineNo">1568</span> public String getServerName() {<a name="line.1568"></a>
<span class="sourceLineNo">1569</span> return HtmlQuoting.quoteHtmlChars(rawRequest.getServerName());<a name="line.1569"></a>
<span class="sourceLineNo">1570</span> }<a name="line.1570"></a>
<span class="sourceLineNo">1571</span> }<a name="line.1571"></a>
<span class="sourceLineNo">1572</span><a name="line.1572"></a>
<span class="sourceLineNo">1573</span> @Override<a name="line.1573"></a>
<span class="sourceLineNo">1574</span> public void init(FilterConfig config) throws ServletException {<a name="line.1574"></a>
<span class="sourceLineNo">1575</span> this.config = config;<a name="line.1575"></a>
<span class="sourceLineNo">1576</span> }<a name="line.1576"></a>
<span class="sourceLineNo">1577</span><a name="line.1577"></a>
<span class="sourceLineNo">1578</span> @Override<a name="line.1578"></a>
<span class="sourceLineNo">1579</span> public void destroy() {<a name="line.1579"></a>
<span class="sourceLineNo">1580</span> }<a name="line.1580"></a>
<span class="sourceLineNo">1581</span><a name="line.1581"></a>
<span class="sourceLineNo">1582</span> @Override<a name="line.1582"></a>
<span class="sourceLineNo">1583</span> public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)<a name="line.1583"></a>
<span class="sourceLineNo">1584</span> throws IOException, ServletException {<a name="line.1584"></a>
<span class="sourceLineNo">1585</span> HttpServletRequestWrapper quoted = new RequestQuoter((HttpServletRequest) request);<a name="line.1585"></a>
<span class="sourceLineNo">1586</span> HttpServletResponse httpResponse = (HttpServletResponse) response;<a name="line.1586"></a>
<span class="sourceLineNo">1587</span><a name="line.1587"></a>
<span class="sourceLineNo">1588</span> String mime = inferMimeType(request);<a name="line.1588"></a>
<span class="sourceLineNo">1589</span> if (mime == null) {<a name="line.1589"></a>
<span class="sourceLineNo">1590</span> httpResponse.setContentType("text/plain; charset=utf-8");<a name="line.1590"></a>
<span class="sourceLineNo">1591</span> } else if (mime.startsWith("text/html")) {<a name="line.1591"></a>
<span class="sourceLineNo">1592</span> // HTML with unspecified encoding, we want to<a name="line.1592"></a>
<span class="sourceLineNo">1593</span> // force HTML with utf-8 encoding<a name="line.1593"></a>
<span class="sourceLineNo">1594</span> // This is to avoid the following security issue:<a name="line.1594"></a>
<span class="sourceLineNo">1595</span> // http://openmya.hacker.jp/hasegawa/security/utf7cs.html<a name="line.1595"></a>
<span class="sourceLineNo">1596</span> httpResponse.setContentType("text/html; charset=utf-8");<a name="line.1596"></a>
<span class="sourceLineNo">1597</span> } else if (mime.startsWith("application/xml")) {<a name="line.1597"></a>
<span class="sourceLineNo">1598</span> httpResponse.setContentType("text/xml; charset=utf-8");<a name="line.1598"></a>
<span class="sourceLineNo">1599</span> }<a name="line.1599"></a>
<span class="sourceLineNo">1600</span> chain.doFilter(quoted, httpResponse);<a name="line.1600"></a>
<span class="sourceLineNo">1601</span> }<a name="line.1601"></a>
<span class="sourceLineNo">1602</span><a name="line.1602"></a>
<span class="sourceLineNo">1603</span> /**<a name="line.1603"></a>
<span class="sourceLineNo">1604</span> * Infer the mime type for the response based on the extension of the request URI. Returns null<a name="line.1604"></a>
<span class="sourceLineNo">1605</span> * if unknown.<a name="line.1605"></a>
<span class="sourceLineNo">1606</span> */<a name="line.1606"></a>
<span class="sourceLineNo">1607</span> private String inferMimeType(ServletRequest request) {<a name="line.1607"></a>
<span class="sourceLineNo">1608</span> String path = ((HttpServletRequest) request).getRequestURI();<a name="line.1608"></a>
<span class="sourceLineNo">1609</span> ServletContext context = config.getServletContext();<a name="line.1609"></a>
<span class="sourceLineNo">1610</span> return context.getMimeType(path);<a name="line.1610"></a>
<span class="sourceLineNo">1611</span> }<a name="line.1611"></a>
<span class="sourceLineNo">1612</span> }<a name="line.1612"></a>
<span class="sourceLineNo">1613</span>}<a name="line.1613"></a>
</pre>
</div>
</body>
</html>