org.apache.hadoop.hbase.thrift

Class ThriftServer

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hbase.thrift.ThriftServer

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Direct Known Subclasses:

ThriftServer

@InterfaceAudience.LimitedPrivate(value="Tools")
public class ThriftServer
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

ThriftServer- this class starts up a Thrift server which implements the Hbase API specified in the Hbase.thrift IDL file. The server runs in an independent process.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.conf.Configuration	conf
protected boolean	doAsEnabled
protected HBaseServiceHandler	hbaseServiceHandler
protected String	host
protected boolean	httpEnabled
protected org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server	httpServer
protected org.apache.hadoop.security.UserGroupInformation	httpUGI
protected InfoServer	infoServer
protected int	listenPort
private static org.slf4j.Logger	LOG
protected ThriftMetrics	metrics
protected JvmPauseMonitor	pauseMonitor
protected org.apache.thrift.TProcessor	processor
protected SaslUtil.QualityOfProtection	qop
protected boolean	securityEnabled
protected org.apache.hadoop.security.UserGroupInformation	serviceUGI
protected org.apache.thrift.server.TServer	tserver

Constructor Summary

Constructors

Constructor and Description
ThriftServer(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
protected void	addOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options) Add options to command lines
protected void	checkHttpSecurity(SaslUtil.QualityOfProtection qop, org.apache.hadoop.conf.Configuration conf)
protected ExecutorService	createExecutor(BlockingQueue<Runnable> callQueue, int minWorkers, int maxWorkers)
protected HBaseServiceHandler	createHandler(org.apache.hadoop.conf.Configuration conf, UserProvider userProvider)
protected org.apache.thrift.TProcessor	createProcessor()
protected ThriftMetrics	createThriftMetrics(org.apache.hadoop.conf.Configuration conf)
protected org.apache.thrift.server.TServlet	createTServlet(org.apache.thrift.protocol.TProtocolFactory protocolFactory) Create a Servlet for the http server
protected InetAddress	getBindAddress(org.apache.hadoop.conf.Configuration conf)
org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server	getHttpServer() the Jetty server, not null means the HTTP server is started, for test only
protected org.apache.thrift.protocol.TProtocolFactory	getProtocolFactory()
private String	getSpengoPrincipal(org.apache.hadoop.conf.Configuration conf, String host)
private String	getSpnegoKeytab(org.apache.hadoop.conf.Configuration conf)
protected org.apache.thrift.server.TServer	getTHsHaServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, InetSocketAddress inetSocketAddress)
protected org.apache.thrift.server.TServer	getTNonBlockingServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, InetSocketAddress inetSocketAddress)
org.apache.thrift.server.TServer	getTserver() the thrift server, not null means the server is started, for test only
protected org.apache.thrift.server.TServer	getTThreadedSelectorServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, InetSocketAddress inetSocketAddress)
protected org.apache.thrift.server.TServer	getTThreadPoolServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, InetSocketAddress inetSocketAddress)
static void	main(String[] args)
protected static void	optionToConf(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd, String option, org.apache.hadoop.conf.Configuration conf, String destConfKey)
protected void	parseCommandLine(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd, org.apache.hbase.thirdparty.org.apache.commons.cli.Options options)
protected void	printUsageAndExit(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options, int exitCode)
protected void	processOptions(String[] args) Parse the command line options to set parameters the conf.
static void	registerFilters(org.apache.hadoop.conf.Configuration conf)
int	run() Run without any command line arguments
int	run(String[] strings)
protected void	setupHTTPServer() Setup an HTTP Server using Jetty to serve calls from THttpClient
protected void	setupParamters()
protected void	setupServer() Setting up the thrift TServer
protected void	startInfoServer()
void	stop()

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

LOG

private static final org.slf4j.Logger LOG

conf

protected org.apache.hadoop.conf.Configuration conf

infoServer

protected InfoServer infoServer

processor

protected org.apache.thrift.TProcessor processor

metrics

protected ThriftMetrics metrics

hbaseServiceHandler

protected HBaseServiceHandler hbaseServiceHandler

serviceUGI

protected org.apache.hadoop.security.UserGroupInformation serviceUGI

httpUGI

protected org.apache.hadoop.security.UserGroupInformation httpUGI

httpEnabled

protected boolean httpEnabled

qop

protected SaslUtil.QualityOfProtection qop

host

protected String host

listenPort

protected int listenPort

securityEnabled

protected boolean securityEnabled

doAsEnabled

protected boolean doAsEnabled

pauseMonitor

protected JvmPauseMonitor pauseMonitor

tserver

protected volatile org.apache.thrift.server.TServer tserver

httpServer

protected volatile org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server httpServer

Constructor Detail

