org.apache.hadoop.hbase.thrift2

Class ThriftHBaseServiceHandler

java.lang.Object

org.apache.hadoop.hbase.thrift2.ThriftHBaseServiceHandler

All Implemented Interfaces:

org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

@InterfaceAudience.Private
public class ThriftHBaseServiceHandler
extends Object
implements org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

This class is a glue object that connects Thrift RPC calls to the HBase client API primarily defined in the Table interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ThriftHBaseServiceHandler.THBaseServiceMetricsProxy
private static class	ThriftHBaseServiceHandler.TIOErrorWithCause

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	CLEANUP_INTERVAL
private ConnectionCache	connectionCache
private static IOException	ioe
private boolean	isReadOnly
private static org.slf4j.Logger	LOG
(package private) static String	MAX_IDLETIME
private AtomicInteger	nextScannerId
private Map<Integer,ResultScanner>	scannerMap

Constructor Summary

Constructors

Constructor and Description
ThriftHBaseServiceHandler(org.apache.hadoop.conf.Configuration conf, UserProvider userProvider)

Method Summary

Modifier and Type	Method and Description
private int	addScanner(ResultScanner scanner) Assigns a unique ID to the scanner and adds the mapping to an internal HashMap.
org.apache.hadoop.hbase.thrift2.generated.TResult	append(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TAppend append)
boolean	checkAndDelete(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, org.apache.hadoop.hbase.thrift2.generated.TDelete deleteSingle) Atomically checks if a row/family/qualifier value matches the expected value.
boolean	checkAndMutate(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, org.apache.hadoop.hbase.thrift2.generated.TCompareOp compareOp, ByteBuffer value, org.apache.hadoop.hbase.thrift2.generated.TRowMutations rowMutations) Atomically checks if a row/family/qualifier value matches the expected value.
boolean	checkAndPut(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, org.apache.hadoop.hbase.thrift2.generated.TPut put) Atomically checks if a row/family/qualifier value matches the expected value.
private void	checkReadOnlyMode()
void	closeScanner(int scannerId) Closes the scanner.
private void	closeTable(Table table)
List<org.apache.hadoop.hbase.thrift2.generated.TDelete>	deleteMultiple(ByteBuffer table, List<org.apache.hadoop.hbase.thrift2.generated.TDelete> deletes) Bulk commit a List of TDeletes to the table.
void	deleteSingle(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TDelete deleteSingle) Deletes as specified by the TDelete.
boolean	exists(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TGet get) Test for the existence of columns in the table, as specified in the TGet.
List<Boolean>	existsAll(ByteBuffer table, List<org.apache.hadoop.hbase.thrift2.generated.TGet> gets) Test for the existence of columns in the table, as specified by the TGets.
org.apache.hadoop.hbase.thrift2.generated.TResult	get(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TGet get) Method for getting data from a row.
List<org.apache.hadoop.hbase.thrift2.generated.THRegionLocation>	getAllRegionLocations(ByteBuffer table) Get all of the region locations for a given table.
private RegionLocator	getLocator(ByteBuffer tableName)
List<org.apache.hadoop.hbase.thrift2.generated.TResult>	getMultiple(ByteBuffer table, List<org.apache.hadoop.hbase.thrift2.generated.TGet> gets) Method for getting multiple rows.
org.apache.hadoop.hbase.thrift2.generated.THRegionLocation	getRegionLocation(ByteBuffer table, ByteBuffer row, boolean reload) Given a table and a row get the location of the region that would contain the given row key.
private ResultScanner	getScanner(int id) Returns the Scanner associated with the specified Id.
List<org.apache.hadoop.hbase.thrift2.generated.TResult>	getScannerResults(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TScan scan, int numRows) Get results for the provided TScan object.
List<org.apache.hadoop.hbase.thrift2.generated.TResult>	getScannerRows(int scannerId, int numRows) Grabs multiple rows from a Scanner.
private Table	getTable(ByteBuffer tableName)
private org.apache.hadoop.hbase.thrift2.generated.TIOError	getTIOError(IOException e)
org.apache.hadoop.hbase.thrift2.generated.TResult	increment(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TIncrement increment)
private boolean	isReadOnly()
void	mutateRow(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TRowMutations rowMutations) mutateRow performs multiple mutations atomically on a single row.
static org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface	newInstance(org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface handler, ThriftMetrics metrics)
private static long	now()
int	openScanner(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TScan scan) Get a Scanner for the provided TScan object.
void	put(ByteBuffer table, org.apache.hadoop.hbase.thrift2.generated.TPut put) Commit a TPut to a table.
void	putMultiple(ByteBuffer table, List<org.apache.hadoop.hbase.thrift2.generated.TPut> puts) Commit a List of Puts to the table.
protected ResultScanner	removeScanner(int id) Removes the scanner associated with the specified ID from the internal HashMap.
(package private) void	setEffectiveUser(String effectiveUser)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

