blob: fb5cbc1776b645596b2f6aa79d838926aae08f17 [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.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.URI;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.servlet.http.HttpServlet;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Create a Jetty embedded server to answer http requests. The primary goal<a name="line.30"></a>
<span class="sourceLineNo">031</span> * is to serve up status information for the server.<a name="line.31"></a>
<span class="sourceLineNo">032</span> * There are three contexts:<a name="line.32"></a>
<span class="sourceLineNo">033</span> * "/stacks/" -&amp;gt; points to stack trace<a name="line.33"></a>
<span class="sourceLineNo">034</span> * "/static/" -&amp;gt; points to common static files (src/hbase-webapps/static)<a name="line.34"></a>
<span class="sourceLineNo">035</span> * "/" -&amp;gt; the jsp server code from (src/hbase-webapps/&amp;lt;name&amp;gt;)<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>@InterfaceAudience.Private<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class InfoServer {<a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final String HBASE_APP_DIR = "hbase-webapps";<a name="line.39"></a>
<span class="sourceLineNo">040</span> private final org.apache.hadoop.hbase.http.HttpServer httpServer;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Create a status server on the given port.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * The jsp scripts are taken from src/hbase-webapps/&lt;code&gt;name&lt;/code&gt;.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param name The name of the server<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param bindAddress address to bind to<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @param port The port to use on the server<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param findPort whether the server should start at the given port and increment by 1 until it<a name="line.48"></a>
<span class="sourceLineNo">049</span> * finds a free port.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param c the {@link Configuration} to build the server<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @throws IOException if getting one of the password fails or the server cannot be created<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public InfoServer(String name, String bindAddress, int port, boolean findPort,<a name="line.53"></a>
<span class="sourceLineNo">054</span> final Configuration c) throws IOException {<a name="line.54"></a>
<span class="sourceLineNo">055</span> HttpConfig httpConfig = new HttpConfig(c);<a name="line.55"></a>
<span class="sourceLineNo">056</span> HttpServer.Builder builder =<a name="line.56"></a>
<span class="sourceLineNo">057</span> new org.apache.hadoop.hbase.http.HttpServer.Builder();<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> builder.setName(name).addEndpoint(URI.create(httpConfig.getSchemePrefix() +<a name="line.59"></a>
<span class="sourceLineNo">060</span> bindAddress + ":" +<a name="line.60"></a>
<span class="sourceLineNo">061</span> port)).setAppDir(HBASE_APP_DIR).setFindPort(findPort).setConf(c);<a name="line.61"></a>
<span class="sourceLineNo">062</span> String logDir = System.getProperty("hbase.log.dir");<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (logDir != null) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> builder.setLogDir(logDir);<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (httpConfig.isSecure()) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> builder.keyPassword(HBaseConfiguration<a name="line.67"></a>
<span class="sourceLineNo">068</span> .getPassword(c, "ssl.server.keystore.keypassword", null))<a name="line.68"></a>
<span class="sourceLineNo">069</span> .keyStore(c.get("ssl.server.keystore.location"),<a name="line.69"></a>
<span class="sourceLineNo">070</span> HBaseConfiguration.getPassword(c,"ssl.server.keystore.password", null),<a name="line.70"></a>
<span class="sourceLineNo">071</span> c.get("ssl.server.keystore.type", "jks"))<a name="line.71"></a>
<span class="sourceLineNo">072</span> .trustStore(c.get("ssl.server.truststore.location"),<a name="line.72"></a>
<span class="sourceLineNo">073</span> HBaseConfiguration.getPassword(c, "ssl.server.truststore.password", null),<a name="line.73"></a>
<span class="sourceLineNo">074</span> c.get("ssl.server.truststore.type", "jks"));<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> // Enable SPNEGO authentication<a name="line.76"></a>
<span class="sourceLineNo">077</span> if ("kerberos".equalsIgnoreCase(c.get(HttpServer.HTTP_UI_AUTHENTICATION, null))) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> builder.setUsernameConfKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY)<a name="line.78"></a>
<span class="sourceLineNo">079</span> .setKeytabConfKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY)<a name="line.79"></a>
<span class="sourceLineNo">080</span> .setKerberosNameRulesKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY)<a name="line.80"></a>
<span class="sourceLineNo">081</span> .setSignatureSecretFileKey(<a name="line.81"></a>
<span class="sourceLineNo">082</span> HttpServer.HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY)<a name="line.82"></a>
<span class="sourceLineNo">083</span> .setSecurityEnabled(true);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.httpServer = builder.build();<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> public void addServlet(String name, String pathSpec,<a name="line.88"></a>
<span class="sourceLineNo">089</span> Class&lt;? extends HttpServlet&gt; clazz) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> this.httpServer.addServlet(name, pathSpec, clazz);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public void setAttribute(String name, Object value) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> this.httpServer.setAttribute(name, value);<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> public void start() throws IOException {<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.httpServer.start();<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * @return the port of the info server<a name="line.102"></a>
<span class="sourceLineNo">103</span> * @deprecated Since 0.99.0<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> @Deprecated<a name="line.105"></a>
<span class="sourceLineNo">106</span> public int getPort() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return this.httpServer.getPort();<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public void stop() throws Exception {<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.httpServer.stop();<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span>}<a name="line.113"></a>
</pre>
</div>
</body>
</html>