Package org.apache.hadoop.hbase.thrift2.client

Class ThriftConnection

java.lang.Object

org.apache.hadoop.hbase.thrift2.client.ThriftConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, Connection

@Private
public class ThriftConnection
extends Object
implements Connection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThriftConnection.DefaultThriftClientBuilder	the default thrift client builder.
static class	ThriftConnection.DelayRetryHandler
static class	ThriftConnection.HTTPThriftClientBuilder	the default thrift http client builder.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ThriftClientBuilder	clientBuilder
private org.apache.hadoop.conf.Configuration	conf
private int	connectTimeout
private String	host
private org.apache.http.client.HttpClient	httpClient
private boolean	httpClientCreated
private boolean	isClosed
private boolean	isCompact
private boolean	isFramed
private static final org.slf4j.Logger	LOG
private int	operationTimeout
private int	port
private User	user

Constructor Summary

Constructors

Constructor	Description
ThriftConnection(org.apache.hadoop.conf.Configuration conf, ExecutorService pool, User user, Map<String,byte[]> connectionAttributes)

Method Summary

Modifier and Type	Method	Description
void	abort(String why, Throwable e)	Abort the server or client.
void	clearRegionLocationCache()	Clear all the entries in the region location cache, for all the tables.
void	close()
Admin	getAdmin()	Get a ThriftAdmin, ThriftAdmin is NOT thread safe
BufferedMutator	getBufferedMutator(BufferedMutatorParams params)	Retrieve a BufferedMutator for performing client-side buffering of writes.
BufferedMutator	getBufferedMutator(TableName tableName)	Retrieve a BufferedMutator for performing client-side buffering of writes.
String	getClusterId()	Returns the cluster ID unique to this HBase cluster.
org.apache.hadoop.conf.Configuration	getConfiguration()	Returns Configuration instance being used by this Connection instance.
int	getConnectTimeout()
String	getHost()
org.apache.http.client.HttpClient	getHttpClient()
int	getOperationTimeout()
int	getPort()
RegionLocator	getRegionLocator(TableName tableName)	Retrieve a RegionLocator implementation to inspect region information on a table.
TableBuilder	getTableBuilder(TableName tableName, ExecutorService pool)	Get a TableBuider to build ThriftTable, ThriftTable is NOT thread safe
boolean	isAborted()	Check if the server or client was aborted.
boolean	isClosed()	Returns whether the connection is closed or not.
boolean	isCompact()
boolean	isFramed()
void	setHttpClient(org.apache.http.client.HttpClient httpClient)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.Abortable

abort

Methods inherited from interface org.apache.hadoop.hbase.client.Connection

getHbck, getHbck, getTable, getTable

Field Details

LOG

private static final org.slf4j.Logger LOG

conf

private org.apache.hadoop.conf.Configuration conf

user

private User user

httpClient

private org.apache.http.client.HttpClient httpClient

httpClientCreated

private boolean httpClientCreated

isClosed

private boolean isClosed

host

private String host

port

private int port

isFramed

private boolean isFramed

isCompact

private boolean isCompact

clientBuilder

ThriftClientBuilder clientBuilder

operationTimeout

private int operationTimeout

connectTimeout

private int connectTimeout

Constructor Details

ThriftConnection

public ThriftConnection(org.apache.hadoop.conf.Configuration conf,
 ExecutorService pool,
 User user,
 Map<String,byte[]> connectionAttributes)
                 throws IOException

Throws:

IOException

Method Details

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

getConfiguration

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

Description copied from interface: Connection

Returns Configuration instance being used by this Connection instance.

Specified by:

getConfiguration in interface Connection

getHost

public String getHost()

getPort

public int getPort()

isFramed

public boolean isFramed()

isCompact

public boolean isCompact()

getOperationTimeout

public int getOperationTimeout()

getConnectTimeout

public int getConnectTimeout()

getAdmin

public Admin getAdmin()
               throws IOException

Get a ThriftAdmin, ThriftAdmin is NOT thread safe

Specified by:

getAdmin in interface Connection

Returns:

a ThriftAdmin

Throws:

IOException - IOException

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Connection

Throws:

IOException

isClosed

public boolean isClosed()

Description copied from interface: Connection

Returns whether the connection is closed or not.

Specified by:

isClosed in interface Connection

Returns:

true if this connection is closed

getTableBuilder

public TableBuilder getTableBuilder(TableName tableName,
 ExecutorService pool)

Get a TableBuider to build ThriftTable, ThriftTable is NOT thread safe

Specified by:

getTableBuilder in interface Connection

Parameters:

tableName - the name of the table

pool - the thread pool to use for requests like batch and scan

Returns:

a TableBuilder

Throws:

IOException - IOException

abort

public void abort(String why,
 Throwable e)

Description copied from interface: Abortable

Abort the server or client.

Specified by:

abort in interface Abortable

Parameters:

why - Why we're aborting.

e - Throwable that caused abort. Can be null.

isAborted

public boolean isAborted()

Description copied from interface: Abortable

Check if the server or client was aborted.

Specified by:

isAborted in interface Abortable

Returns:

true if the server or client was aborted, false otherwise

getBufferedMutator

public BufferedMutator getBufferedMutator(TableName tableName)
                                   throws IOException

Description copied from interface: Connection

Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This accessor will create a new ThreadPoolExecutor and will be shutdown once we close the BufferedMutator. This object can be used for long lived operations.

The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.

Specified by:

getBufferedMutator in interface Connection

Parameters:

tableName - the name of the table

Returns:

a BufferedMutator for the supplied tableName.

Throws:

IOException

getBufferedMutator

public BufferedMutator getBufferedMutator(BufferedMutatorParams params)
                                   throws IOException

Description copied from interface: Connection

Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This object can be used for long lived table operations. If user passes ThreadPool in BufferedMutatorParams then we will use that otherwise we will create for the user. For user specified ThreadPool, it is the user's responsibility to shutdown. For ThreadPool created by us, we will shutdown when user calls BufferedMutator.close(). The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.

Specified by:

getBufferedMutator in interface Connection

Parameters:

params - details on how to instantiate the BufferedMutator.

Returns:

a BufferedMutator for the supplied tableName.

Throws:

IOException

getRegionLocator

public RegionLocator getRegionLocator(TableName tableName)
                               throws IOException

Description copied from interface: Connection

Retrieve a RegionLocator implementation to inspect region information on a table. The returned RegionLocator is not thread-safe, so a new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither required nor desired.
The caller is responsible for calling Closeable.close() on the returned RegionLocator instance. RegionLocator needs to be unmanaged

Specified by:

getRegionLocator in interface Connection

Parameters:

tableName - Name of the table who's region is to be examined

Returns:

A RegionLocator instance

Throws:

IOException

clearRegionLocationCache

public void clearRegionLocationCache()

Description copied from interface: Connection

Clear all the entries in the region location cache, for all the tables.

If you only want to clear the cache for a specific table, use RegionLocator.clearRegionLocationCache().

This may cause performance issue so use it with caution.

Specified by:

clearRegionLocationCache in interface Connection

getClusterId

public String getClusterId()

Description copied from interface: Connection

Returns the cluster ID unique to this HBase cluster.
The default implementation is added to keep client compatibility.

Specified by:

getClusterId in interface Connection