nextScannerId

private final AtomicInteger nextScannerId

scannerMap

private final Map<Integer,ResultScanner> scannerMap

connectionCache

private final ConnectionCache connectionCache

CLEANUP_INTERVAL

static final String CLEANUP_INTERVAL

See Also:

Constant Field Values

MAX_IDLETIME

static final String MAX_IDLETIME

See Also:

Constant Field Values

ioe

private static final IOException ioe

isReadOnly

private boolean isReadOnly

Constructor Detail

ThriftHBaseServiceHandler

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

Throws:

IOException

Method Detail

newInstance

public static org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface newInstance(org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface handler,
                                                                                        ThriftMetrics metrics)

now

private static long now()

getTable

private Table getTable(ByteBuffer tableName)

getLocator

private RegionLocator getLocator(ByteBuffer tableName)

closeTable

private void closeTable(Table table)
                 throws org.apache.hadoop.hbase.thrift2.generated.TIOError

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

getTIOError

private org.apache.hadoop.hbase.thrift2.generated.TIOError getTIOError(IOException e)

addScanner

private int addScanner(ResultScanner scanner)

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

Parameters:

scanner - to add

Returns:

Id for this Scanner

getScanner

private ResultScanner getScanner(int id)

Returns the Scanner associated with the specified Id.

Parameters:

id - of the Scanner to get

Returns:

a Scanner, or null if the Id is invalid

setEffectiveUser

void setEffectiveUser(String effectiveUser)

removeScanner

protected ResultScanner removeScanner(int id)

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

Parameters:

id - of the Scanner to remove

Returns:

the removed Scanner, or null if the Id is invalid

exists

public boolean exists(ByteBuffer table,
                      org.apache.hadoop.hbase.thrift2.generated.TGet get)
               throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                      org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Test for the existence of columns in the table, as specified in the TGet.

Specified by:

exists in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to check on

get - the TGet to check for

Returns:

true if the specified TGet matches one or more keys, false if not

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

existsAll

public List<Boolean> existsAll(ByteBuffer table,
                               List<org.apache.hadoop.hbase.thrift2.generated.TGet> gets)
                        throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                               org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Test for the existence of columns in the table, as specified by the TGets. This will return an array of booleans. Each value will be true if the related Get matches one or more keys, false if not.

Specified by:

existsAll in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to check on

gets - a list of TGets to check for

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

get

public org.apache.hadoop.hbase.thrift2.generated.TResult get(ByteBuffer table,
                                                             org.apache.hadoop.hbase.thrift2.generated.TGet get)
                                                      throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                             org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Method for getting data from a row. If the row cannot be found an empty Result is returned. This can be checked by the empty field of the TResult

Specified by:

get in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to get from

get - the TGet to fetch

Returns:

the result

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

getMultiple

