AsyncConnectionImpl (Apache HBase

java.lang.Object
- org.apache.hadoop.hbase.client.AsyncConnectionImpl

All Implemented Interfaces:: Closeable, AutoCloseable, AsyncConnection

@InterfaceAudience.Private
public class AsyncConnectionImpl
extends Object
implements AsyncConnection

The implementation of AsyncConnection.

Constructor Summary

Constructors
Constructor and Description
`AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf, ConnectionRegistry registry, String clusterId, User user)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearRegionLocationCache()` Clear all the entries in the region location cache, for all the tables.
`void`	`close()`
`AsyncAdminBuilder`	`getAdminBuilder()` Returns an `AsyncAdminBuilder` for creating `AsyncAdmin`.
`AsyncAdminBuilder`	`getAdminBuilder(ExecutorService pool)` Returns an `AsyncAdminBuilder` for creating `AsyncAdmin`.
`AsyncBufferedMutatorBuilder`	`getBufferedMutatorBuilder(TableName tableName)` Returns an `AsyncBufferedMutatorBuilder` for creating `AsyncBufferedMutator`.
`AsyncBufferedMutatorBuilder`	`getBufferedMutatorBuilder(TableName tableName, ExecutorService pool)` Returns an `AsyncBufferedMutatorBuilder` for creating `AsyncBufferedMutator`.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()` Returns the `Configuration` object used by this instance.
`ConnectionRegistry`	`getConnectionRegistry()`
`CompletableFuture<Hbck>`	`getHbck()` Retrieve an Hbck implementation to fix an HBase cluster.
`Hbck`	`getHbck(ServerName masterServer)` Retrieve an Hbck implementation to fix an HBase cluster.
`NonceGenerator`	`getNonceGenerator()`
`AsyncTableRegionLocator`	`getRegionLocator(TableName tableName)` Retrieve a AsyncRegionLocator implementation to inspect region information on a table.
`AsyncTableBuilder<AdvancedScanResultConsumer>`	`getTableBuilder(TableName tableName)` Returns an `AsyncTableBuilder` for creating `AsyncTable`.
`AsyncTableBuilder<ScanResultConsumer>`	`getTableBuilder(TableName tableName, ExecutorService pool)` Returns an `AsyncTableBuilder` for creating `AsyncTable`.
`User`	`getUser()`
`boolean`	`isClosed()` Returns whether the connection is closed or not.

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.client.AsyncConnection
getAdmin, getAdmin, getBufferedMutator, getBufferedMutator, getTable, getTable

- Constructor Detail
  - AsyncConnectionImpl
```
public AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf,
                           ConnectionRegistry registry,
                           String clusterId,
                           User user)
```
- Method Detail
  - getUser
```
public User getUser()
```
  - getConnectionRegistry
```
public ConnectionRegistry getConnectionRegistry()
```
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    Description copied from interface: AsyncConnection
    
    Returns the Configuration object used by this instance.
    The reference returned is not a copy, so any change made to it will affect this instance.
    
    Specified by:
    
    getConfiguration in interface AsyncConnection
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: AsyncConnection
    
    Returns whether the connection is closed or not.
    
    Specified by:
    
    isClosed in interface AsyncConnection
    
    Returns:
    
    true if this connection is closed
  - getRegionLocator
```
public AsyncTableRegionLocator getRegionLocator(TableName tableName)
```
    Description copied from interface: AsyncConnection
    
    Retrieve a AsyncRegionLocator implementation to inspect region information on a table. The returned AsyncRegionLocator 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 AsyncRegionLocator is neither required nor desired.
    
    Specified by:
    
    getRegionLocator in interface AsyncConnection
    
    Parameters:
    
    tableName - Name of the table who's region is to be examined
    
    Returns:
    
    An AsyncRegionLocator instance
  - getNonceGenerator
```
public NonceGenerator getNonceGenerator()
```
  - getTableBuilder
```
public AsyncTableBuilder<AdvancedScanResultConsumer> getTableBuilder(TableName tableName)
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncTableBuilder for creating AsyncTable.
    This method no longer checks table existence. An exception will be thrown if the table does not exist only when the first operation is attempted.
    
    Specified by:
    
    getTableBuilder in interface AsyncConnection
    
    Parameters:
    
    tableName - the name of the table
  - getTableBuilder
```
public AsyncTableBuilder<ScanResultConsumer> getTableBuilder(TableName tableName,
                                                             ExecutorService pool)
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncTableBuilder for creating AsyncTable.
    This method no longer checks table existence. An exception will be thrown if the table does not exist only when the first operation is attempted.
    
    Specified by:
    
    getTableBuilder in interface AsyncConnection
    
    Parameters:
    
    tableName - the name of the table
    
    pool - the thread pool to use for executing callback
  - getAdminBuilder
```
public AsyncAdminBuilder getAdminBuilder()
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncAdminBuilder for creating AsyncAdmin.
    The admin operation's returned CompletableFuture will be finished directly in the rpc framework's callback thread, so typically you should not do any time consuming work inside these methods.
    
    Specified by:
    
    getAdminBuilder in interface AsyncConnection
  - getAdminBuilder
```
public AsyncAdminBuilder getAdminBuilder(ExecutorService pool)
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncAdminBuilder for creating AsyncAdmin.
    
    Specified by:
    
    getAdminBuilder in interface AsyncConnection
    
    Parameters:
    
    pool - the thread pool to use for executing callback
  - getBufferedMutatorBuilder
```
public AsyncBufferedMutatorBuilder getBufferedMutatorBuilder(TableName tableName)
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncBufferedMutatorBuilder for creating AsyncBufferedMutator.
    
    Specified by:
    
    getBufferedMutatorBuilder in interface AsyncConnection
    
    Parameters:
    
    tableName - the name of the table
  - getBufferedMutatorBuilder
```
public AsyncBufferedMutatorBuilder getBufferedMutatorBuilder(TableName tableName,
                                                             ExecutorService pool)
```
    Description copied from interface: AsyncConnection
    
    Returns an AsyncBufferedMutatorBuilder for creating AsyncBufferedMutator.
    
    Specified by:
    
    getBufferedMutatorBuilder in interface AsyncConnection
    
    Parameters:
    
    tableName - the name of the table
    
    pool - the thread pool to use for executing callback
  - getHbck
```
public CompletableFuture<Hbck> getHbck()
```
    Description copied from interface: AsyncConnection
    
    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 AsyncConnection
    
    Returns:
    
    an Hbck instance for active master. Active master is fetched from the zookeeper.
  - getHbck
```
public Hbck getHbck(ServerName masterServer)
```
    Description copied from interface: AsyncConnection
    
    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 AsyncConnection
    
    Parameters:
    
    masterServer - explicit ServerName for master server
    
    Returns:
    
    an Hbck instance for a specified master server
  - clearRegionLocationCache
```
public void clearRegionLocationCache()
```
    Description copied from interface: AsyncConnection
    
    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 AsyncTableRegionLocator.clearRegionLocationCache().
    This may cause performance issue so use it with caution.
    
    Specified by:
    
    clearRegionLocationCache in interface AsyncConnection

Class AsyncConnectionImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncConnectionImpl

Method Detail

getUser

getConnectionRegistry

getConfiguration

close

isClosed

getRegionLocator

getNonceGenerator

getTableBuilder

getTableBuilder

getAdminBuilder

getAdminBuilder

getBufferedMutatorBuilder

getBufferedMutatorBuilder

getHbck

getHbck

clearRegionLocationCache