Package org.apache.hadoop.hbase.rest

Class RESTServer

java.lang.Object

org.apache.hadoop.hbase.rest.RESTServer

All Implemented Interfaces:

Constants

@LimitedPrivate("Tools")
public class RESTServer
extends Object
implements Constants

Main class for launching REST gateway as a servlet hosted by Jetty.

The following options are supported:

• -p --port : service port
• -ro --readonly : server mode

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.hadoop.conf.Configuration	conf
(package private) static final int	DEFAULT_HTTP_HEADER_CACHE_SIZE
(package private) static final int	DEFAULT_HTTP_MAX_HEADER_SIZE
(package private) static final String	HTTP_HEADER_CACHE_SIZE
private InfoServer	infoServer
(package private) static org.slf4j.Logger	LOG
private static final String	PATH_SPEC_ANY
(package private) static final String	REST_CSRF_BROWSER_USERAGENTS_REGEX_KEY
(package private) static final String	REST_CSRF_CUSTOM_HEADER_DEFAULT
(package private) static final String	REST_CSRF_CUSTOM_HEADER_KEY
(package private) static final boolean	REST_CSRF_ENABLED_DEFAULT
(package private) static final String	REST_CSRF_ENABLED_KEY
(package private) static final String	REST_CSRF_METHODS_TO_IGNORE_DEFAULT
(package private) static final String	REST_CSRF_METHODS_TO_IGNORE_KEY
(package private) static final String	REST_HTTP_ALLOW_OPTIONS_METHOD
private static boolean	REST_HTTP_ALLOW_OPTIONS_METHOD_DEFAULT
static final String	REST_SERVER
(package private) boolean	restCSRFEnabled
private org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server	server
private ServerName	serverName
static final String	SKIP_LOGIN_KEY
private final UserProvider	userProvider

Fields inherited from interface org.apache.hadoop.hbase.rest.Constants

CRLF, CUSTOM_FILTERS, DEFAULT_LISTEN_PORT, DEFAULT_MAX_AGE, DEFAULT_REST_CLIENT_CONN_TIMEOUT, DEFAULT_REST_CLIENT_SOCKET_TIMEOUT, DEFAULT_REST_SCANNERCACHE_EXPIRE_TIME_MS, DEFAULT_REST_SCANNERCACHE_SIZE, FILTER, FILTER_B64, FILTER_CLASSES, KEY_ENCODING_QUERY_PARAM_NAME, MIMETYPE_BINARY, MIMETYPE_HTML, MIMETYPE_JSON, MIMETYPE_PROTOBUF, MIMETYPE_PROTOBUF_IETF, MIMETYPE_TEXT, MIMETYPE_XML, NOCACHE_PARAM_NAME, REST_AUTHENTICATION_PRINCIPAL, REST_AUTHENTICATION_TYPE, REST_CLIENT_CONN_TIMEOUT, REST_CLIENT_SOCKET_TIMEOUT, REST_CONNECTOR_ACCEPT_QUEUE_SIZE, REST_DNS_INTERFACE, REST_DNS_NAMESERVER, REST_KERBEROS_PRINCIPAL, REST_KEYTAB_FILE, REST_SCANNERCACHE_EXPIRE_TIME, REST_SCANNERCACHE_SIZE, REST_SSL_ENABLED, REST_SSL_EXCLUDE_CIPHER_SUITES, REST_SSL_EXCLUDE_PROTOCOLS, REST_SSL_INCLUDE_CIPHER_SUITES, REST_SSL_INCLUDE_PROTOCOLS, REST_SSL_KEYSTORE_KEYPASSWORD, REST_SSL_KEYSTORE_PASSWORD, REST_SSL_KEYSTORE_STORE, REST_SSL_KEYSTORE_TYPE, REST_SSL_TRUSTSTORE_PASSWORD, REST_SSL_TRUSTSTORE_STORE, REST_SSL_TRUSTSTORE_TYPE, REST_THREAD_POOL_TASK_QUEUE_SIZE, REST_THREAD_POOL_THREAD_IDLE_TIMEOUT, REST_THREAD_POOL_THREADS_MAX, REST_THREAD_POOL_THREADS_MIN, ROW_KEYS_PARAM_NAME, SCAN_BATCH_SIZE, SCAN_CACHE_BLOCKS, SCAN_COLUMN, SCAN_END_ROW, SCAN_END_TIME, SCAN_FETCH_SIZE, SCAN_FILTER, SCAN_LIMIT, SCAN_MAX_VERSIONS, SCAN_REVERSED, SCAN_START_ROW, SCAN_START_TIME, VERSION_STRING

Constructor Summary

Constructors