public List<org.apache.hadoop.hbase.thrift2.generated.TResult> getMultiple(ByteBuffer table,
                                                                           List<org.apache.hadoop.hbase.thrift2.generated.TGet> gets)
                                                                    throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                           org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Method for getting multiple rows. If a row cannot be found there will be a null value in the result list for that TGet at the same position. So the Results are in the same order as the TGets.

Specified by:

getMultiple in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to get from

gets - a list of TGets to fetch, the Result list will have the Results at corresponding positions or null if there was an error

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

put

public void put(ByteBuffer table,
                org.apache.hadoop.hbase.thrift2.generated.TPut put)
         throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Commit a TPut to a table.

Specified by:

put in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to put data in

put - the TPut to put

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

checkAndPut

public boolean checkAndPut(ByteBuffer table,
                           ByteBuffer row,
                           ByteBuffer family,
                           ByteBuffer qualifier,
                           ByteBuffer value,
                           org.apache.hadoop.hbase.thrift2.generated.TPut put)
                    throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                           org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the TPut.

Specified by:

checkAndPut in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - to check in and put to

row - row to check

family - column family to check

qualifier - column qualifier to check

value - the expected value, if not provided the check is for the non-existence of the column in question

put - the TPut to put if the check succeeds

Returns:

true if the new put was executed, false otherwise

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

putMultiple

public void putMultiple(ByteBuffer table,
                        List<org.apache.hadoop.hbase.thrift2.generated.TPut> puts)
                 throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                        org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Commit a List of Puts to the table.

Specified by:

putMultiple in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to put data in

puts - a list of TPuts to commit

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

deleteSingle

public void deleteSingle(ByteBuffer table,
                         org.apache.hadoop.hbase.thrift2.generated.TDelete deleteSingle)
                  throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                         org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Deletes as specified by the TDelete. Note: "delete" is a reserved keyword and cannot be used in Thrift thus the inconsistent naming scheme from the other functions.

Specified by:

deleteSingle in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to delete from

deleteSingle - the TDelete to delete

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

deleteMultiple

public List<org.apache.hadoop.hbase.thrift2.generated.TDelete> deleteMultiple(ByteBuffer table,
                                                                              List<org.apache.hadoop.hbase.thrift2.generated.TDelete> deletes)
                                                                       throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                              org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Bulk commit a List of TDeletes to the table. Throws a TIOError if any of the deletes fail. Always returns an empty list for backwards compatibility.

Specified by:

deleteMultiple in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to delete from

deletes - list of TDeletes to delete

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

checkAndMutate

public boolean checkAndMutate(ByteBuffer table,
                              ByteBuffer row,
                              ByteBuffer family,
                              ByteBuffer qualifier,
                              org.apache.hadoop.hbase.thrift2.generated.TCompareOp compareOp,
                              ByteBuffer value,
                              org.apache.hadoop.hbase.thrift2.generated.TRowMutations rowMutations)
                       throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                              org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it mutates the row.

Specified by:

checkAndMutate in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - to check in and delete from

row - row to check

family - column family to check

qualifier - column qualifier to check

compareOp - comparison to make on the value

value - the expected value to be compared against, if not provided the check is for the non-existence of the column in question

rowMutations - row mutations to execute if the value matches

Returns:

true if the row was mutated, false otherwise

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

checkAndDelete

public boolean checkAndDelete(ByteBuffer table,
                              ByteBuffer row,
                              ByteBuffer family,
                              ByteBuffer qualifier,
                              ByteBuffer value,
                              org.apache.hadoop.hbase.thrift2.generated.TDelete deleteSingle)
                       throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                              org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the delete.

Specified by:

checkAndDelete in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - to check in and delete from

row - row to check

family - column family to check

qualifier - column qualifier to check

value - the expected value, if not provided the check is for the non-existence of the column in question

deleteSingle - the TDelete to execute if the check succeeds

Returns:

true if the new delete was executed, false otherwise

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

increment

public org.apache.hadoop.hbase.thrift2.generated.TResult increment(ByteBuffer table,
                                                                   org.apache.hadoop.hbase.thrift2.generated.TIncrement increment)
                                                            throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                   org.apache.thrift.TException

