http://git-wip-us.apache.org/repos/asf/hbase-site/blob/78d8c5d7/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftHttpServlet.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftHttpServlet.html b/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftHttpServlet.html index b479b6b..c5277a9 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftHttpServlet.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftHttpServlet.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<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> @@ -26,224 +26,252 @@ <span class="sourceLineNo">018</span><a name="line.18"></a> <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.thrift;<a name="line.19"></a> <span class="sourceLineNo">020</span><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.security.PrivilegedExceptionAction;<a name="line.22"></a> +<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.thrift.ThriftServerRunner.THRIFT_SPNEGO_KEYTAB_FILE_KEY;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import static org.apache.hadoop.hbase.thrift.ThriftServerRunner.THRIFT_SPNEGO_PRINCIPAL_KEY;<a name="line.22"></a> <span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>import javax.servlet.ServletException;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import javax.servlet.http.HttpServletRequest;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import javax.servlet.http.HttpServletResponse;<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.conf.Configuration;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.security.SecurityUtil;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.util.Base64;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.security.authorize.AuthorizationException;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.security.authorize.ProxyUsers;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.thrift.TProcessor;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.thrift.protocol.TProtocolFactory;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.thrift.server.TServlet;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.ietf.jgss.GSSContext;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.ietf.jgss.GSSCredential;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.ietf.jgss.GSSException;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.ietf.jgss.GSSManager;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.ietf.jgss.GSSName;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.ietf.jgss.Oid;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span>/**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * Thrift Http Servlet is used for performing Kerberos authentication if security is enabled and<a name="line.48"></a> -<span class="sourceLineNo">049</span> * also used for setting the user specified in "doAs" parameter.<a name="line.49"></a> -<span class="sourceLineNo">050</span> */<a name="line.50"></a> -<span class="sourceLineNo">051</span>@InterfaceAudience.Private<a name="line.51"></a> -<span class="sourceLineNo">052</span>public class ThriftHttpServlet extends TServlet {<a name="line.52"></a> -<span class="sourceLineNo">053</span> private static final long serialVersionUID = 1L;<a name="line.53"></a> -<span class="sourceLineNo">054</span> private static final Logger LOG = LoggerFactory.getLogger(ThriftHttpServlet.class.getName());<a name="line.54"></a> -<span class="sourceLineNo">055</span> private transient final UserGroupInformation realUser;<a name="line.55"></a> -<span class="sourceLineNo">056</span> private transient final Configuration conf;<a name="line.56"></a> -<span class="sourceLineNo">057</span> private final boolean securityEnabled;<a name="line.57"></a> -<span class="sourceLineNo">058</span> private final boolean doAsEnabled;<a name="line.58"></a> -<span class="sourceLineNo">059</span> private transient ThriftServerRunner.HBaseHandler hbaseHandler;<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> // HTTP Header related constants.<a name="line.61"></a> -<span class="sourceLineNo">062</span> public static final String WWW_AUTHENTICATE = "WWW-Authenticate";<a name="line.62"></a> -<span class="sourceLineNo">063</span> public static final String AUTHORIZATION = "Authorization";<a name="line.63"></a> -<span class="sourceLineNo">064</span> public static final String NEGOTIATE = "Negotiate";<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> public ThriftHttpServlet(TProcessor processor, TProtocolFactory protocolFactory,<a name="line.66"></a> -<span class="sourceLineNo">067</span> UserGroupInformation realUser, Configuration conf, ThriftServerRunner.HBaseHandler<a name="line.67"></a> -<span class="sourceLineNo">068</span> hbaseHandler, boolean securityEnabled, boolean doAsEnabled) {<a name="line.68"></a> -<span class="sourceLineNo">069</span> super(processor, protocolFactory);<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.realUser = realUser;<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.conf = conf;<a name="line.71"></a> -<span class="sourceLineNo">072</span> this.hbaseHandler = hbaseHandler;<a name="line.72"></a> -<span class="sourceLineNo">073</span> this.securityEnabled = securityEnabled;<a name="line.73"></a> -<span class="sourceLineNo">074</span> this.doAsEnabled = doAsEnabled;<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span><a name="line.76"></a> -<span class="sourceLineNo">077</span> @Override<a name="line.77"></a> -<span class="sourceLineNo">078</span> protected void doPost(HttpServletRequest request, HttpServletResponse response)<a name="line.78"></a> -<span class="sourceLineNo">079</span> throws ServletException, IOException {<a name="line.79"></a> -<span class="sourceLineNo">080</span> String effectiveUser = request.getRemoteUser();<a name="line.80"></a> -<span class="sourceLineNo">081</span> if (securityEnabled) {<a name="line.81"></a> -<span class="sourceLineNo">082</span> try {<a name="line.82"></a> -<span class="sourceLineNo">083</span> // As Thrift HTTP transport doesn't support SPNEGO yet (THRIFT-889),<a name="line.83"></a> -<span class="sourceLineNo">084</span> // Kerberos authentication is being done at servlet level.<a name="line.84"></a> -<span class="sourceLineNo">085</span> final RemoteUserIdentity identity = doKerberosAuth(request);<a name="line.85"></a> -<span class="sourceLineNo">086</span> effectiveUser = identity.principal;<a name="line.86"></a> -<span class="sourceLineNo">087</span> // It is standard for client applications expect this header.<a name="line.87"></a> -<span class="sourceLineNo">088</span> // Please see http://tools.ietf.org/html/rfc4559 for more details.<a name="line.88"></a> -<span class="sourceLineNo">089</span> response.addHeader(WWW_AUTHENTICATE, NEGOTIATE + " " + identity.outToken);<a name="line.89"></a> -<span class="sourceLineNo">090</span> } catch (HttpAuthenticationException e) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> LOG.error("Kerberos Authentication failed", e);<a name="line.91"></a> -<span class="sourceLineNo">092</span> // Send a 401 to the client<a name="line.92"></a> -<span class="sourceLineNo">093</span> response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);<a name="line.93"></a> -<span class="sourceLineNo">094</span> response.addHeader(WWW_AUTHENTICATE, NEGOTIATE);<a name="line.94"></a> -<span class="sourceLineNo">095</span> response.getWriter().println("Authentication Error: " + e.getMessage());<a name="line.95"></a> -<span class="sourceLineNo">096</span> return;<a name="line.96"></a> -<span class="sourceLineNo">097</span> }<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span> String doAsUserFromQuery = request.getHeader("doAs");<a name="line.99"></a> -<span class="sourceLineNo">100</span> if(effectiveUser == null) {<a name="line.100"></a> -<span class="sourceLineNo">101</span> effectiveUser = realUser.getShortUserName();<a name="line.101"></a> -<span class="sourceLineNo">102</span> }<a name="line.102"></a> -<span class="sourceLineNo">103</span> if (doAsUserFromQuery != null) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> if (!doAsEnabled) {<a name="line.104"></a> -<span class="sourceLineNo">105</span> throw new ServletException("Support for proxyuser is not configured");<a name="line.105"></a> +<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.security.PrivilegedExceptionAction;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>import javax.servlet.ServletException;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import javax.servlet.http.HttpServletRequest;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import javax.servlet.http.HttpServletResponse;<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.security.SecurityUtil;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.Base64;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.hadoop.security.authorize.AuthorizationException;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hadoop.security.authorize.ProxyUsers;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.http.HttpHeaders;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.thrift.TProcessor;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.thrift.protocol.TProtocolFactory;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.thrift.server.TServlet;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.ietf.jgss.GSSContext;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.ietf.jgss.GSSCredential;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.ietf.jgss.GSSException;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.ietf.jgss.GSSManager;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.ietf.jgss.GSSName;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.ietf.jgss.Oid;<a name="line.47"></a> +<span class="sourceLineNo">048</span>import org.slf4j.Logger;<a name="line.48"></a> +<span class="sourceLineNo">049</span>import org.slf4j.LoggerFactory;<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span>/**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Thrift Http Servlet is used for performing Kerberos authentication if security is enabled and<a name="line.52"></a> +<span class="sourceLineNo">053</span> * also used for setting the user specified in "doAs" parameter.<a name="line.53"></a> +<span class="sourceLineNo">054</span> */<a name="line.54"></a> +<span class="sourceLineNo">055</span>@InterfaceAudience.Private<a name="line.55"></a> +<span class="sourceLineNo">056</span>public class ThriftHttpServlet extends TServlet {<a name="line.56"></a> +<span class="sourceLineNo">057</span> private static final long serialVersionUID = 1L;<a name="line.57"></a> +<span class="sourceLineNo">058</span> private static final Logger LOG = LoggerFactory.getLogger(ThriftHttpServlet.class.getName());<a name="line.58"></a> +<span class="sourceLineNo">059</span> private final transient UserGroupInformation serviceUGI;<a name="line.59"></a> +<span class="sourceLineNo">060</span> private final transient UserGroupInformation httpUGI;<a name="line.60"></a> +<span class="sourceLineNo">061</span> private final transient ThriftServerRunner.HBaseHandler hbaseHandler;<a name="line.61"></a> +<span class="sourceLineNo">062</span> private final boolean doAsEnabled;<a name="line.62"></a> +<span class="sourceLineNo">063</span> private final boolean securityEnabled;<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> // HTTP Header related constants.<a name="line.65"></a> +<span class="sourceLineNo">066</span> public static final String NEGOTIATE = "Negotiate";<a name="line.66"></a> +<span class="sourceLineNo">067</span><a name="line.67"></a> +<span class="sourceLineNo">068</span> public ThriftHttpServlet(TProcessor processor, TProtocolFactory protocolFactory,<a name="line.68"></a> +<span class="sourceLineNo">069</span> UserGroupInformation serviceUGI, Configuration conf,<a name="line.69"></a> +<span class="sourceLineNo">070</span> ThriftServerRunner.HBaseHandler hbaseHandler, boolean securityEnabled, boolean doAsEnabled)<a name="line.70"></a> +<span class="sourceLineNo">071</span> throws IOException {<a name="line.71"></a> +<span class="sourceLineNo">072</span> super(processor, protocolFactory);<a name="line.72"></a> +<span class="sourceLineNo">073</span> this.serviceUGI = serviceUGI;<a name="line.73"></a> +<span class="sourceLineNo">074</span> this.hbaseHandler = hbaseHandler;<a name="line.74"></a> +<span class="sourceLineNo">075</span> this.securityEnabled = securityEnabled;<a name="line.75"></a> +<span class="sourceLineNo">076</span> this.doAsEnabled = doAsEnabled;<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> if (securityEnabled) {<a name="line.78"></a> +<span class="sourceLineNo">079</span> // login the spnego principal<a name="line.79"></a> +<span class="sourceLineNo">080</span> UserGroupInformation.setConfiguration(conf);<a name="line.80"></a> +<span class="sourceLineNo">081</span> this.httpUGI = UserGroupInformation.loginUserFromKeytabAndReturnUGI(<a name="line.81"></a> +<span class="sourceLineNo">082</span> conf.get(THRIFT_SPNEGO_PRINCIPAL_KEY),<a name="line.82"></a> +<span class="sourceLineNo">083</span> conf.get(THRIFT_SPNEGO_KEYTAB_FILE_KEY)<a name="line.83"></a> +<span class="sourceLineNo">084</span> );<a name="line.84"></a> +<span class="sourceLineNo">085</span> } else {<a name="line.85"></a> +<span class="sourceLineNo">086</span> this.httpUGI = null;<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<a name="line.88"></a> +<span class="sourceLineNo">089</span><a name="line.89"></a> +<span class="sourceLineNo">090</span> @Override<a name="line.90"></a> +<span class="sourceLineNo">091</span> protected void doPost(HttpServletRequest request, HttpServletResponse response)<a name="line.91"></a> +<span class="sourceLineNo">092</span> throws ServletException, IOException {<a name="line.92"></a> +<span class="sourceLineNo">093</span> String effectiveUser = request.getRemoteUser();<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (securityEnabled) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> /*<a name="line.95"></a> +<span class="sourceLineNo">096</span> Check that the AUTHORIZATION header has any content. If it does not then return a 401<a name="line.96"></a> +<span class="sourceLineNo">097</span> requesting AUTHORIZATION header to be sent. This is typical where the first request doesn't<a name="line.97"></a> +<span class="sourceLineNo">098</span> send the AUTHORIZATION header initially.<a name="line.98"></a> +<span class="sourceLineNo">099</span> */<a name="line.99"></a> +<span class="sourceLineNo">100</span> String authHeader = request.getHeader(HttpHeaders.AUTHORIZATION);<a name="line.100"></a> +<span class="sourceLineNo">101</span> if (authHeader == null || authHeader.isEmpty()) {<a name="line.101"></a> +<span class="sourceLineNo">102</span> // Send a 401 to the client<a name="line.102"></a> +<span class="sourceLineNo">103</span> response.addHeader(HttpHeaders.WWW_AUTHENTICATE, NEGOTIATE);<a name="line.103"></a> +<span class="sourceLineNo">104</span> response.sendError(HttpServletResponse.SC_UNAUTHORIZED);<a name="line.104"></a> +<span class="sourceLineNo">105</span> return;<a name="line.105"></a> <span class="sourceLineNo">106</span> }<a name="line.106"></a> -<span class="sourceLineNo">107</span> // The authenticated remote user is attempting to perform 'doAs' proxy user.<a name="line.107"></a> -<span class="sourceLineNo">108</span> UserGroupInformation remoteUser = UserGroupInformation.createRemoteUser(effectiveUser);<a name="line.108"></a> -<span class="sourceLineNo">109</span> // create and attempt to authorize a proxy user (the client is attempting<a name="line.109"></a> -<span class="sourceLineNo">110</span> // to do proxy user)<a name="line.110"></a> -<span class="sourceLineNo">111</span> UserGroupInformation ugi = UserGroupInformation.createProxyUser(doAsUserFromQuery,<a name="line.111"></a> -<span class="sourceLineNo">112</span> remoteUser);<a name="line.112"></a> -<span class="sourceLineNo">113</span> // validate the proxy user authorization<a name="line.113"></a> -<span class="sourceLineNo">114</span> try {<a name="line.114"></a> -<span class="sourceLineNo">115</span> ProxyUsers.authorize(ugi, request.getRemoteAddr(), conf);<a name="line.115"></a> -<span class="sourceLineNo">116</span> } catch (AuthorizationException e) {<a name="line.116"></a> -<span class="sourceLineNo">117</span> throw new ServletException(e.getMessage());<a name="line.117"></a> -<span class="sourceLineNo">118</span> }<a name="line.118"></a> -<span class="sourceLineNo">119</span> effectiveUser = doAsUserFromQuery;<a name="line.119"></a> -<span class="sourceLineNo">120</span> }<a name="line.120"></a> -<span class="sourceLineNo">121</span> hbaseHandler.setEffectiveUser(effectiveUser);<a name="line.121"></a> -<span class="sourceLineNo">122</span> super.doPost(request, response);<a name="line.122"></a> -<span class="sourceLineNo">123</span> }<a name="line.123"></a> -<span class="sourceLineNo">124</span><a name="line.124"></a> -<span class="sourceLineNo">125</span> /**<a name="line.125"></a> -<span class="sourceLineNo">126</span> * Do the GSS-API kerberos authentication.<a name="line.126"></a> -<span class="sourceLineNo">127</span> * We already have a logged in subject in the form of serviceUGI,<a name="line.127"></a> -<span class="sourceLineNo">128</span> * which GSS-API will extract information from.<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> private RemoteUserIdentity doKerberosAuth(HttpServletRequest request)<a name="line.130"></a> -<span class="sourceLineNo">131</span> throws HttpAuthenticationException {<a name="line.131"></a> -<span class="sourceLineNo">132</span> HttpKerberosServerAction action = new HttpKerberosServerAction(request, realUser);<a name="line.132"></a> -<span class="sourceLineNo">133</span> try {<a name="line.133"></a> -<span class="sourceLineNo">134</span> String principal = realUser.doAs(action);<a name="line.134"></a> -<span class="sourceLineNo">135</span> return new RemoteUserIdentity(principal, action.outToken);<a name="line.135"></a> -<span class="sourceLineNo">136</span> } catch (Exception e) {<a name="line.136"></a> -<span class="sourceLineNo">137</span> LOG.error("Failed to perform authentication");<a name="line.137"></a> -<span class="sourceLineNo">138</span> throw new HttpAuthenticationException(e);<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span> }<a name="line.140"></a> -<span class="sourceLineNo">141</span><a name="line.141"></a> -<span class="sourceLineNo">142</span> /**<a name="line.142"></a> -<span class="sourceLineNo">143</span> * Basic "struct" class to hold the final base64-encoded, authenticated GSSAPI token<a name="line.143"></a> -<span class="sourceLineNo">144</span> * for the user with the given principal talking to the Thrift server.<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> private static class RemoteUserIdentity {<a name="line.146"></a> -<span class="sourceLineNo">147</span> final String outToken;<a name="line.147"></a> -<span class="sourceLineNo">148</span> final String principal;<a name="line.148"></a> -<span class="sourceLineNo">149</span><a name="line.149"></a> -<span class="sourceLineNo">150</span> RemoteUserIdentity(String principal, String outToken) {<a name="line.150"></a> -<span class="sourceLineNo">151</span> this.principal = principal;<a name="line.151"></a> -<span class="sourceLineNo">152</span> this.outToken = outToken;<a name="line.152"></a> -<span class="sourceLineNo">153</span> }<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> -<span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> private static class HttpKerberosServerAction implements PrivilegedExceptionAction<String> {<a name="line.156"></a> -<span class="sourceLineNo">157</span> HttpServletRequest request;<a name="line.157"></a> -<span class="sourceLineNo">158</span> UserGroupInformation serviceUGI;<a name="line.158"></a> -<span class="sourceLineNo">159</span> String outToken = null;<a name="line.159"></a> -<span class="sourceLineNo">160</span> HttpKerberosServerAction(HttpServletRequest request, UserGroupInformation serviceUGI) {<a name="line.160"></a> -<span class="sourceLineNo">161</span> this.request = request;<a name="line.161"></a> -<span class="sourceLineNo">162</span> this.serviceUGI = serviceUGI;<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> @Override<a name="line.165"></a> -<span class="sourceLineNo">166</span> public String run() throws HttpAuthenticationException {<a name="line.166"></a> -<span class="sourceLineNo">167</span> // Get own Kerberos credentials for accepting connection<a name="line.167"></a> -<span class="sourceLineNo">168</span> GSSManager manager = GSSManager.getInstance();<a name="line.168"></a> -<span class="sourceLineNo">169</span> GSSContext gssContext = null;<a name="line.169"></a> -<span class="sourceLineNo">170</span> String serverPrincipal = SecurityUtil.getPrincipalWithoutRealm(serviceUGI.getUserName());<a name="line.170"></a> -<span class="sourceLineNo">171</span> try {<a name="line.171"></a> -<span class="sourceLineNo">172</span> // This Oid for Kerberos GSS-API mechanism.<a name="line.172"></a> -<span class="sourceLineNo">173</span> Oid kerberosMechOid = new Oid("1.2.840.113554.1.2.2");<a name="line.173"></a> -<span class="sourceLineNo">174</span> // Oid for SPNego GSS-API mechanism.<a name="line.174"></a> -<span class="sourceLineNo">175</span> Oid spnegoMechOid = new Oid("1.3.6.1.5.5.2");<a name="line.175"></a> -<span class="sourceLineNo">176</span> // Oid for kerberos principal name<a name="line.176"></a> -<span class="sourceLineNo">177</span> Oid krb5PrincipalOid = new Oid("1.2.840.113554.1.2.2.1");<a name="line.177"></a> -<span class="sourceLineNo">178</span> // GSS name for server<a name="line.178"></a> -<span class="sourceLineNo">179</span> GSSName serverName = manager.createName(serverPrincipal, krb5PrincipalOid);<a name="line.179"></a> -<span class="sourceLineNo">180</span> // GSS credentials for server<a name="line.180"></a> -<span class="sourceLineNo">181</span> GSSCredential serverCreds = manager.createCredential(serverName,<a name="line.181"></a> -<span class="sourceLineNo">182</span> GSSCredential.DEFAULT_LIFETIME,<a name="line.182"></a> -<span class="sourceLineNo">183</span> new Oid[]{kerberosMechOid, spnegoMechOid},<a name="line.183"></a> -<span class="sourceLineNo">184</span> GSSCredential.ACCEPT_ONLY);<a name="line.184"></a> -<span class="sourceLineNo">185</span> // Create a GSS context<a name="line.185"></a> -<span class="sourceLineNo">186</span> gssContext = manager.createContext(serverCreds);<a name="line.186"></a> -<span class="sourceLineNo">187</span> // Get service ticket from the authorization header<a name="line.187"></a> -<span class="sourceLineNo">188</span> String serviceTicketBase64 = getAuthHeader(request);<a name="line.188"></a> -<span class="sourceLineNo">189</span> byte[] inToken = Base64.decode(serviceTicketBase64);<a name="line.189"></a> -<span class="sourceLineNo">190</span> byte[] res = gssContext.acceptSecContext(inToken, 0, inToken.length);<a name="line.190"></a> -<span class="sourceLineNo">191</span> if(res != null) {<a name="line.191"></a> -<span class="sourceLineNo">192</span> outToken = Base64.encodeBytes(res).replace("\n", "");<a name="line.192"></a> -<span class="sourceLineNo">193</span> }<a name="line.193"></a> -<span class="sourceLineNo">194</span> // Authenticate or deny based on its context completion<a name="line.194"></a> -<span class="sourceLineNo">195</span> if (!gssContext.isEstablished()) {<a name="line.195"></a> -<span class="sourceLineNo">196</span> throw new HttpAuthenticationException("Kerberos authentication failed: " +<a name="line.196"></a> -<span class="sourceLineNo">197</span> "unable to establish context with the service ticket " +<a name="line.197"></a> -<span class="sourceLineNo">198</span> "provided by the client.");<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span> return SecurityUtil.getUserFromPrincipal(gssContext.getSrcName().toString());<a name="line.200"></a> -<span class="sourceLineNo">201</span> } catch (GSSException e) {<a name="line.201"></a> -<span class="sourceLineNo">202</span> throw new HttpAuthenticationException("Kerberos authentication failed: ", e);<a name="line.202"></a> -<span class="sourceLineNo">203</span> } finally {<a name="line.203"></a> -<span class="sourceLineNo">204</span> if (gssContext != null) {<a name="line.204"></a> -<span class="sourceLineNo">205</span> try {<a name="line.205"></a> -<span class="sourceLineNo">206</span> gssContext.dispose();<a name="line.206"></a> -<span class="sourceLineNo">207</span> } catch (GSSException e) {<a name="line.207"></a> -<span class="sourceLineNo">208</span> LOG.warn("Error while disposing GSS Context", e);<a name="line.208"></a> -<span class="sourceLineNo">209</span> }<a name="line.209"></a> -<span class="sourceLineNo">210</span> }<a name="line.210"></a> -<span class="sourceLineNo">211</span> }<a name="line.211"></a> -<span class="sourceLineNo">212</span> }<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> * Returns the base64 encoded auth header payload<a name="line.215"></a> -<span class="sourceLineNo">216</span> *<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @throws HttpAuthenticationException if a remote or network exception occurs<a name="line.217"></a> -<span class="sourceLineNo">218</span> */<a name="line.218"></a> -<span class="sourceLineNo">219</span> private String getAuthHeader(HttpServletRequest request)<a name="line.219"></a> -<span class="sourceLineNo">220</span> throws HttpAuthenticationException {<a name="line.220"></a> -<span class="sourceLineNo">221</span> String authHeader = request.getHeader(AUTHORIZATION);<a name="line.221"></a> -<span class="sourceLineNo">222</span> // Each http request must have an Authorization header<a name="line.222"></a> -<span class="sourceLineNo">223</span> if (authHeader == null || authHeader.isEmpty()) {<a name="line.223"></a> -<span class="sourceLineNo">224</span> throw new HttpAuthenticationException("Authorization header received " +<a name="line.224"></a> -<span class="sourceLineNo">225</span> "from the client is empty.");<a name="line.225"></a> -<span class="sourceLineNo">226</span> }<a name="line.226"></a> -<span class="sourceLineNo">227</span> String authHeaderBase64String;<a name="line.227"></a> -<span class="sourceLineNo">228</span> int beginIndex = (NEGOTIATE + " ").length();<a name="line.228"></a> -<span class="sourceLineNo">229</span> authHeaderBase64String = authHeader.substring(beginIndex);<a name="line.229"></a> -<span class="sourceLineNo">230</span> // Authorization header must have a payload<a name="line.230"></a> -<span class="sourceLineNo">231</span> if (authHeaderBase64String == null || authHeaderBase64String.isEmpty()) {<a name="line.231"></a> -<span class="sourceLineNo">232</span> throw new HttpAuthenticationException("Authorization header received " +<a name="line.232"></a> -<span class="sourceLineNo">233</span> "from the client does not contain any data.");<a name="line.233"></a> -<span class="sourceLineNo">234</span> }<a name="line.234"></a> -<span class="sourceLineNo">235</span> return authHeaderBase64String;<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span> }<a name="line.237"></a> -<span class="sourceLineNo">238</span>}<a name="line.238"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> try {<a name="line.108"></a> +<span class="sourceLineNo">109</span> // As Thrift HTTP transport doesn't support SPNEGO yet (THRIFT-889),<a name="line.109"></a> +<span class="sourceLineNo">110</span> // Kerberos authentication is being done at servlet level.<a name="line.110"></a> +<span class="sourceLineNo">111</span> final RemoteUserIdentity identity = doKerberosAuth(request);<a name="line.111"></a> +<span class="sourceLineNo">112</span> effectiveUser = identity.principal;<a name="line.112"></a> +<span class="sourceLineNo">113</span> // It is standard for client applications expect this header.<a name="line.113"></a> +<span class="sourceLineNo">114</span> // Please see http://tools.ietf.org/html/rfc4559 for more details.<a name="line.114"></a> +<span class="sourceLineNo">115</span> response.addHeader(HttpHeaders.WWW_AUTHENTICATE, NEGOTIATE + " " + identity.outToken);<a name="line.115"></a> +<span class="sourceLineNo">116</span> } catch (HttpAuthenticationException e) {<a name="line.116"></a> +<span class="sourceLineNo">117</span> LOG.error("Kerberos Authentication failed", e);<a name="line.117"></a> +<span class="sourceLineNo">118</span> // Send a 401 to the client<a name="line.118"></a> +<span class="sourceLineNo">119</span> response.addHeader(HttpHeaders.WWW_AUTHENTICATE, NEGOTIATE);<a name="line.119"></a> +<span class="sourceLineNo">120</span> response.sendError(HttpServletResponse.SC_UNAUTHORIZED,<a name="line.120"></a> +<span class="sourceLineNo">121</span> "Authentication Error: " + e.getMessage());<a name="line.121"></a> +<span class="sourceLineNo">122</span> return;<a name="line.122"></a> +<span class="sourceLineNo">123</span> }<a name="line.123"></a> +<span class="sourceLineNo">124</span> }<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> if(effectiveUser == null) {<a name="line.126"></a> +<span class="sourceLineNo">127</span> effectiveUser = serviceUGI.getShortUserName();<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> String doAsUserFromQuery = request.getHeader("doAs");<a name="line.130"></a> +<span class="sourceLineNo">131</span> if (doAsUserFromQuery != null) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> if (!doAsEnabled) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> throw new ServletException("Support for proxyuser is not configured");<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">135</span> // The authenticated remote user is attempting to perform 'doAs' proxy user.<a name="line.135"></a> +<span class="sourceLineNo">136</span> UserGroupInformation remoteUser = UserGroupInformation.createRemoteUser(effectiveUser);<a name="line.136"></a> +<span class="sourceLineNo">137</span> // create and attempt to authorize a proxy user (the client is attempting<a name="line.137"></a> +<span class="sourceLineNo">138</span> // to do proxy user)<a name="line.138"></a> +<span class="sourceLineNo">139</span> UserGroupInformation ugi = UserGroupInformation.createProxyUser(doAsUserFromQuery,<a name="line.139"></a> +<span class="sourceLineNo">140</span> remoteUser);<a name="line.140"></a> +<span class="sourceLineNo">141</span> // validate the proxy user authorization<a name="line.141"></a> +<span class="sourceLineNo">142</span> try {<a name="line.142"></a> +<span class="sourceLineNo">143</span> ProxyUsers.authorize(ugi, request.getRemoteAddr());<a name="line.143"></a> +<span class="sourceLineNo">144</span> } catch (AuthorizationException e) {<a name="line.144"></a> +<span class="sourceLineNo">145</span> throw new ServletException(e);<a name="line.145"></a> +<span class="sourceLineNo">146</span> }<a name="line.146"></a> +<span class="sourceLineNo">147</span> effectiveUser = doAsUserFromQuery;<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span> hbaseHandler.setEffectiveUser(effectiveUser);<a name="line.149"></a> +<span class="sourceLineNo">150</span> super.doPost(request, response);<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> /**<a name="line.153"></a> +<span class="sourceLineNo">154</span> * Do the GSS-API kerberos authentication.<a name="line.154"></a> +<span class="sourceLineNo">155</span> * We already have a logged in subject in the form of httpUGI,<a name="line.155"></a> +<span class="sourceLineNo">156</span> * which GSS-API will extract information from.<a name="line.156"></a> +<span class="sourceLineNo">157</span> */<a name="line.157"></a> +<span class="sourceLineNo">158</span> private RemoteUserIdentity doKerberosAuth(HttpServletRequest request)<a name="line.158"></a> +<span class="sourceLineNo">159</span> throws HttpAuthenticationException {<a name="line.159"></a> +<span class="sourceLineNo">160</span> HttpKerberosServerAction action = new HttpKerberosServerAction(request, httpUGI);<a name="line.160"></a> +<span class="sourceLineNo">161</span> try {<a name="line.161"></a> +<span class="sourceLineNo">162</span> String principal = httpUGI.doAs(action);<a name="line.162"></a> +<span class="sourceLineNo">163</span> return new RemoteUserIdentity(principal, action.outToken);<a name="line.163"></a> +<span class="sourceLineNo">164</span> } catch (Exception e) {<a name="line.164"></a> +<span class="sourceLineNo">165</span> LOG.info("Failed to authenticate with {} kerberos principal", httpUGI.getUserName());<a name="line.165"></a> +<span class="sourceLineNo">166</span> throw new HttpAuthenticationException(e);<a name="line.166"></a> +<span class="sourceLineNo">167</span> }<a name="line.167"></a> +<span class="sourceLineNo">168</span> }<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> /**<a name="line.170"></a> +<span class="sourceLineNo">171</span> * Basic "struct" class to hold the final base64-encoded, authenticated GSSAPI token<a name="line.171"></a> +<span class="sourceLineNo">172</span> * for the user with the given principal talking to the Thrift server.<a name="line.172"></a> +<span class="sourceLineNo">173</span> */<a name="line.173"></a> +<span class="sourceLineNo">174</span> private static class RemoteUserIdentity {<a name="line.174"></a> +<span class="sourceLineNo">175</span> final String outToken;<a name="line.175"></a> +<span class="sourceLineNo">176</span> final String principal;<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> RemoteUserIdentity(String principal, String outToken) {<a name="line.178"></a> +<span class="sourceLineNo">179</span> this.principal = principal;<a name="line.179"></a> +<span class="sourceLineNo">180</span> this.outToken = outToken;<a name="line.180"></a> +<span class="sourceLineNo">181</span> }<a name="line.181"></a> +<span class="sourceLineNo">182</span> }<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> private static class HttpKerberosServerAction implements PrivilegedExceptionAction<String> {<a name="line.184"></a> +<span class="sourceLineNo">185</span> final HttpServletRequest request;<a name="line.185"></a> +<span class="sourceLineNo">186</span> final UserGroupInformation httpUGI;<a name="line.186"></a> +<span class="sourceLineNo">187</span> String outToken = null;<a name="line.187"></a> +<span class="sourceLineNo">188</span> HttpKerberosServerAction(HttpServletRequest request, UserGroupInformation httpUGI) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> this.request = request;<a name="line.189"></a> +<span class="sourceLineNo">190</span> this.httpUGI = httpUGI;<a name="line.190"></a> +<span class="sourceLineNo">191</span> }<a name="line.191"></a> +<span class="sourceLineNo">192</span><a name="line.192"></a> +<span class="sourceLineNo">193</span> @Override<a name="line.193"></a> +<span class="sourceLineNo">194</span> public String run() throws HttpAuthenticationException {<a name="line.194"></a> +<span class="sourceLineNo">195</span> // Get own Kerberos credentials for accepting connection<a name="line.195"></a> +<span class="sourceLineNo">196</span> GSSManager manager = GSSManager.getInstance();<a name="line.196"></a> +<span class="sourceLineNo">197</span> GSSContext gssContext = null;<a name="line.197"></a> +<span class="sourceLineNo">198</span> String serverPrincipal = SecurityUtil.getPrincipalWithoutRealm(httpUGI.getUserName());<a name="line.198"></a> +<span class="sourceLineNo">199</span> try {<a name="line.199"></a> +<span class="sourceLineNo">200</span> // This Oid for Kerberos GSS-API mechanism.<a name="line.200"></a> +<span class="sourceLineNo">201</span> Oid kerberosMechOid = new Oid("1.2.840.113554.1.2.2");<a name="line.201"></a> +<span class="sourceLineNo">202</span> // Oid for SPNego GSS-API mechanism.<a name="line.202"></a> +<span class="sourceLineNo">203</span> Oid spnegoMechOid = new Oid("1.3.6.1.5.5.2");<a name="line.203"></a> +<span class="sourceLineNo">204</span> // Oid for kerberos principal name<a name="line.204"></a> +<span class="sourceLineNo">205</span> Oid krb5PrincipalOid = new Oid("1.2.840.113554.1.2.2.1");<a name="line.205"></a> +<span class="sourceLineNo">206</span> // GSS name for server<a name="line.206"></a> +<span class="sourceLineNo">207</span> GSSName serverName = manager.createName(serverPrincipal, krb5PrincipalOid);<a name="line.207"></a> +<span class="sourceLineNo">208</span> // GSS credentials for server<a name="line.208"></a> +<span class="sourceLineNo">209</span> GSSCredential serverCreds = manager.createCredential(serverName,<a name="line.209"></a> +<span class="sourceLineNo">210</span> GSSCredential.DEFAULT_LIFETIME,<a name="line.210"></a> +<span class="sourceLineNo">211</span> new Oid[]{kerberosMechOid, spnegoMechOid},<a name="line.211"></a> +<span class="sourceLineNo">212</span> GSSCredential.ACCEPT_ONLY);<a name="line.212"></a> +<span class="sourceLineNo">213</span> // Create a GSS context<a name="line.213"></a> +<span class="sourceLineNo">214</span> gssContext = manager.createContext(serverCreds);<a name="line.214"></a> +<span class="sourceLineNo">215</span> // Get service ticket from the authorization header<a name="line.215"></a> +<span class="sourceLineNo">216</span> String serviceTicketBase64 = getAuthHeader(request);<a name="line.216"></a> +<span class="sourceLineNo">217</span> byte[] inToken = Base64.decode(serviceTicketBase64);<a name="line.217"></a> +<span class="sourceLineNo">218</span> byte[] res = gssContext.acceptSecContext(inToken, 0, inToken.length);<a name="line.218"></a> +<span class="sourceLineNo">219</span> if(res != null) {<a name="line.219"></a> +<span class="sourceLineNo">220</span> outToken = Base64.encodeBytes(res).replace("\n", "");<a name="line.220"></a> +<span class="sourceLineNo">221</span> }<a name="line.221"></a> +<span class="sourceLineNo">222</span> // Authenticate or deny based on its context completion<a name="line.222"></a> +<span class="sourceLineNo">223</span> if (!gssContext.isEstablished()) {<a name="line.223"></a> +<span class="sourceLineNo">224</span> throw new HttpAuthenticationException("Kerberos authentication failed: " +<a name="line.224"></a> +<span class="sourceLineNo">225</span> "unable to establish context with the service ticket " +<a name="line.225"></a> +<span class="sourceLineNo">226</span> "provided by the client.");<a name="line.226"></a> +<span class="sourceLineNo">227</span> }<a name="line.227"></a> +<span class="sourceLineNo">228</span> return SecurityUtil.getUserFromPrincipal(gssContext.getSrcName().toString());<a name="line.228"></a> +<span class="sourceLineNo">229</span> } catch (GSSException e) {<a name="line.229"></a> +<span class="sourceLineNo">230</span> throw new HttpAuthenticationException("Kerberos authentication failed: ", e);<a name="line.230"></a> +<span class="sourceLineNo">231</span> } finally {<a name="line.231"></a> +<span class="sourceLineNo">232</span> if (gssContext != null) {<a name="line.232"></a> +<span class="sourceLineNo">233</span> try {<a name="line.233"></a> +<span class="sourceLineNo">234</span> gssContext.dispose();<a name="line.234"></a> +<span class="sourceLineNo">235</span> } catch (GSSException e) {<a name="line.235"></a> +<span class="sourceLineNo">236</span> LOG.warn("Error while disposing GSS Context", e);<a name="line.236"></a> +<span class="sourceLineNo">237</span> }<a name="line.237"></a> +<span class="sourceLineNo">238</span> }<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<a name="line.239"></a> +<span class="sourceLineNo">240</span> }<a name="line.240"></a> +<span class="sourceLineNo">241</span><a name="line.241"></a> +<span class="sourceLineNo">242</span> /**<a name="line.242"></a> +<span class="sourceLineNo">243</span> * Returns the base64 encoded auth header payload<a name="line.243"></a> +<span class="sourceLineNo">244</span> *<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @throws HttpAuthenticationException if a remote or network exception occurs<a name="line.245"></a> +<span class="sourceLineNo">246</span> */<a name="line.246"></a> +<span class="sourceLineNo">247</span> private String getAuthHeader(HttpServletRequest request)<a name="line.247"></a> +<span class="sourceLineNo">248</span> throws HttpAuthenticationException {<a name="line.248"></a> +<span class="sourceLineNo">249</span> String authHeader = request.getHeader(HttpHeaders.AUTHORIZATION);<a name="line.249"></a> +<span class="sourceLineNo">250</span> // Each http request must have an Authorization header<a name="line.250"></a> +<span class="sourceLineNo">251</span> if (authHeader == null || authHeader.isEmpty()) {<a name="line.251"></a> +<span class="sourceLineNo">252</span> throw new HttpAuthenticationException("Authorization header received " +<a name="line.252"></a> +<span class="sourceLineNo">253</span> "from the client is empty.");<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span> String authHeaderBase64String;<a name="line.255"></a> +<span class="sourceLineNo">256</span> int beginIndex = (NEGOTIATE + " ").length();<a name="line.256"></a> +<span class="sourceLineNo">257</span> authHeaderBase64String = authHeader.substring(beginIndex);<a name="line.257"></a> +<span class="sourceLineNo">258</span> // Authorization header must have a payload<a name="line.258"></a> +<span class="sourceLineNo">259</span> if (authHeaderBase64String.isEmpty()) {<a name="line.259"></a> +<span class="sourceLineNo">260</span> throw new HttpAuthenticationException("Authorization header received " +<a name="line.260"></a> +<span class="sourceLineNo">261</span> "from the client does not contain any data.");<a name="line.261"></a> +<span class="sourceLineNo">262</span> }<a name="line.262"></a> +<span class="sourceLineNo">263</span> return authHeaderBase64String;<a name="line.263"></a> +<span class="sourceLineNo">264</span> }<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>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/78d8c5d7/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftServer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftServer.html b/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftServer.html index b00faf2..3d5d8b7 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftServer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/thrift/ThriftServer.html @@ -60,186 +60,188 @@ <span class="sourceLineNo">052</span> static final String COMPACT_OPTION = "compact";<a name="line.52"></a> <span class="sourceLineNo">053</span> static final String FRAMED_OPTION = "framed";<a name="line.53"></a> <span class="sourceLineNo">054</span> static final String PORT_OPTION = "port";<a name="line.54"></a> -<span class="sourceLineNo">055</span><a name="line.55"></a> -<span class="sourceLineNo">056</span> private static final String DEFAULT_BIND_ADDR = "0.0.0.0";<a name="line.56"></a> -<span class="sourceLineNo">057</span> private static final int DEFAULT_LISTEN_PORT = 9090;<a name="line.57"></a> -<span class="sourceLineNo">058</span><a name="line.58"></a> -<span class="sourceLineNo">059</span> private Configuration conf;<a name="line.59"></a> -<span class="sourceLineNo">060</span> ThriftServerRunner serverRunner;<a name="line.60"></a> -<span class="sourceLineNo">061</span><a name="line.61"></a> -<span class="sourceLineNo">062</span> private InfoServer infoServer;<a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> -<span class="sourceLineNo">064</span> private static final String READ_TIMEOUT_OPTION = "readTimeout";<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> //<a name="line.66"></a> -<span class="sourceLineNo">067</span> // Main program and support routines<a name="line.67"></a> -<span class="sourceLineNo">068</span> //<a name="line.68"></a> -<span class="sourceLineNo">069</span><a name="line.69"></a> -<span class="sourceLineNo">070</span> public ThriftServer(Configuration conf) {<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.conf = HBaseConfiguration.create(conf);<a name="line.71"></a> -<span class="sourceLineNo">072</span> }<a name="line.72"></a> -<span class="sourceLineNo">073</span><a name="line.73"></a> -<span class="sourceLineNo">074</span> private static void printUsageAndExit(Options options, int exitCode)<a name="line.74"></a> -<span class="sourceLineNo">075</span> throws ExitCodeException {<a name="line.75"></a> -<span class="sourceLineNo">076</span> HelpFormatter formatter = new HelpFormatter();<a name="line.76"></a> -<span class="sourceLineNo">077</span> formatter.printHelp("Thrift", null, options,<a name="line.77"></a> -<span class="sourceLineNo">078</span> "To start the Thrift server run 'hbase-daemon.sh start thrift' or " +<a name="line.78"></a> -<span class="sourceLineNo">079</span> "'hbase thrift'\n" +<a name="line.79"></a> -<span class="sourceLineNo">080</span> "To shutdown the thrift server run 'hbase-daemon.sh stop " +<a name="line.80"></a> -<span class="sourceLineNo">081</span> "thrift' or send a kill signal to the thrift server pid",<a name="line.81"></a> -<span class="sourceLineNo">082</span> true);<a name="line.82"></a> -<span class="sourceLineNo">083</span> throw new ExitCodeException(exitCode, "");<a name="line.83"></a> -<span class="sourceLineNo">084</span> }<a name="line.84"></a> -<span class="sourceLineNo">085</span><a name="line.85"></a> -<span class="sourceLineNo">086</span> /**<a name="line.86"></a> -<span class="sourceLineNo">087</span> * Start up or shuts down the Thrift server, depending on the arguments.<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param args the arguments to pass in when starting the Thrift server<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> void doMain(final String[] args) throws Exception {<a name="line.90"></a> -<span class="sourceLineNo">091</span> processOptions(args);<a name="line.91"></a> -<span class="sourceLineNo">092</span> serverRunner = new ThriftServerRunner(conf);<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> // Put up info server.<a name="line.94"></a> -<span class="sourceLineNo">095</span> int port = conf.getInt("hbase.thrift.info.port", 9095);<a name="line.95"></a> -<span class="sourceLineNo">096</span><a name="line.96"></a> -<span class="sourceLineNo">097</span> if (port >= 0) {<a name="line.97"></a> -<span class="sourceLineNo">098</span> conf.setLong("startcode", System.currentTimeMillis());<a name="line.98"></a> -<span class="sourceLineNo">099</span> String a = conf.get("hbase.thrift.info.bindAddress", "0.0.0.0");<a name="line.99"></a> -<span class="sourceLineNo">100</span> infoServer = new InfoServer("thrift", a, port, false, conf);<a name="line.100"></a> -<span class="sourceLineNo">101</span> infoServer.setAttribute("hbase.conf", conf);<a name="line.101"></a> -<span class="sourceLineNo">102</span> infoServer.start();<a name="line.102"></a> -<span class="sourceLineNo">103</span> }<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> serverRunner.run();<a name="line.105"></a> -<span class="sourceLineNo">106</span> }<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> /**<a name="line.108"></a> -<span class="sourceLineNo">109</span> * Parse the command line options to set parameters the conf.<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> private void processOptions(final String[] args) throws Exception {<a name="line.111"></a> -<span class="sourceLineNo">112</span> Options options = new Options();<a name="line.112"></a> -<span class="sourceLineNo">113</span> options.addOption("b", BIND_OPTION, true, "Address to bind " +<a name="line.113"></a> -<span class="sourceLineNo">114</span> "the Thrift server to. [default: " + DEFAULT_BIND_ADDR + "]");<a name="line.114"></a> -<span class="sourceLineNo">115</span> options.addOption("p", PORT_OPTION, true, "Port to bind to [default: " +<a name="line.115"></a> -<span class="sourceLineNo">116</span> DEFAULT_LISTEN_PORT + "]");<a name="line.116"></a> -<span class="sourceLineNo">117</span> options.addOption("f", FRAMED_OPTION, false, "Use framed transport");<a name="line.117"></a> -<span class="sourceLineNo">118</span> options.addOption("c", COMPACT_OPTION, false, "Use the compact protocol");<a name="line.118"></a> -<span class="sourceLineNo">119</span> options.addOption("h", "help", false, "Print help information");<a name="line.119"></a> -<span class="sourceLineNo">120</span> options.addOption(null, "infoport", true, "Port for web UI");<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> options.addOption("m", MIN_WORKERS_OPTION, true,<a name="line.122"></a> -<span class="sourceLineNo">123</span> "The minimum number of worker threads for " +<a name="line.123"></a> -<span class="sourceLineNo">124</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.124"></a> -<span class="sourceLineNo">125</span><a name="line.125"></a> -<span class="sourceLineNo">126</span> options.addOption("w", MAX_WORKERS_OPTION, true,<a name="line.126"></a> -<span class="sourceLineNo">127</span> "The maximum number of worker threads for " +<a name="line.127"></a> -<span class="sourceLineNo">128</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> -<span class="sourceLineNo">130</span> options.addOption("q", MAX_QUEUE_SIZE_OPTION, true,<a name="line.130"></a> -<span class="sourceLineNo">131</span> "The maximum number of queued requests in " +<a name="line.131"></a> -<span class="sourceLineNo">132</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> options.addOption("k", KEEP_ALIVE_SEC_OPTION, true,<a name="line.134"></a> -<span class="sourceLineNo">135</span> "The amount of time in secods to keep a thread alive when idle in " +<a name="line.135"></a> -<span class="sourceLineNo">136</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.136"></a> -<span class="sourceLineNo">137</span><a name="line.137"></a> -<span class="sourceLineNo">138</span> options.addOption("t", READ_TIMEOUT_OPTION, true,<a name="line.138"></a> -<span class="sourceLineNo">139</span> "Amount of time in milliseconds before a server thread will timeout " +<a name="line.139"></a> -<span class="sourceLineNo">140</span> "waiting for client to send data on a connected socket. Currently, " +<a name="line.140"></a> -<span class="sourceLineNo">141</span> "only applies to TBoundedThreadPoolServer");<a name="line.141"></a> -<span class="sourceLineNo">142</span><a name="line.142"></a> -<span class="sourceLineNo">143</span> options.addOptionGroup(ImplType.createOptionGroup());<a name="line.143"></a> -<span class="sourceLineNo">144</span><a name="line.144"></a> -<span class="sourceLineNo">145</span> CommandLineParser parser = new DefaultParser();<a name="line.145"></a> -<span class="sourceLineNo">146</span> CommandLine cmd = parser.parse(options, args);<a name="line.146"></a> -<span class="sourceLineNo">147</span><a name="line.147"></a> -<span class="sourceLineNo">148</span> if (cmd.hasOption("help")) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> printUsageAndExit(options, 1);<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span><a name="line.151"></a> -<span class="sourceLineNo">152</span> // Get port to bind to<a name="line.152"></a> -<span class="sourceLineNo">153</span> try {<a name="line.153"></a> -<span class="sourceLineNo">154</span> if (cmd.hasOption(PORT_OPTION)) {<a name="line.154"></a> -<span class="sourceLineNo">155</span> int listenPort = Integer.parseInt(cmd.getOptionValue(PORT_OPTION));<a name="line.155"></a> -<span class="sourceLineNo">156</span> conf.setInt(ThriftServerRunner.PORT_CONF_KEY, listenPort);<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<a name="line.157"></a> -<span class="sourceLineNo">158</span> } catch (NumberFormatException e) {<a name="line.158"></a> -<span class="sourceLineNo">159</span> LOG.error("Could not parse the value provided for the port option", e);<a name="line.159"></a> -<span class="sourceLineNo">160</span> printUsageAndExit(options, -1);<a name="line.160"></a> -<span class="sourceLineNo">161</span> }<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> // check for user-defined info server port setting, if so override the conf<a name="line.163"></a> -<span class="sourceLineNo">164</span> try {<a name="line.164"></a> -<span class="sourceLineNo">165</span> if (cmd.hasOption("infoport")) {<a name="line.165"></a> -<span class="sourceLineNo">166</span> String val = cmd.getOptionValue("infoport");<a name="line.166"></a> -<span class="sourceLineNo">167</span> conf.setInt("hbase.thrift.info.port", Integer.parseInt(val));<a name="line.167"></a> -<span class="sourceLineNo">168</span> LOG.debug("Web UI port set to " + val);<a name="line.168"></a> -<span class="sourceLineNo">169</span> }<a name="line.169"></a> -<span class="sourceLineNo">170</span> } catch (NumberFormatException e) {<a name="line.170"></a> -<span class="sourceLineNo">171</span> LOG.error("Could not parse the value provided for the infoport option", e);<a name="line.171"></a> -<span class="sourceLineNo">172</span> printUsageAndExit(options, -1);<a name="line.172"></a> -<span class="sourceLineNo">173</span> }<a name="line.173"></a> -<span class="sourceLineNo">174</span><a name="line.174"></a> -<span class="sourceLineNo">175</span> // Make optional changes to the configuration based on command-line options<a name="line.175"></a> -<span class="sourceLineNo">176</span> optionToConf(cmd, MIN_WORKERS_OPTION,<a name="line.176"></a> -<span class="sourceLineNo">177</span> conf, TBoundedThreadPoolServer.MIN_WORKER_THREADS_CONF_KEY);<a name="line.177"></a> -<span class="sourceLineNo">178</span> optionToConf(cmd, MAX_WORKERS_OPTION,<a name="line.178"></a> -<span class="sourceLineNo">179</span> conf, TBoundedThreadPoolServer.MAX_WORKER_THREADS_CONF_KEY);<a name="line.179"></a> -<span class="sourceLineNo">180</span> optionToConf(cmd, MAX_QUEUE_SIZE_OPTION,<a name="line.180"></a> -<span class="sourceLineNo">181</span> conf, TBoundedThreadPoolServer.MAX_QUEUED_REQUESTS_CONF_KEY);<a name="line.181"></a> -<span class="sourceLineNo">182</span> optionToConf(cmd, KEEP_ALIVE_SEC_OPTION,<a name="line.182"></a> -<span class="sourceLineNo">183</span> conf, TBoundedThreadPoolServer.THREAD_KEEP_ALIVE_TIME_SEC_CONF_KEY);<a name="line.183"></a> -<span class="sourceLineNo">184</span> optionToConf(cmd, READ_TIMEOUT_OPTION, conf,<a name="line.184"></a> -<span class="sourceLineNo">185</span> ThriftServerRunner.THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY);<a name="line.185"></a> -<span class="sourceLineNo">186</span><a name="line.186"></a> -<span class="sourceLineNo">187</span> // Set general thrift server options<a name="line.187"></a> -<span class="sourceLineNo">188</span> boolean compact = cmd.hasOption(COMPACT_OPTION) ||<a name="line.188"></a> -<span class="sourceLineNo">189</span> conf.getBoolean(ThriftServerRunner.COMPACT_CONF_KEY, false);<a name="line.189"></a> -<span class="sourceLineNo">190</span> conf.setBoolean(ThriftServerRunner.COMPACT_CONF_KEY, compact);<a name="line.190"></a> -<span class="sourceLineNo">191</span> boolean framed = cmd.hasOption(FRAMED_OPTION) ||<a name="line.191"></a> -<span class="sourceLineNo">192</span> conf.getBoolean(ThriftServerRunner.FRAMED_CONF_KEY, false);<a name="line.192"></a> -<span class="sourceLineNo">193</span> conf.setBoolean(ThriftServerRunner.FRAMED_CONF_KEY, framed);<a name="line.193"></a> -<span class="sourceLineNo">194</span> if (cmd.hasOption(BIND_OPTION)) {<a name="line.194"></a> -<span class="sourceLineNo">195</span> conf.set(ThriftServerRunner.BIND_CONF_KEY, cmd.getOptionValue(BIND_OPTION));<a name="line.195"></a> -<span class="sourceLineNo">196</span> }<a name="line.196"></a> -<span class="sourceLineNo">197</span><a name="line.197"></a> -<span class="sourceLineNo">198</span> ImplType.setServerImpl(cmd, conf);<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> public void stop() {<a name="line.201"></a> -<span class="sourceLineNo">202</span> if (this.infoServer != null) {<a name="line.202"></a> -<span class="sourceLineNo">203</span> LOG.info("Stopping infoServer");<a name="line.203"></a> -<span class="sourceLineNo">204</span> try {<a name="line.204"></a> -<span class="sourceLineNo">205</span> this.infoServer.stop();<a name="line.205"></a> -<span class="sourceLineNo">206</span> } catch (Exception ex) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> ex.printStackTrace();<a name="line.207"></a> -<span class="sourceLineNo">208</span> }<a name="line.208"></a> -<span class="sourceLineNo">209</span> }<a name="line.209"></a> -<span class="sourceLineNo">210</span> serverRunner.shutdown();<a name="line.210"></a> -<span class="sourceLineNo">211</span> }<a name="line.211"></a> -<span class="sourceLineNo">212</span><a name="line.212"></a> -<span class="sourceLineNo">213</span> private static void optionToConf(CommandLine cmd, String option,<a name="line.213"></a> -<span class="sourceLineNo">214</span> Configuration conf, String destConfKey) {<a name="line.214"></a> -<span class="sourceLineNo">215</span> if (cmd.hasOption(option)) {<a name="line.215"></a> -<span class="sourceLineNo">216</span> String value = cmd.getOptionValue(option);<a name="line.216"></a> -<span class="sourceLineNo">217</span> LOG.info("Set configuration key:" + destConfKey + " value:" + value);<a name="line.217"></a> -<span class="sourceLineNo">218</span> conf.set(destConfKey, value);<a name="line.218"></a> -<span class="sourceLineNo">219</span> }<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<a name="line.220"></a> -<span class="sourceLineNo">221</span><a name="line.221"></a> -<span class="sourceLineNo">222</span> public static void main(String [] args) throws Exception {<a name="line.222"></a> -<span class="sourceLineNo">223</span> LOG.info("***** STARTING service '" + ThriftServer.class.getSimpleName() + "' *****");<a name="line.223"></a> -<span class="sourceLineNo">224</span> VersionInfo.logVersion();<a name="line.224"></a> -<span class="sourceLineNo">225</span> int exitCode = 0;<a name="line.225"></a> -<span class="sourceLineNo">226</span> try {<a name="line.226"></a> -<span class="sourceLineNo">227</span> new ThriftServer(HBaseConfiguration.create()).doMain(args);<a name="line.227"></a> -<span class="sourceLineNo">228</span> } catch (ExitCodeException ex) {<a name="line.228"></a> -<span class="sourceLineNo">229</span> exitCode = ex.getExitCode();<a name="line.229"></a> -<span class="sourceLineNo">230</span> }<a name="line.230"></a> -<span class="sourceLineNo">231</span> LOG.info("***** STOPPING service '" + ThriftServer.class.getSimpleName() + "' *****");<a name="line.231"></a> -<span class="sourceLineNo">232</span> System.exit(exitCode);<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> -<span class="sourceLineNo">234</span>}<a name="line.234"></a> +<span class="sourceLineNo">055</span> static final String INFOPORT_OPTION = "infoport";<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> private static final String DEFAULT_BIND_ADDR = "0.0.0.0";<a name="line.57"></a> +<span class="sourceLineNo">058</span> private static final int DEFAULT_LISTEN_PORT = 9090;<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> private Configuration conf;<a name="line.60"></a> +<span class="sourceLineNo">061</span> ThriftServerRunner serverRunner;<a name="line.61"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> private InfoServer infoServer;<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> private static final String READ_TIMEOUT_OPTION = "readTimeout";<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> //<a name="line.67"></a> +<span class="sourceLineNo">068</span> // Main program and support routines<a name="line.68"></a> +<span class="sourceLineNo">069</span> //<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> public ThriftServer(Configuration conf) {<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.conf = HBaseConfiguration.create(conf);<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> private static void printUsageAndExit(Options options, int exitCode)<a name="line.75"></a> +<span class="sourceLineNo">076</span> throws ExitCodeException {<a name="line.76"></a> +<span class="sourceLineNo">077</span> HelpFormatter formatter = new HelpFormatter();<a name="line.77"></a> +<span class="sourceLineNo">078</span> formatter.printHelp("Thrift", null, options,<a name="line.78"></a> +<span class="sourceLineNo">079</span> "To start the Thrift server run 'hbase-daemon.sh start thrift' or " +<a name="line.79"></a> +<span class="sourceLineNo">080</span> "'hbase thrift'\n" +<a name="line.80"></a> +<span class="sourceLineNo">081</span> "To shutdown the thrift server run 'hbase-daemon.sh stop " +<a name="line.81"></a> +<span class="sourceLineNo">082</span> "thrift' or send a kill signal to the thrift server pid",<a name="line.82"></a> +<span class="sourceLineNo">083</span> true);<a name="line.83"></a> +<span class="sourceLineNo">084</span> throw new ExitCodeException(exitCode, "");<a name="line.84"></a> +<span class="sourceLineNo">085</span> }<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> * Start up or shuts down the Thrift server, depending on the arguments.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param args the arguments to pass in when starting the Thrift server<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> void doMain(final String[] args) throws Exception {<a name="line.91"></a> +<span class="sourceLineNo">092</span> processOptions(args);<a name="line.92"></a> +<span class="sourceLineNo">093</span> serverRunner = new ThriftServerRunner(conf);<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> // Put up info server.<a name="line.95"></a> +<span class="sourceLineNo">096</span> int port = conf.getInt("hbase.thrift.info.port", 9095);<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> if (port >= 0) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> conf.setLong("startcode", System.currentTimeMillis());<a name="line.99"></a> +<span class="sourceLineNo">100</span> String a = conf.get("hbase.thrift.info.bindAddress", "0.0.0.0");<a name="line.100"></a> +<span class="sourceLineNo">101</span> infoServer = new InfoServer("thrift", a, port, false, conf);<a name="line.101"></a> +<span class="sourceLineNo">102</span> infoServer.setAttribute("hbase.conf", conf);<a name="line.102"></a> +<span class="sourceLineNo">103</span> infoServer.start();<a name="line.103"></a> +<span class="sourceLineNo">104</span> }<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> serverRunner.run();<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<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> * Parse the command line options to set parameters the conf.<a name="line.110"></a> +<span class="sourceLineNo">111</span> */<a name="line.111"></a> +<span class="sourceLineNo">112</span> private void processOptions(final String[] args) throws Exception {<a name="line.112"></a> +<span class="sourceLineNo">113</span> Options options = new Options();<a name="line.113"></a> +<span class="sourceLineNo">114</span> options.addOption("b", BIND_OPTION, true, "Address to bind " +<a name="line.114"></a> +<span class="sourceLineNo">115</span> "the Thrift server to. [default: " + DEFAULT_BIND_ADDR + "]");<a name="line.115"></a> +<span class="sourceLineNo">116</span> options.addOption("p", PORT_OPTION, true, "Port to bind to [default: " +<a name="line.116"></a> +<span class="sourceLineNo">117</span> DEFAULT_LISTEN_PORT + "]");<a name="line.117"></a> +<span class="sourceLineNo">118</span> options.addOption("f", FRAMED_OPTION, false, "Use framed transport");<a name="line.118"></a> +<span class="sourceLineNo">119</span> options.addOption("c", COMPACT_OPTION, false, "Use the compact protocol");<a name="line.119"></a> +<span class="sourceLineNo">120</span> options.addOption("h", "help", false, "Print help information");<a name="line.120"></a> +<span class="sourceLineNo">121</span> options.addOption(null, INFOPORT_OPTION, true, "Port for web UI");<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> options.addOption("m", MIN_WORKERS_OPTION, true,<a name="line.123"></a> +<span class="sourceLineNo">124</span> "The minimum number of worker threads for " +<a name="line.124"></a> +<span class="sourceLineNo">125</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> options.addOption("w", MAX_WORKERS_OPTION, true,<a name="line.127"></a> +<span class="sourceLineNo">128</span> "The maximum number of worker threads for " +<a name="line.128"></a> +<span class="sourceLineNo">129</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.129"></a> +<span class="sourceLineNo">130</span><a name="line.130"></a> +<span class="sourceLineNo">131</span> options.addOption("q", MAX_QUEUE_SIZE_OPTION, true,<a name="line.131"></a> +<span class="sourceLineNo">132</span> "The maximum number of queued requests in " +<a name="line.132"></a> +<span class="sourceLineNo">133</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> options.addOption("k", KEEP_ALIVE_SEC_OPTION, true,<a name="line.135"></a> +<span class="sourceLineNo">136</span> "The amount of time in secods to keep a thread alive when idle in " +<a name="line.136"></a> +<span class="sourceLineNo">137</span> ImplType.THREAD_POOL.simpleClassName());<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> options.addOption("t", READ_TIMEOUT_OPTION, true,<a name="line.139"></a> +<span class="sourceLineNo">140</span> "Amount of time in milliseconds before a server thread will timeout " +<a name="line.140"></a> +<span class="sourceLineNo">141</span> "waiting for client to send data on a connected socket. Currently, " +<a name="line.141"></a> +<span class="sourceLineNo">142</span> "only applies to TBoundedThreadPoolServer");<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> options.addOptionGroup(ImplType.createOptionGroup());<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> CommandLineParser parser = new DefaultParser();<a name="line.146"></a> +<span class="sourceLineNo">147</span> CommandLine cmd = parser.parse(options, args);<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> if (cmd.hasOption("help")) {<a name="line.149"></a> +<span class="sourceLineNo">150</span> printUsageAndExit(options, 1);<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span><a name="line.152"></a> +<span class="sourceLineNo">153</span> // Get port to bind to<a name="line.153"></a> +<span class="sourceLineNo">154</span> try {<a name="line.154"></a> +<span class="sourceLineNo">155</span> if (cmd.hasOption(PORT_OPTION)) {<a name="line.155"></a> +<span class="sourceLineNo">156</span> int listenPort = Integer.parseInt(cmd.getOptionValue(PORT_OPTION));<a name="line.156"></a> +<span class="sourceLineNo">157</span> conf.setInt(ThriftServerRunner.PORT_CONF_KEY, listenPort);<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span> } catch (NumberFormatException e) {<a name="line.159"></a> +<span class="sourceLineNo">160</span> LOG.error("Could not parse the value provided for the port option", e);<a name="line.160"></a> +<span class="sourceLineNo">161</span> printUsageAndExit(options, -1);<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> // check for user-defined info server port setting, if so override the conf<a name="line.164"></a> +<span class="sourceLineNo">165</span> try {<a name="line.165"></a> +<span class="sourceLineNo">166</span> if (cmd.hasOption(INFOPORT_OPTION)) {<a name="line.166"></a> +<span class="sourceLineNo">167</span> String val = cmd.getOptionValue(INFOPORT_OPTION);<a name="line.167"></a> +<span class="sourceLineNo">168</span> conf.setInt("hbase.thrift.info.port", Integer.parseInt(val));<a name="line.168"></a> +<span class="sourceLineNo">169</span> LOG.debug("Web UI port set to " + val);<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span> } catch (NumberFormatException e) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> LOG.error("Could not parse the value provided for the " + INFOPORT_OPTION +<a name="line.172"></a> +<span class="sourceLineNo">173</span> " option", e);<a name="line.173"></a> +<span class="sourceLineNo">174</span> printUsageAndExit(options, -1);<a name="line.174"></a> +<span class="sourceLineNo">175</span> }<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> // Make optional changes to the configuration based on command-line options<a name="line.177"></a> +<span class="sourceLineNo">178</span> optionToConf(cmd, MIN_WORKERS_OPTION,<a name="line.178"></a> +<span class="sourceLineNo">179</span> conf, TBoundedThreadPoolServer.MIN_WORKER_THREADS_CONF_KEY);<a name="line.179"></a> +<span class="sourceLineNo">180</span> optionToConf(cmd, MAX_WORKERS_OPTION,<a name="line.180"></a> +<span class="sourceLineNo">181</span> conf, TBoundedThreadPoolServer.MAX_WORKER_THREADS_CONF_KEY);<a name="line.181"></a> +<span class="sourceLineNo">182</span> optionToConf(cmd, MAX_QUEUE_SIZE_OPTION,<a name="line.182"></a> +<span class="sourceLineNo">183</span> conf, TBoundedThreadPoolServer.MAX_QUEUED_REQUESTS_CONF_KEY);<a name="line.183"></a> +<span class="sourceLineNo">184</span> optionToConf(cmd, KEEP_ALIVE_SEC_OPTION,<a name="line.184"></a> +<span class="sourceLineNo">185</span> conf, TBoundedThreadPoolServer.THREAD_KEEP_ALIVE_TIME_SEC_CONF_KEY);<a name="line.185"></a> +<span class="sourceLineNo">186</span> optionToConf(cmd, READ_TIMEOUT_OPTION, conf,<a name="line.186"></a> +<span class="sourceLineNo">187</span> ThriftServerRunner.THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY);<a name="line.187"></a> +<span class="sourceLineNo">188</span><a name="line.188"></a> +<span class="sourceLineNo">189</span> // Set general thrift server options<a name="line.189"></a> +<span class="sourceLineNo">190</span> boolean compact = cmd.hasOption(COMPACT_OPTION) ||<a name="line.190"></a> +<span class="sourceLineNo">191</span> conf.getBoolean(ThriftServerRunner.COMPACT_CONF_KEY, false);<a name="line.191"></a> +<span class="sourceLineNo">192</span> conf.setBoolean(ThriftServerRunner.COMPACT_CONF_KEY, compact);<a name="line.192"></a> +<span class="sourceLineNo">193</span> boolean framed = cmd.hasOption(FRAMED_OPTION) ||<a name="line.193"></a> +<span class="sourceLineNo">194</span> conf.getBoolean(ThriftServerRunner.FRAMED_CONF_KEY, false);<a name="line.194"></a> +<span class="sourceLineNo">195</span> conf.setBoolean(ThriftServerRunner.FRAMED_CONF_KEY, framed);<a name="line.195"></a> +<span class="sourceLineNo">196</span> if (cmd.hasOption(BIND_OPTION)) {<a name="line.196"></a> +<span class="sourceLineNo">197</span> conf.set(ThriftServerRunner.BIND_CONF_KEY, cmd.getOptionValue(BIND_OPTION));<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> ImplType.setServerImpl(cmd, conf);<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> public void stop() {<a name="line.203"></a> +<span class="sourceLineNo">204</span> if (this.infoServer != null) {<a name="line.204"></a> +<span class="sourceLineNo">205</span> LOG.info("Stopping infoServer");<a name="line.205"></a> +<span class="sourceLineNo">206</span> try {<a name="line.206"></a> +<span class="sourceLineNo">207</span> this.infoServer.stop();<a name="line.207"></a> +<span class="sourceLineNo">208</span> } catch (Exception ex) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> ex.printStackTrace();<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span> }<a name="line.211"></a> +<span class="sourceLineNo">212</span> serverRunner.shutdown();<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> private static void optionToConf(CommandLine cmd, String option,<a name="line.215"></a> +<span class="sourceLineNo">216</span> Configuration conf, String destConfKey) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> if (cmd.hasOption(option)) {<a name="line.217"></a> +<span class="sourceLineNo">218</span> String value = cmd.getOptionValue(option);<a name="line.218"></a> +<span class="sourceLineNo">219</span> LOG.info("Set configuration key:" + destConfKey + " value:" + value);<a name="line.219"></a> +<span class="sourceLineNo">220</span> conf.set(destConfKey, value);<a name="line.220"></a> +<span class="sourceLineNo">221</span> }<a name="line.221"></a> +<span class="sourceLineNo">222</span> }<a name="line.222"></a> +<span class="sourceLineNo">223</span><a name="line.223"></a> +<span class="sourceLineNo">224</span> public static void main(String [] args) throws Exception {<a name="line.224"></a> +<span class="sourceLineNo">225</span> LOG.info("***** STARTING service '" + ThriftServer.class.getSimpleName() + "' *****");<a name="line.225"></a> +<span class="sourceLineNo">226</span> VersionInfo.logVersion();<a name="line.226"></a> +<span class="sourceLineNo">227</span> int exitCode = 0;<a name="line.227"></a> +<span class="sourceLineNo">228</span> try {<a name="line.228"></a> +<span class="sourceLineNo">229</span> new ThriftServer(HBaseConfiguration.create()).doMain(args);<a name="line.229"></a> +<span class="sourceLineNo">230</span> } catch (ExitCodeException ex) {<a name="line.230"></a> +<span class="sourceLineNo">231</span> exitCode = ex.getExitCode();<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span> LOG.info("***** STOPPING service '" + ThriftServer.class.getSimpleName() + "' *****");<a name="line.233"></a> +<span class="sourceLineNo">234</span> System.exit(exitCode);<a name="line.234"></a> +<span class="sourceLineNo">235</span> }<a name="line.235"></a> +<span class="sourceLineNo">236</span>}<a name="line.236"></a>
