Package org.apache.hadoop.hbase.rest

Class TableResource

java.lang.Object

org.apache.hadoop.hbase.rest.ResourceBase

org.apache.hadoop.hbase.rest.TableResource

All Implemented Interfaces:

Constants

@Private
public class TableResource
extends ResourceBase

Field Summary

Fields

Modifier and Type	Field	Description
private static final Base64.Decoder	base64Urldecoder
private static final org.slf4j.Logger	LOG
(package private) String	table

Fields inherited from class org.apache.hadoop.hbase.rest.ResourceBase

accessDeniedClazz, servlet

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
TableResource(String table)	Constructor

Method Summary

Modifier and Type	Method	Description
(package private) boolean	exists()	Returns true if the table exists n
ExistsResource	getExistsResource()
MultiRowResource	getMultipleRowResource(String versions, String path)
(package private) String	getName()	Returns the table name
RegionsResource	getRegionsResource()
RowResource	getRowResource(String rowspec, String versions, String check, String returnResult, String keyEncodingHeader, String keyEncodingQuery)
RowResource	getRowResourceWithSuffixGlobbing(String suffixglobbingspec, String versions, String check, String returnResult, String keyEncodingHeader, String keyEncodingQuery)
ScannerResource	getScannerResource()
TableScanResource	getScanResource(String scanSpec, int userRequestedLimit, String startRow, String endRow, List<String> column, int maxVersions, int batchSize, long startTime, long endTime, boolean cacheBlocks, boolean reversed, String paramFilter, String paramFilterB64)
SchemaResource	getSchemaResource()

Methods inherited from class org.apache.hadoop.hbase.rest.ResourceBase

processException

Methods inherited from class java.lang.Object

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

Field Details

table

String table

LOG

private static final org.slf4j.Logger LOG

base64Urldecoder

private static final Base64.Decoder base64Urldecoder

Constructor Details

TableResource

public TableResource(String table)
              throws IOException

Constructor

Throws:

IOException

Method Details

getName

String getName()

Returns the table name

exists

boolean exists()
        throws IOException

Returns true if the table exists n

Throws:

IOException

getExistsResource

@Path("exists")
public ExistsResource getExistsResource()
                                 throws IOException

Throws:

IOException

getRegionsResource

@Path("regions")
public RegionsResource getRegionsResource()
                                   throws IOException

Throws:

IOException

getScannerResource

@Path("scanner")
public ScannerResource getScannerResource()
                                   throws IOException

Throws:

IOException

getSchemaResource

@Path("schema")
public SchemaResource getSchemaResource()
                                 throws IOException

Throws:

IOException

getMultipleRowResource

@Path("{multiget: multiget.*}")
public MultiRowResource getMultipleRowResource(@QueryParam("v")
 String versions,
 @PathParam("multiget")
 String path)
                                        throws IOException

Throws:

IOException

getRowResource

@Path("{rowspec: [^*]+}")
public RowResource getRowResource(@PathParam("rowspec") @Encoded
 String rowspec,
 @QueryParam("v")
 String versions,
 @QueryParam("check")
 String check,
 @QueryParam("rr")
 String returnResult,
 @HeaderParam("Encoding")
 String keyEncodingHeader,
 @QueryParam("e")
 String keyEncodingQuery)
                           throws IOException

Throws:

IOException

getRowResourceWithSuffixGlobbing

@Path("{suffixglobbingspec: .*\\*/.+}")
public RowResource getRowResourceWithSuffixGlobbing(@PathParam("suffixglobbingspec") @Encoded
 String suffixglobbingspec,
 @QueryParam("v")
 String versions,
 @QueryParam("check")
 String check,
 @QueryParam("rr")
 String returnResult,
 @HeaderParam("Encoding")
 String keyEncodingHeader,
 @QueryParam("e")
 String keyEncodingQuery)
                                             throws IOException

Throws:

IOException

getScanResource

@Path("{scanspec: .*[*]$}")
public TableScanResource getScanResource(@PathParam("scanspec")
 String scanSpec,
 @DefaultValue("2147483647") @QueryParam("limit")
 int userRequestedLimit,
 @DefaultValue("") @QueryParam("startrow")
 String startRow,
 @DefaultValue("") @QueryParam("endrow")
 String endRow,
 @QueryParam("column")
 List<String> column,
 @DefaultValue("1") @QueryParam("maxversions")
 int maxVersions,
 @DefaultValue("-1") @QueryParam("batchsize")
 int batchSize,
 @DefaultValue("0") @QueryParam("starttime")
 long startTime,
 @DefaultValue("9223372036854775807") @QueryParam("endtime")
 long endTime,
 @DefaultValue("true") @QueryParam("cacheblocks")
 boolean cacheBlocks,
 @DefaultValue("false") @QueryParam("reversed")
 boolean reversed,
 @QueryParam("filter")
 String paramFilter,
 @QueryParam("filter_b64") @Encoded
 String paramFilterB64)