Specified by:

increment in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

append

public org.apache.hadoop.hbase.thrift2.generated.TResult append(ByteBuffer table,
                                                                org.apache.hadoop.hbase.thrift2.generated.TAppend append)
                                                         throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                org.apache.thrift.TException

Specified by:

append in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

openScanner

public int openScanner(ByteBuffer table,
                       org.apache.hadoop.hbase.thrift2.generated.TScan scan)
                throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                       org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Get a Scanner for the provided TScan object.

Specified by:

openScanner in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to get the Scanner for

scan - the scan object to get a Scanner for

Returns:

Scanner Id to be used with other scanner procedures

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

getScannerRows

public List<org.apache.hadoop.hbase.thrift2.generated.TResult> getScannerRows(int scannerId,
                                                                              int numRows)
                                                                       throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                              org.apache.hadoop.hbase.thrift2.generated.TIllegalArgument,
                                                                              org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Grabs multiple rows from a Scanner.

Specified by:

getScannerRows in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

scannerId - the Id of the Scanner to return rows from. This is an Id returned from the openScanner function.

numRows - number of rows to return

Returns:

Between zero and numRows TResults

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.hadoop.hbase.thrift2.generated.TIllegalArgument

org.apache.thrift.TException

getScannerResults

public List<org.apache.hadoop.hbase.thrift2.generated.TResult> getScannerResults(ByteBuffer table,
                                                                                 org.apache.hadoop.hbase.thrift2.generated.TScan scan,
                                                                                 int numRows)
                                                                          throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                                 org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Get results for the provided TScan object. This helper function opens a scanner, get the results and close the scanner.

Specified by:

getScannerResults in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - the table to get the Scanner for

scan - the scan object to get a Scanner for

numRows - number of rows to return

Returns:

between zero and numRows TResults

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

closeScanner

public void closeScanner(int scannerId)
                  throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                         org.apache.hadoop.hbase.thrift2.generated.TIllegalArgument,
                         org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Closes the scanner. Should be called to free server side resources timely. Typically close once the scanner is not needed anymore, i.e. after looping over it to get all the required rows.

Specified by:

closeScanner in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

scannerId - the Id of the Scanner to close *

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.hadoop.hbase.thrift2.generated.TIllegalArgument

org.apache.thrift.TException

mutateRow

public void mutateRow(ByteBuffer table,
                      org.apache.hadoop.hbase.thrift2.generated.TRowMutations rowMutations)
               throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                      org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

mutateRow performs multiple mutations atomically on a single row.

Specified by:

mutateRow in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Parameters:

table - table to apply the mutations

rowMutations - mutations to apply

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

getAllRegionLocations

public List<org.apache.hadoop.hbase.thrift2.generated.THRegionLocation> getAllRegionLocations(ByteBuffer table)
                                                                                       throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                                              org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Get all of the region locations for a given table.

Specified by:

getAllRegionLocations in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

getRegionLocation

public org.apache.hadoop.hbase.thrift2.generated.THRegionLocation getRegionLocation(ByteBuffer table,
                                                                                    ByteBuffer row,
                                                                                    boolean reload)
                                                                             throws org.apache.hadoop.hbase.thrift2.generated.TIOError,
                                                                                    org.apache.thrift.TException

Description copied from interface: org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Given a table and a row get the location of the region that would contain the given row key. reload = true means the cache will be cleared and the location will be fetched from meta.

Specified by:

getRegionLocation in interface org.apache.hadoop.hbase.thrift2.generated.THBaseService.Iface

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

org.apache.thrift.TException

checkReadOnlyMode

private void checkReadOnlyMode()
                        throws org.apache.hadoop.hbase.thrift2.generated.TIOError

Throws:

org.apache.hadoop.hbase.thrift2.generated.TIOError

isReadOnly

private boolean isReadOnly()