Package org.apache.hadoop.hbase.thrift

Class HBaseServiceHandler

java.lang.Object

org.apache.hadoop.hbase.thrift.HBaseServiceHandler

Direct Known Subclasses:

ThriftHBaseServiceHandler, ThriftHBaseServiceHandler

@LimitedPrivate("Tools")
public abstract class HBaseServiceHandler
extends Object

abstract class for HBase handler providing a Connection cache and get table/admin method

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	HBaseServiceHandler.ResultScannerWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLEANUP_INTERVAL
protected org.apache.hadoop.conf.Configuration	conf
protected final ConnectionCache	connectionCache
private static final org.slf4j.Logger	LOG
static final String	MAX_IDLETIME
protected ThriftMetrics	metrics
private final AtomicInteger	nextScannerId
private final KeyLocker<Integer>	removeScannerLock
private final org.apache.hbase.thirdparty.com.google.common.cache.Cache<Integer,HBaseServiceHandler.ResultScannerWrapper>	scannerMap

Constructor Summary

Constructors

Constructor	Description
HBaseServiceHandler(org.apache.hadoop.conf.Configuration c, UserProvider userProvider)

Method Summary

Modifier and Type	Method	Description
protected int	addScanner(ResultScanner scanner, boolean sortColumns)	Assigns a unique ID to the scanner and adds the mapping to an internal HashMap.
protected void	addScannerBack(int id, HBaseServiceHandler.ResultScannerWrapper wrapper)	Add the given scanner back to scanner map.
protected Admin	getAdmin()	Obtain HBaseAdmin.
protected Table	getTable(byte[] tableName)	Creates and returns a Table instance from a given table name.
protected Table	getTable(ByteBuffer tableName)
void	initMetrics(ThriftMetrics metrics)
protected HBaseServiceHandler.ResultScannerWrapper	removeScanner(int id)	Removes the scanner associated with the specified ID from the internal HashMap.
void	setEffectiveUser(String effectiveUser)

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

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

conf

protected org.apache.hadoop.conf.Configuration conf

connectionCache

protected final ConnectionCache connectionCache

nextScannerId

private final AtomicInteger nextScannerId

scannerMap

private final org.apache.hbase.thirdparty.com.google.common.cache.Cache<Integer,HBaseServiceHandler.ResultScannerWrapper> scannerMap

removeScannerLock

private final KeyLocker<Integer> removeScannerLock

metrics

protected ThriftMetrics metrics

Constructor Details

HBaseServiceHandler

public HBaseServiceHandler(org.apache.hadoop.conf.Configuration c,
 UserProvider userProvider)
                    throws IOException

Throws:

IOException

Method Details

initMetrics

public void initMetrics(ThriftMetrics metrics)

setEffectiveUser

public void setEffectiveUser(String effectiveUser)

addScanner

protected int addScanner(ResultScanner scanner,
 boolean sortColumns)

Assigns a unique ID to the scanner and adds the mapping to an internal HashMap.

Parameters:

scanner - to add

Returns:

Id for this Scanner

addScannerBack

protected void addScannerBack(int id,
 HBaseServiceHandler.ResultScannerWrapper wrapper)

Add the given scanner back to scanner map.

When scanning, we need to remove the scanner from scanner map to prevent expiration during scanning.

removeScanner

protected HBaseServiceHandler.ResultScannerWrapper removeScanner(int id)
                                                          throws IOException

Removes the scanner associated with the specified ID from the internal HashMap.

Parameters:

id - of the Scanner to remove

Throws:

AccessDeniedException - if the scanner is not belong to the current user

IOException

getAdmin

protected Admin getAdmin()
                  throws IOException

Obtain HBaseAdmin. Creates the instance if it is not already created.

Throws:

IOException

getTable

protected Table getTable(byte[] tableName)
                  throws IOException

Creates and returns a Table instance from a given table name. name of table

Returns:

Table object

Throws:

IOException - if getting the table fails

getTable

protected Table getTable(ByteBuffer tableName)
                  throws IOException

Throws:

IOException