org.apache.hadoop.hbase.rest

Class RESTServer

java.lang.Object

org.apache.hadoop.hbase.rest.RESTServer

All Implemented Interfaces:

Constants

@InterfaceAudience.LimitedPrivate(value="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 and Description
static org.apache.hadoop.conf.Configuration	conf
static String	SKIP_LOGIN_KEY

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

CRLF, CUSTOM_FILTERS, DEFAULT_LISTEN_PORT, DEFAULT_MAX_AGE, FILTER_CLASSES, 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_CONNECTOR_ACCEPT_QUEUE_SIZE, REST_DNS_INTERFACE, REST_DNS_NAMESERVER, REST_KERBEROS_PRINCIPAL, REST_KEYTAB_FILE, 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_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 and Description
RESTServer(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.conf.Configuration	getConf()
int	getInfoPort()
int	getPort()
void	join()
static void	main(String[] args) The main method for the HBase rest server.
void	run() Runs the REST server.
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

SKIP_LOGIN_KEY

public static final String SKIP_LOGIN_KEY

See Also:

Constant Field Values

conf

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

Constructor Detail

RESTServer

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

Method Detail

run

public void run()
         throws Exception

Runs the REST server.

Throws:

Exception

join

public void join()
          throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

getPort

public int getPort()

getInfoPort

public int getInfoPort()

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