Package org.apache.hadoop.hbase.client

Class ConnectionOverAsyncConnection

java.lang.Object

org.apache.hadoop.hbase.client.ConnectionOverAsyncConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, Connection

@Private
class ConnectionOverAsyncConnection
extends Object
implements Connection

The connection implementation based on AsyncConnection.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	aborted
private ExecutorService	batchPool
private final AsyncConnectionImpl	conn
private final ConnectionConfiguration	connConf
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
ConnectionOverAsyncConnection(AsyncConnectionImpl conn)

Method Summary

Modifier and Type	Method	Description
void	abort(String why, Throwable error)	Abort the server or client.
void	clearRegionLocationCache()	Clear all the entries in the region location cache, for all the tables.
void	close()
(package private) void	closePool()
private ThreadPoolExecutor	createThreadPool()
Admin	getAdmin()	Retrieve an Admin implementation to administer an HBase cluster.
private ExecutorService	getBatchPool()
BufferedMutator	getBufferedMutator(BufferedMutatorParams params)	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.
Hbck	getHbck()	Retrieve an Hbck implementation to fix an HBase cluster.
Hbck	getHbck(ServerName masterServer)	Retrieve an Hbck implementation to fix an HBase cluster.
RegionLocator	getRegionLocator(TableName tableName)	Retrieve a RegionLocator implementation to inspect region information on a table.
TableBuilder	getTableBuilder(TableName tableName, ExecutorService pool)	Returns an TableBuilder for creating Table.
boolean	isAborted()	Check if the server or client was aborted.
boolean	isClosed()	Returns whether the connection is closed or not.
AsyncConnection	toAsyncConnection()	Convert this connection to an AsyncConnection.
String	toString()	An identifier that will remain the same for a given connection.

Methods inherited from class java.lang.Object

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

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

abort

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

getBufferedMutator, getTable, getTable

Field Details

LOG

private static final org.slf4j.Logger LOG

aborted

private volatile boolean aborted

batchPool

private volatile ExecutorService batchPool

conn

private final AsyncConnectionImpl conn

connConf

private final ConnectionConfiguration connConf

Constructor Details

ConnectionOverAsyncConnection

ConnectionOverAsyncConnection(AsyncConnectionImpl conn)

Method Details

abort

public void abort(String why,
 Throwable error)

Description copied from interface: Abortable

Abort the server or client.

Specified by:

abort in interface Abortable

Parameters:

why - Why we're aborting.

error - 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

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

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. 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

getAdmin

public Admin getAdmin()
               throws IOException

Description copied from interface: Connection

Retrieve an Admin implementation to administer an HBase cluster. The returned Admin is not guaranteed to be thread-safe. A new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned Admin is not recommended.
The caller is responsible for calling Admin.close() on the returned Admin instance.

Specified by:

getAdmin in interface Connection

Returns:

an Admin instance for cluster administration

Throws:

IOException

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

closePool

void closePool()

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

createThreadPool

private ThreadPoolExecutor createThreadPool()

getBatchPool

private ExecutorService getBatchPool()
                              throws IOException

Throws:

IOException

getTableBuilder

public TableBuilder getTableBuilder(TableName tableName,
 ExecutorService pool)

Description copied from interface: Connection

Returns an TableBuilder for creating Table.

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

toAsyncConnection

public AsyncConnection toAsyncConnection()

Description copied from interface: Connection

Convert this connection to an AsyncConnection.

Usually we will return the same instance if you call this method multiple times so you can consider this as a light-weighted operation.

Specified by:

toAsyncConnection 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

getHbck

public Hbck getHbck()
             throws IOException

Description copied from interface: Connection

Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
The caller is responsible for calling Closeable.close() on the returned Hbck instance.
This will be used mostly by hbck tool.

Specified by:

getHbck in interface Connection

Returns:

an Hbck instance for active master. Active master is fetched from the zookeeper.

Throws:

IOException

getHbck

public Hbck getHbck(ServerName masterServer)
             throws IOException

Description copied from interface: Connection

Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
The caller is responsible for calling Closeable.close() on the returned Hbck instance.
This will be used mostly by hbck tool. This may only be used to by pass getting registered master from ZK. In situations where ZK is not available or active master is not registered with ZK and user can get master address by other means, master can be explicitly specified.

Specified by:

getHbck in interface Connection

Parameters:

masterServer - explicit ServerName for master server

Returns:

an Hbck instance for a specified master server

Throws:

IOException

toString

public String toString()

An identifier that will remain the same for a given connection.

Overrides:

toString in class Object