Constructor	Description
RESTServer(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
private void	addClickjackingPreventionFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler, org.apache.hadoop.conf.Configuration conf)
(package private) void	addCSRFFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler, org.apache.hadoop.conf.Configuration conf)
private void	addSecurityHeadersFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler, org.apache.hadoop.conf.Configuration conf, boolean isSecure)
org.apache.hadoop.conf.Configuration	getConf()
private static String	getHostName(org.apache.hadoop.conf.Configuration conf)
int	getInfoPort()
int	getPort()
ServerName	getServerName()
void	join()
private static Pair<org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.FilterHolder,Class<? extends org.apache.hbase.thirdparty.org.glassfish.jersey.servlet.ServletContainer>>	loginServerPrincipal(UserProvider userProvider, org.apache.hadoop.conf.Configuration conf)
static void	main(String[] args)	The main method for the HBase rest server.
private static void	parseCommandLine(String[] args, org.apache.hadoop.conf.Configuration conf)
private static void	printUsageAndExit(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options, int exitCode)
void	run()	Runs the REST server.
void	stop()
private void	stopInfoServer()

Methods inherited from class java.lang.Object

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

Field Details

LOG

static org.slf4j.Logger LOG

REST_SERVER

public static final String REST_SERVER

See Also:

• Constant Field Values

REST_CSRF_ENABLED_KEY

static final String REST_CSRF_ENABLED_KEY

See Also:

• Constant Field Values

REST_CSRF_ENABLED_DEFAULT

static final boolean REST_CSRF_ENABLED_DEFAULT

See Also:

• Constant Field Values

restCSRFEnabled

boolean restCSRFEnabled

REST_CSRF_CUSTOM_HEADER_KEY

static final String REST_CSRF_CUSTOM_HEADER_KEY

See Also:

• Constant Field Values

REST_CSRF_CUSTOM_HEADER_DEFAULT

static final String REST_CSRF_CUSTOM_HEADER_DEFAULT

See Also:

• Constant Field Values

REST_CSRF_METHODS_TO_IGNORE_KEY

static final String REST_CSRF_METHODS_TO_IGNORE_KEY

See Also:

• Constant Field Values

REST_CSRF_METHODS_TO_IGNORE_DEFAULT

static final String REST_CSRF_METHODS_TO_IGNORE_DEFAULT

See Also:

• Constant Field Values

SKIP_LOGIN_KEY

public static final String SKIP_LOGIN_KEY

See Also:

• Constant Field Values

DEFAULT_HTTP_MAX_HEADER_SIZE

static final int DEFAULT_HTTP_MAX_HEADER_SIZE

See Also:

• Constant Field Values

HTTP_HEADER_CACHE_SIZE

static final String HTTP_HEADER_CACHE_SIZE

See Also:

• Constant Field Values

DEFAULT_HTTP_HEADER_CACHE_SIZE

static final int DEFAULT_HTTP_HEADER_CACHE_SIZE

See Also:

• Constant Field Values

PATH_SPEC_ANY

private static final String PATH_SPEC_ANY

See Also:

• Constant Field Values

REST_HTTP_ALLOW_OPTIONS_METHOD

static final String REST_HTTP_ALLOW_OPTIONS_METHOD

See Also:

• Constant Field Values

REST_HTTP_ALLOW_OPTIONS_METHOD_DEFAULT

private static boolean REST_HTTP_ALLOW_OPTIONS_METHOD_DEFAULT

REST_CSRF_BROWSER_USERAGENTS_REGEX_KEY

static final String REST_CSRF_BROWSER_USERAGENTS_REGEX_KEY

See Also:

• Constant Field Values

conf

public static org.apache.hadoop.conf.Configuration conf

userProvider

private final UserProvider userProvider

server

private org.apache.hbase.thirdparty.org.eclipse.jetty.server.Server server

infoServer

private InfoServer infoServer

serverName

private ServerName serverName

Constructor Details

RESTServer

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

Method Details

printUsageAndExit

private static void printUsageAndExit(org.apache.hbase.thirdparty.org.apache.commons.cli.Options options,
 int exitCode)

addCSRFFilter

void addCSRFFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler,
 org.apache.hadoop.conf.Configuration conf)

addClickjackingPreventionFilter

private void addClickjackingPreventionFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler,
 org.apache.hadoop.conf.Configuration conf)

addSecurityHeadersFilter

private void addSecurityHeadersFilter(org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletContextHandler ctxHandler,
 org.apache.hadoop.conf.Configuration conf,
 boolean isSecure)

loginServerPrincipal

private static Pair<org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.FilterHolder,Class<? extends org.apache.hbase.thirdparty.org.glassfish.jersey.servlet.ServletContainer>> loginServerPrincipal(UserProvider userProvider,
 org.apache.hadoop.conf.Configuration conf)
                                                                                                                                                                                                 throws Exception

Throws:

Exception

parseCommandLine

private static void parseCommandLine(String[] args,
 org.apache.hadoop.conf.Configuration conf)

run

public void run()
         throws Exception

Runs the REST server.

Throws:

Exception

getHostName

private static String getHostName(org.apache.hadoop.conf.Configuration conf)
                           throws UnknownHostException

Throws:

UnknownHostException

join

public void join()
          throws Exception

Throws:

Exception

stopInfoServer

private void stopInfoServer()

stop

public void stop()
          throws Exception

Throws:

Exception

getPort

public int getPort()

getInfoPort

public int getInfoPort()

getServerName

public ServerName getServerName()

getConf

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

main

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

The main method for the HBase rest server.

Parameters:

args - command-line arguments

Throws:

Exception - exception