ThriftServer

public ThriftServer(org.apache.hadoop.conf.Configuration conf)

Method Detail

createThriftMetrics

protected ThriftMetrics createThriftMetrics(org.apache.hadoop.conf.Configuration conf)

setupParamters

protected void setupParamters()
                       throws IOException

Throws:

IOException

getSpengoPrincipal

private String getSpengoPrincipal(org.apache.hadoop.conf.Configuration conf,
                                  String host)
                           throws IOException

Throws:

IOException

getSpnegoKeytab

private String getSpnegoKeytab(org.apache.hadoop.conf.Configuration conf)

startInfoServer

protected void startInfoServer()
                        throws IOException

Throws:

IOException

checkHttpSecurity

protected void checkHttpSecurity(SaslUtil.QualityOfProtection qop,
                                 org.apache.hadoop.conf.Configuration conf)

createHandler

protected HBaseServiceHandler createHandler(org.apache.hadoop.conf.Configuration conf,
                                            UserProvider userProvider)
                                     throws IOException

Throws:

IOException

createProcessor

protected org.apache.thrift.TProcessor createProcessor()

getTserver

@InterfaceAudience.Private
public org.apache.thrift.server.TServer getTserver()

the thrift server, not null means the server is started, for test only

Returns:

the tServer

getHttpServer

@InterfaceAudience.Private
public org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server getHttpServer()

the Jetty server, not null means the HTTP server is started, for test only

Returns:

the http server

printUsageAndExit

protected void printUsageAndExit(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options,
                                 int exitCode)
                          throws org.apache.hadoop.util.Shell.ExitCodeException

Throws:

org.apache.hadoop.util.Shell.ExitCodeException

createTServlet

protected org.apache.thrift.server.TServlet createTServlet(org.apache.thrift.protocol.TProtocolFactory protocolFactory)

Create a Servlet for the http server

Parameters:

protocolFactory - protocolFactory

Returns:

the servlet

setupHTTPServer

protected void setupHTTPServer()
                        throws IOException

Setup an HTTP Server using Jetty to serve calls from THttpClient

Throws:

IOException - IOException

setupServer

protected void setupServer()
                    throws Exception

Setting up the thrift TServer

Throws:

Exception

getTNonBlockingServer

protected org.apache.thrift.server.TServer getTNonBlockingServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport,
                                                                 org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                 org.apache.thrift.TProcessor processor,
                                                                 org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                 InetSocketAddress inetSocketAddress)

getTHsHaServer

protected org.apache.thrift.server.TServer getTHsHaServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport,
                                                          org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                          org.apache.thrift.TProcessor processor,
                                                          org.apache.thrift.transport.TTransportFactory transportFactory,
                                                          InetSocketAddress inetSocketAddress)

getTThreadedSelectorServer

protected org.apache.thrift.server.TServer getTThreadedSelectorServer(org.apache.thrift.transport.TNonblockingServerTransport serverTransport,
                                                                      org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                      org.apache.thrift.TProcessor processor,
                                                                      org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                      InetSocketAddress inetSocketAddress)

getTThreadPoolServer

protected org.apache.thrift.server.TServer getTThreadPoolServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                org.apache.thrift.TProcessor processor,
                                                                org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                InetSocketAddress inetSocketAddress)
                                                         throws Exception

Throws:

Exception

getProtocolFactory

protected org.apache.thrift.protocol.TProtocolFactory getProtocolFactory()

createExecutor

protected ExecutorService createExecutor(BlockingQueue<Runnable> callQueue,
                                         int minWorkers,
                                         int maxWorkers)

getBindAddress

protected InetAddress getBindAddress(org.apache.hadoop.conf.Configuration conf)
                              throws UnknownHostException

Throws:

UnknownHostException

registerFilters

public static void registerFilters(org.apache.hadoop.conf.Configuration conf)

addOptions

protected void addOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options)

Add options to command lines

Parameters:

options - options

parseCommandLine

protected void parseCommandLine(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd,
                                org.apache.hbase.thirdparty.org.apache.commons.cli.Options options)
                         throws org.apache.hadoop.util.Shell.ExitCodeException

Throws:

org.apache.hadoop.util.Shell.ExitCodeException

processOptions

protected void processOptions(String[] args)
                       throws Exception

Parse the command line options to set parameters the conf.

Throws:

Exception

stop

public void stop()

optionToConf

protected static void optionToConf(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd,
                                   String option,
                                   org.apache.hadoop.conf.Configuration conf,
                                   String destConfKey)

run

public int run()
        throws Exception

Run without any command line arguments

Returns:

exit code

Throws:

Exception - exception

run

public int run(String[] strings)
        throws Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

Exception

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception