ThriftServerRunner (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.thrift.ThriftServerRunner

All Implemented Interfaces:

Runnable
```
@InterfaceAudience.Private
public class ThriftServerRunner
extends Object
implements Runnable
```
ThriftServerRunner - this class starts up a Thrift server which implements the Hbase API specified in the Hbase.thrift IDL file.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ThriftServerRunner.HBaseHandler` The HBaseHandler is a glue object that connects Thrift RPC calls to the HBase client API primarily defined in the Admin and Table objects.
`(package private) static class`	`ThriftServerRunner.ImplType` An enum of server implementation selections
`protected static class`	`ThriftServerRunner.ResultScannerWrapper`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static String`	`BACKLOG_CONF_KEY`
`(package private) static String`	`BIND_CONF_KEY`
`(package private) static String`	`COALESCE_INC_KEY`
`(package private) static String`	`COMPACT_CONF_KEY`
`private org.apache.hadoop.conf.Configuration`	`conf`
`private static String`	`DEFAULT_BIND_ADDR`
`static int`	`DEFAULT_LISTEN_PORT`
`private boolean`	`doAsEnabled`
`(package private) static String`	`FRAMED_CONF_KEY`
`private org.apache.hadoop.hbase.thrift.generated.Hbase.Iface`	`handler`
`private ThriftServerRunner.HBaseHandler`	`hbaseHandler`
`private String`	`host`
`static int`	`HREGION_VERSION`
`(package private) static String`	`HTTP_MAX_THREADS`
`(package private) static String`	`HTTP_MIN_THREADS`
`(package private) org.mortbay.jetty.Server`	`httpServer`
`private int`	`listenPort`
`private static org.apache.commons.logging.Log`	`LOG`
`(package private) static String`	`MAX_FRAME_SIZE_CONF_KEY`
`private ThriftMetrics`	`metrics`
`(package private) static String`	`PORT_CONF_KEY`
`private SaslUtil.QualityOfProtection`	`qop`
`private org.apache.hadoop.security.UserGroupInformation`	`realUser`
`private boolean`	`securityEnabled`
`(package private) static String`	`SERVER_TYPE_CONF_KEY`
`(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.
`(package private) static String`	`THRIFT_SSL_ENABLED`
`(package private) static String`	`THRIFT_SSL_KEYSTORE_KEYPASSWORD`
`(package private) static String`	`THRIFT_SSL_KEYSTORE_PASSWORD`
`(package private) static String`	`THRIFT_SSL_KEYSTORE_STORE`
`(package private) static String`	`THRIFT_SUPPORT_PROXYUSER`
`(package private) org.apache.thrift.server.TServer`	`tserver`
`(package private) static String`	`USE_HTTP_CONF_KEY`

Constructor Summary

Constructors
Constructor and Description

ThriftServerRunner(org.apache.hadoop.conf.Configuration conf)

Constructors
Constructor and Description
`ThriftServerRunner(org.apache.hadoop.conf.Configuration conf)`

Method Summary

Methods
Modifier and Type	Method and Description
`private static void`	`addAttributes(OperationWithAttributes op, Map<ByteBuffer,ByteBuffer> attributes)` Adds all the attributes into the Operation object
`private void`	`checkHttpSecurity(SaslUtil.QualityOfProtection qop, org.apache.hadoop.conf.Configuration conf)`
`(package private) ExecutorService`	`createExecutor(BlockingQueue<Runnable> callQueue, int minWorkers, int maxWorkers)`
`private InetAddress`	`getBindAddress(org.apache.hadoop.conf.Configuration conf)`
`static void`	`registerFilters(org.apache.hadoop.conf.Configuration conf)`
`void`	`run()`
`private void`	`setupHTTPServer()`
`private void`	`setupServer()` Setting up the thrift TServer
`void`	`shutdown()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- LOG
```
private static final org.apache.commons.logging.Log LOG
```
- SERVER_TYPE_CONF_KEY
```
static final String SERVER_TYPE_CONF_KEY
```
  See Also:
  Constant Field Values
- BIND_CONF_KEY
```
static final String BIND_CONF_KEY
```
  See Also:
  Constant Field Values
- COMPACT_CONF_KEY
```
static final String COMPACT_CONF_KEY
```
  See Also:
  Constant Field Values
- FRAMED_CONF_KEY
```
static final String FRAMED_CONF_KEY
```
  See Also:
  Constant Field Values
- MAX_FRAME_SIZE_CONF_KEY
```
static final String MAX_FRAME_SIZE_CONF_KEY
```
  See Also:
  Constant Field Values
- PORT_CONF_KEY
```
static final String PORT_CONF_KEY
```
  See Also:
  Constant Field Values
- COALESCE_INC_KEY
```
static final String COALESCE_INC_KEY
```
  See Also:
  Constant Field Values
- USE_HTTP_CONF_KEY
```
static final String USE_HTTP_CONF_KEY
```
  See Also:
  Constant Field Values
- HTTP_MIN_THREADS
```
static final String HTTP_MIN_THREADS
```
  See Also:
  Constant Field Values
- HTTP_MAX_THREADS
```
static final String HTTP_MAX_THREADS
```
  See Also:
  Constant Field Values
- THRIFT_SSL_ENABLED
```
static final String THRIFT_SSL_ENABLED
```
  See Also:
  Constant Field Values
- THRIFT_SSL_KEYSTORE_STORE
```
static final String THRIFT_SSL_KEYSTORE_STORE
```
  See Also:
  Constant Field Values
- THRIFT_SSL_KEYSTORE_PASSWORD
```
static final String THRIFT_SSL_KEYSTORE_PASSWORD
```
  See Also:
  Constant Field Values
- THRIFT_SSL_KEYSTORE_KEYPASSWORD
```
static final String THRIFT_SSL_KEYSTORE_KEYPASSWORD
```
  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
- THRIFT_QOP_KEY
```
static final String THRIFT_QOP_KEY
```
  Thrift quality of protection configuration key. Valid values can be: auth-conf: authentication, integrity and confidentiality checking auth-int: authentication and integrity checking auth: 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_BIND_ADDR
```
private static final String DEFAULT_BIND_ADDR
```
  See Also:
  Constant Field Values
- DEFAULT_LISTEN_PORT
```
public static final int DEFAULT_LISTEN_PORT
```
  See Also:
  Constant Field Values
- HREGION_VERSION
```
public static final int HREGION_VERSION
```
  See Also:
  Constant Field Values
- THRIFT_SUPPORT_PROXYUSER
```
static final String THRIFT_SUPPORT_PROXYUSER
```
  See Also:
  Constant Field Values
- listenPort
```
private final int listenPort
```
- conf
```
private org.apache.hadoop.conf.Configuration conf
```
- tserver
```
volatile org.apache.thrift.server.TServer tserver
```
- httpServer
```
volatile org.mortbay.jetty.Server httpServer
```
- handler
```
private final org.apache.hadoop.hbase.thrift.generated.Hbase.Iface handler
```
- metrics
```
private final ThriftMetrics metrics
```
- hbaseHandler
```
private final ThriftServerRunner.HBaseHandler hbaseHandler
```
- realUser
```
private final org.apache.hadoop.security.UserGroupInformation realUser
```
- qop
```
private SaslUtil.QualityOfProtection qop
```
- host
```
private String host
```
- securityEnabled
```
private final boolean securityEnabled
```
- doAsEnabled
```
private final boolean doAsEnabled
```

Constructor Detail

ThriftServerRunner

public ThriftServerRunner(org.apache.hadoop.conf.Configuration conf)
                   throws IOException

Throws:: IOException

Method Detail

checkHttpSecurity

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

run
```
public void run()
```
Specified by:

run in interface Runnable

shutdown
```
public void shutdown()
```

setupHTTPServer

private void setupHTTPServer()
                      throws IOException

Throws:: IOException

setupServer

private void setupServer()
                  throws Exception

Setting up the thrift TServer

Throws:: Exception

createExecutor

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

getBindAddress

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

Throws:: UnknownHostException

addAttributes

private static void addAttributes(OperationWithAttributes op,
                 Map<ByteBuffer,ByteBuffer> attributes)

Adds all the attributes into the Operation object

registerFilters

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

Class ThriftServerRunner

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

SERVER_TYPE_CONF_KEY

BIND_CONF_KEY

COMPACT_CONF_KEY

FRAMED_CONF_KEY

MAX_FRAME_SIZE_CONF_KEY

PORT_CONF_KEY

COALESCE_INC_KEY

USE_HTTP_CONF_KEY

HTTP_MIN_THREADS

HTTP_MAX_THREADS

THRIFT_SSL_ENABLED

THRIFT_SSL_KEYSTORE_STORE

THRIFT_SSL_KEYSTORE_PASSWORD

THRIFT_SSL_KEYSTORE_KEYPASSWORD

THRIFT_SERVER_SOCKET_READ_TIMEOUT_KEY

THRIFT_SERVER_SOCKET_READ_TIMEOUT_DEFAULT

THRIFT_QOP_KEY

BACKLOG_CONF_KEY

DEFAULT_BIND_ADDR

DEFAULT_LISTEN_PORT

HREGION_VERSION

THRIFT_SUPPORT_PROXYUSER

listenPort

conf

tserver

httpServer

handler

metrics

hbaseHandler

realUser

qop

host

securityEnabled

doAsEnabled

Constructor Detail

ThriftServerRunner

Method Detail

checkHttpSecurity

run

shutdown

setupHTTPServer

setupServer

createExecutor

getBindAddress

addAttributes

registerFilters