Package org.apache.hadoop.hbase.client

Class AsyncConnectionImpl

java.lang.Object

org.apache.hadoop.hbase.client.AsyncConnectionImpl

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncConnection

Direct Known Subclasses:

AsyncClusterConnectionImpl

@Private
public class AsyncConnectionImpl
extends Object
implements AsyncConnection

The implementation of AsyncConnection.

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentMap<String,org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface>	adminStubs
private final ClientBackoffPolicy	backoffPolicy
(package private) final AsyncRpcRetryingCallerFactory	callerFactory
private ChoreService	choreService
private final AtomicBoolean	closed
private final ClusterStatusListener	clusterStatusListener
private final org.apache.hadoop.conf.Configuration	conf
private ConnectionOverAsyncConnection	conn
(package private) final AsyncConnectionConfiguration	connConf
private final AsyncRegionLocator	locator
private static final org.slf4j.Logger	LOG
private final AtomicReference<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface>	masterStub
private final AtomicReference<CompletableFuture<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface>>	masterStubMakeFuture
private final Optional<MetricsConnection>	metrics
private final String	metricsScope
private final NonceGenerator	nonceGenerator
(package private) final ConnectionRegistry	registry
(package private) static final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer	RETRY_TIMER
protected final RpcClient	rpcClient
(package private) final RpcControllerFactory	rpcControllerFactory
protected final int	rpcTimeout
private final ConcurrentMap<String,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface>	rsStubs
private final Optional<ServerStatisticTracker>	stats
protected final User	user

Constructor Summary

Constructors

Constructor	Description
AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf, ConnectionRegistry registry, String clusterId, SocketAddress localAddress, User user)
AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf, ConnectionRegistry registry, String clusterId, SocketAddress localAddress, User user, Map<String,byte[]> connectionAttributes)

Method Summary

Modifier and Type	Method	Description
(package private) void	clearMasterStubCache(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface stub)
void	clearRegionLocationCache()	Clear all the entries in the region location cache, for all the tables.
void	close()
private org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface	createAdminServerStub(ServerName serverName)
private org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface	createMasterStub(ServerName serverName)
private org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface	createRegionServerStub(ServerName serverName)
AsyncAdminBuilder	getAdminBuilder()	Returns an AsyncAdminBuilder for creating AsyncAdmin.
AsyncAdminBuilder	getAdminBuilder(ExecutorService pool)	Returns an AsyncAdminBuilder for creating AsyncAdmin.
(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface	getAdminStub(ServerName serverName)
(package private) ClientBackoffPolicy	getBackoffPolicy()
AsyncBufferedMutatorBuilder	getBufferedMutatorBuilder(TableName tableName)	Returns an AsyncBufferedMutatorBuilder for creating AsyncBufferedMutator.
AsyncBufferedMutatorBuilder	getBufferedMutatorBuilder(TableName tableName, ExecutorService pool)	Returns an AsyncBufferedMutatorBuilder for creating AsyncBufferedMutator.
(package private) ChoreService	getChoreService()	If choreService has not been created yet, create the ChoreService.
(package private) String	getClusterId()
org.apache.hadoop.conf.Configuration	getConfiguration()	Returns the Configuration object used by this instance.
(package private) Optional<MetricsConnection>	getConnectionMetrics()
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.
private Hbck	getHbckInternal(ServerName masterServer)
(package private) AsyncRegionLocator	getLocator()
(package private) CompletableFuture<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface>	getMasterStub()
(package private) NonceGenerator	getNonceGenerator()
AsyncTableRegionLocator	getRegionLocator(TableName tableName)	Retrieve a AsyncRegionLocator implementation to inspect region information on a table.
(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface	getRegionServerStub(ServerName serverName)
(package private) Optional<ServerStatisticTracker>	getStatisticsTracker()
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.
private void	logCallStack(StackTraceElement[] stackTraceElements)
private void	spawnRenewalChore(org.apache.hadoop.security.UserGroupInformation user)
Connection	toConnection()	Convert this connection to a Connection.

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

Field Details

LOG

private static final org.slf4j.Logger LOG

RETRY_TIMER

static final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer RETRY_TIMER

conf

private final org.apache.hadoop.conf.Configuration conf

connConf

final AsyncConnectionConfiguration connConf

user

protected final User user

registry

final ConnectionRegistry registry

rpcTimeout

protected final int rpcTimeout

rpcClient

protected final RpcClient rpcClient

rpcControllerFactory

final RpcControllerFactory rpcControllerFactory

locator

private final AsyncRegionLocator locator

callerFactory

final AsyncRpcRetryingCallerFactory callerFactory

nonceGenerator

private final NonceGenerator nonceGenerator

rsStubs

private final ConcurrentMap<String,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface> rsStubs

adminStubs

private final ConcurrentMap<String,org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface> adminStubs

masterStub

private final AtomicReference<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface> masterStub

masterStubMakeFuture

private final AtomicReference<CompletableFuture<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface>> masterStubMakeFuture

stats

private final Optional<ServerStatisticTracker> stats

backoffPolicy

private final ClientBackoffPolicy backoffPolicy

choreService

private ChoreService choreService

closed

private final AtomicBoolean closed

metricsScope

private final String metricsScope

metrics

private final Optional<MetricsConnection> metrics

clusterStatusListener

private final ClusterStatusListener clusterStatusListener

conn

private volatile ConnectionOverAsyncConnection conn

Constructor Details

AsyncConnectionImpl

public AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf,
 ConnectionRegistry registry,
 String clusterId,
 SocketAddress localAddress,
 User user)

AsyncConnectionImpl

public AsyncConnectionImpl(org.apache.hadoop.conf.Configuration conf,
 ConnectionRegistry registry,
 String clusterId,
 SocketAddress localAddress,
 User user,
 Map<String,byte[]> connectionAttributes)

Method Details

spawnRenewalChore

private void spawnRenewalChore(org.apache.hadoop.security.UserGroupInformation user)

getChoreService

ChoreService getChoreService()

If choreService has not been created yet, create the ChoreService.

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

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

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

logCallStack

private void logCallStack(StackTraceElement[] stackTraceElements)

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

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

getLocator

AsyncRegionLocator getLocator()

getNonceGenerator

NonceGenerator getNonceGenerator()

createRegionServerStub

private org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface createRegionServerStub(ServerName serverName)
                                                                                                               throws IOException

Throws:

IOException

getRegionServerStub

org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface getRegionServerStub(ServerName serverName)
                                                                                                    throws IOException

Throws:

IOException

createMasterStub

private org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface createMasterStub(ServerName serverName)
                                                                                                         throws IOException

Throws:

IOException

createAdminServerStub

private org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface createAdminServerStub(ServerName serverName)
                                                                                                            throws IOException

Throws:

IOException

getAdminStub

org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.Interface getAdminStub(ServerName serverName)
                                                                                           throws IOException

Throws:

IOException

getMasterStub

CompletableFuture<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface> getMasterStub()

getClusterId

String getClusterId()

clearMasterStubCache

void clearMasterStubCache(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.Interface stub)

getStatisticsTracker

Optional<ServerStatisticTracker> getStatisticsTracker()

getBackoffPolicy

ClientBackoffPolicy getBackoffPolicy()

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

toConnection

public Connection toConnection()

Description copied from interface: AsyncConnection

Convert this connection to a Connection.

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:

toConnection in interface AsyncConnection

getHbckInternal

private Hbck getHbckInternal(ServerName masterServer)

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

getConnectionMetrics

Optional<MetricsConnection> getConnectionMetrics()