Package org.apache.hadoop.hbase.rest

Class RESTServlet

java.lang.Object

org.apache.hadoop.hbase.rest.RESTServlet

All Implemented Interfaces:

Constants

@Private
public class RESTServlet
extends Object
implements Constants

Singleton class encapsulating global REST servlet state and functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLEANUP_INTERVAL
private final org.apache.hadoop.conf.Configuration	conf
private final ConnectionCache	connectionCache
(package private) static final String	HBASE_REST_SUPPORT_PROXYUSER
private static RESTServlet	INSTANCE
private static final org.slf4j.Logger	LOG
static final String	MAX_IDLETIME
private final MetricsREST	metrics
private final JvmPauseMonitor	pauseMonitor
private final org.apache.hadoop.security.UserGroupInformation	realUser

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_INCLUDE_START_ROW, SCAN_INCLUDE_STOP_ROW, SCAN_LIMIT, SCAN_MAX_VERSIONS, SCAN_REVERSED, SCAN_START_ROW, SCAN_START_TIME, VERSION_STRING

Constructor Summary

Constructors

Constructor	Description
RESTServlet(org.apache.hadoop.conf.Configuration conf, UserProvider userProvider)	Constructor with existing configuration

Method Summary

Modifier and Type	Method	Description
(package private) Admin	getAdmin()
(package private) org.apache.hadoop.conf.Configuration	getConfiguration()
ConnectionCache	getConnectionCache()	Returns the ConnectionCache instance
static RESTServlet	getInstance()	Returns the RESTServlet singleton instance
static RESTServlet	getInstance(org.apache.hadoop.conf.Configuration conf, UserProvider userProvider)
(package private) MetricsREST	getMetrics()
(package private) org.apache.hadoop.security.UserGroupInformation	getRealUser()
(package private) Table	getTable(String tableName)	Caller closes the table afterwards.
(package private) boolean	isReadOnly()	Helper method to determine if server should only respond to GET HTTP method requests.
private void	registerCustomFilter(org.apache.hadoop.conf.Configuration conf)
(package private) void	setEffectiveUser(String effectiveUser)
(package private) void	shutdown()	Shutdown any services that need to stop
static void	stop()
(package private) boolean	supportsProxyuser()

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

INSTANCE

private static RESTServlet INSTANCE

conf

private final org.apache.hadoop.conf.Configuration conf

metrics

private final MetricsREST metrics

connectionCache

private final ConnectionCache connectionCache

realUser

private final org.apache.hadoop.security.UserGroupInformation realUser

pauseMonitor

private final JvmPauseMonitor pauseMonitor

CLEANUP_INTERVAL

public static final String CLEANUP_INTERVAL

See Also:

• Constant Field Values

MAX_IDLETIME

public static final String MAX_IDLETIME

See Also:

• Constant Field Values

HBASE_REST_SUPPORT_PROXYUSER

static final String HBASE_REST_SUPPORT_PROXYUSER

See Also:

• Constant Field Values

Constructor Details

RESTServlet

RESTServlet(org.apache.hadoop.conf.Configuration conf,
 UserProvider userProvider)
     throws IOException

Constructor with existing configuration

Parameters:

conf - existing configuration

userProvider - the login user provider

Throws:

IOException

Method Details

getRealUser

org.apache.hadoop.security.UserGroupInformation getRealUser()

getInstance

public static RESTServlet getInstance()

Returns the RESTServlet singleton instance

getConnectionCache

public ConnectionCache getConnectionCache()

Returns the ConnectionCache instance

getInstance

public static RESTServlet getInstance(org.apache.hadoop.conf.Configuration conf,
 UserProvider userProvider)
                               throws IOException

Parameters:

conf - Existing configuration to use in rest servlet

userProvider - the login user provider

Returns:

the RESTServlet singleton instance

Throws:

IOException

stop

public static void stop()

getAdmin

Admin getAdmin()
        throws IOException

Throws:

IOException

getTable

Table getTable(String tableName)
        throws IOException

Caller closes the table afterwards.

Throws:

IOException

getConfiguration

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

getMetrics

MetricsREST getMetrics()

isReadOnly

boolean isReadOnly()

Helper method to determine if server should only respond to GET HTTP method requests.

Returns:

boolean for server read-only state

setEffectiveUser

void setEffectiveUser(String effectiveUser)

shutdown

void shutdown()

Shutdown any services that need to stop

supportsProxyuser

boolean supportsProxyuser()

registerCustomFilter

private void registerCustomFilter(org.apache.hadoop.conf.Configuration conf)