org.apache.hadoop.hbase.thrift2

Class ThriftServer

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hbase.thrift2.ThriftServer

All Implemented Interfaces:

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

@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 HbaseClient.thrift IDL file.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	BACKLOG_CONF_KEY
static int	DEFAULT_LISTEN_PORT
private static org.slf4j.Logger	log
private static String	READ_TIMEOUT_OPTION
(package private) static String	THRIFT_QOP_KEY Thrift quality of protection configuration key.
static int	THRIFT_SERVER_SOCKET_READ_TIMEOUT_DEFAULT
static String	THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY Amount of time in milliseconds before a server thread will timeout waiting for client to send data on a connected socket.

Constructor Summary

Constructors

Constructor and Description
ThriftServer()

Method Summary

Modifier and Type	Method and Description
private static InetSocketAddress	bindToPort(String bindValue, int listenPort)
private static ExecutorService	createExecutor(int workerThreads, int maxCallQueueSize, ThriftMetrics metrics)
private static org.apache.hbase.thirdparty.org.apache.commons.cli.Options	getOptions()
private static org.apache.thrift.server.TServer	getTHsHaServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, int workerThreads, int maxCallQueueSize, InetSocketAddress inetSocketAddress, ThriftMetrics metrics)
private static org.apache.thrift.server.TServer	getTNonBlockingServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, InetSocketAddress inetSocketAddress)
private static org.apache.thrift.protocol.TProtocolFactory	getTProtocolFactory(boolean isCompact)
private static org.apache.thrift.server.TServer	getTThreadedSelectorServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, int workerThreads, int selectorThreads, int maxCallQueueSize, InetSocketAddress inetSocketAddress, ThriftMetrics metrics)
private static org.apache.thrift.server.TServer	getTThreadPoolServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, int workerThreads, InetSocketAddress inetSocketAddress, int backlog, int clientTimeout, ThriftMetrics metrics)
private static org.apache.thrift.transport.TTransportFactory	getTTransportFactory(SaslUtil.QualityOfProtection qop, String name, String host, boolean framed, int frameSize)
static void	main(String[] args) Start up the Thrift2 server.
private static org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine	parseArguments(org.apache.hadoop.conf.Configuration conf, org.apache.hbase.thirdparty.org.apache.commons.cli.Options options, String[] args)
private static void	printUsage()
protected static void	registerFilters(org.apache.hadoop.conf.Configuration conf) Adds the option to pre-load filters at startup.
int	run(String[] args)

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

THRIFT_QOP_KEY

static final String THRIFT_QOP_KEY

Thrift quality of protection configuration key. Valid values can be: privacy: authentication, integrity and confidentiality checking integrity: authentication and integrity checking authentication: authentication only This is used to authenticate the callers and support impersonation. The thrift server and the HBase cluster must run in secure mode.

See Also:

Constant Field Values

BACKLOG_CONF_KEY

static final String BACKLOG_CONF_KEY

See Also:

Constant Field Values

DEFAULT_LISTEN_PORT

public static final int DEFAULT_LISTEN_PORT

See Also:

Constant Field Values

READ_TIMEOUT_OPTION

private static final String READ_TIMEOUT_OPTION

See Also:

Constant Field Values

THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY

public static final String THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY

Amount of time in milliseconds before a server thread will timeout waiting for client to send data on a connected socket. Currently, applies only to TBoundedThreadPoolServer

See Also:

Constant Field Values

THRIFT_SERVER_SOCKET_READ_TIMEOUT_DEFAULT

public static final int THRIFT_SERVER_SOCKET_READ_TIMEOUT_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ThriftServer

public ThriftServer()

Method Detail

printUsage

private static void printUsage()

getOptions

private static org.apache.hbase.thirdparty.org.apache.commons.cli.Options getOptions()

parseArguments

private static org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine parseArguments(org.apache.hadoop.conf.Configuration conf,
                                                                                             org.apache.hbase.thirdparty.org.apache.commons.cli.Options options,
                                                                                             String[] args)
                                                                                      throws org.apache.hbase.thirdparty.org.apache.commons.cli.ParseException,
                                                                                             IOException

Throws:

org.apache.hbase.thirdparty.org.apache.commons.cli.ParseException

IOException

getTProtocolFactory

private static org.apache.thrift.protocol.TProtocolFactory getTProtocolFactory(boolean isCompact)

getTTransportFactory

private static org.apache.thrift.transport.TTransportFactory getTTransportFactory(SaslUtil.QualityOfProtection qop,
                                                                                  String name,
                                                                                  String host,
                                                                                  boolean framed,
                                                                                  int frameSize)

bindToPort

private static InetSocketAddress bindToPort(String bindValue,
                                            int listenPort)
                                     throws UnknownHostException

Throws:

UnknownHostException

getTNonBlockingServer

private static org.apache.thrift.server.TServer getTNonBlockingServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                      org.apache.thrift.TProcessor processor,
                                                                      org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                      InetSocketAddress inetSocketAddress)
                                                               throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

getTHsHaServer

private static org.apache.thrift.server.TServer getTHsHaServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                               org.apache.thrift.TProcessor processor,
                                                               org.apache.thrift.transport.TTransportFactory transportFactory,
                                                               int workerThreads,
                                                               int maxCallQueueSize,
                                                               InetSocketAddress inetSocketAddress,
                                                               ThriftMetrics metrics)
                                                        throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

getTThreadedSelectorServer

private static org.apache.thrift.server.TServer getTThreadedSelectorServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                           org.apache.thrift.TProcessor processor,
                                                                           org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                           int workerThreads,
                                                                           int selectorThreads,
                                                                           int maxCallQueueSize,
                                                                           InetSocketAddress inetSocketAddress,
                                                                           ThriftMetrics metrics)
                                                                    throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

createExecutor

private static ExecutorService createExecutor(int workerThreads,
                                              int maxCallQueueSize,
                                              ThriftMetrics metrics)

getTThreadPoolServer

private static org.apache.thrift.server.TServer getTThreadPoolServer(org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                     org.apache.thrift.TProcessor processor,
                                                                     org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                     int workerThreads,
                                                                     InetSocketAddress inetSocketAddress,
                                                                     int backlog,
                                                                     int clientTimeout,
                                                                     ThriftMetrics metrics)
                                                              throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

registerFilters

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

Adds the option to pre-load filters at startup.

Parameters:

conf - The current configuration instance.

main

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

Start up the Thrift2 server.

Throws:

Exception

run

public int run(String[] args)
        throws Exception

Specified by:

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

Throws:

Exception