org.apache.hadoop.hbase.client

Class ConnectionUtils.ShortCircuitingClusterConnection

java.lang.Object

org.apache.hadoop.hbase.client.ConnectionUtils.ShortCircuitingClusterConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, ClusterConnection, Connection

Enclosing class:

ConnectionUtils

public static class ConnectionUtils.ShortCircuitingClusterConnection
extends Object

A ClusterConnection that will short-circuit RPC making direct invocations against the localhost if the invocation target is 'this' server; save on network and protobuf invocations.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clusterId
static String	RETRIES_BY_SERVER_KEY
protected User	user

Fields inherited from interface org.apache.hadoop.hbase.client.ClusterConnection

HBASE_CLIENT_CONNECTION_IMPL

Method Summary

Modifier and Type	Method and Description
void	abort(String msg, Throwable t) Abort the server or client.
void	cacheLocation(TableName tableName, RegionLocations location) Put a newly discovered HRegionLocation into the cache.
void	clearCaches(ServerName serverName) Clear any caches that pertain to server name sn.
void	clearRegionCache() Allows flushing the region cache.
void	clearRegionCache(TableName tableName) Allows flushing the region cache of all locations that pertain to tableName
void	clearRegionCache(TableName tableName, byte[] row)
void	close()
void	deleteCachedRegionLocation(HRegionLocation location) Deletes cached locations for the specific region.
protected void	finalize() Close the connection for good.
Admin	getAdmin() Retrieve an Admin implementation to administer an HBase cluster.
AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName sn) Establishes a connection to the region server at the specified address.
AdminProtos.AdminService.BlockingInterface	getAdminForMaster() Get the admin service for master.
org.apache.hadoop.hbase.client.AsyncProcess	getAsyncProcess()
ClientBackoffPolicy	getBackoffPolicy()
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.
ClientProtos.ClientService.BlockingInterface	getClient(ServerName sn) Establishes a connection to the region server at the specified address, and returns a region client protocol.
org.apache.hadoop.conf.Configuration	getConfiguration()
ConnectionConfiguration	getConnectionConfiguration()
MetricsConnection	getConnectionMetrics()
protected ExecutorService	getCurrentBatchPool()
protected ExecutorService	getCurrentMetaLookupPool()
int	getCurrentNrHRS()
Hbck	getHbck() Retrieve an Hbck implementation to fix an HBase cluster.
Hbck	getHbck(ServerName masterServer) Retrieve an Hbck implementation to fix an HBase cluster.
org.apache.hadoop.hbase.client.MasterKeepAliveConnection	getMaster() Returns a MasterKeepAliveConnection to the active master
RpcRetryingCallerFactory	getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration conf) Returns a new RpcRetryingCallerFactory from the given Configuration.
NonceGenerator	getNonceGenerator()
HRegionLocation	getRegionLocation(TableName tableName, byte[] row, boolean reload) Find region location hosting passed row
RegionLocator	getRegionLocator(TableName tableName) Retrieve a RegionLocator implementation to inspect region information on a table.
RpcControllerFactory	getRpcControllerFactory()
RpcRetryingCallerFactory	getRpcRetryingCallerFactory()
ServerStatisticTracker	getStatisticsTracker()
Table	getTable(TableName tableName) Retrieve a Table implementation for accessing a table.
TableBuilder	getTableBuilder(TableName tableName, ExecutorService pool) Returns an TableBuilder for creating Table.
TableState	getTableState(TableName tableName) Retrieve TableState, represent current table state.
boolean	hasCellBlockSupport()
boolean	isAborted() Check if the server or client was aborted.
boolean	isClosed() Returns whether the connection is closed or not.
boolean	isMasterRunning() Deprecated. this has been deprecated without a replacement
boolean	isTableAvailable(TableName tableName, byte[][] splitKeys) Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table.
boolean	isTableDisabled(TableName tableName)
boolean	isTableEnabled(TableName tableName) A table that isTableEnabled == false and isTableDisabled == false is possible.
HRegionLocation	locateRegion(byte[] regionName) Gets the location of the region of regionName.
HRegionLocation	locateRegion(TableName tableName, byte[] row) Find the location of the region of tableName that row lives in.
RegionLocations	locateRegion(TableName tableName, byte[] row, boolean useCache, boolean retry)
RegionLocations	locateRegion(TableName tableName, byte[] row, boolean useCache, boolean retry, int replicaId)
List<HRegionLocation>	locateRegions(TableName tableName) Gets the locations of all regions in the specified table, tableName.
List<HRegionLocation>	locateRegions(TableName tableName, boolean useCache, boolean offlined) Gets the locations of all regions in the specified table, tableName.
HRegionLocation	relocateRegion(TableName tableName, byte[] row) Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.
RegionLocations	relocateRegion(TableName tableName, byte[] row, int replicaId) Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.
protected void	retrieveClusterId()
String	toString() An identifier that will remain the same for a given connection.
void	updateCachedLocations(TableName tableName, byte[] regionName, byte[] rowkey, Object exception, ServerName source) Update the location with the new value (if the exception is a RegionMovedException) or delete it from the cache.

Methods inherited from class java.lang.Object

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

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

getTable

Field Detail

RETRIES_BY_SERVER_KEY

public static final String RETRIES_BY_SERVER_KEY

See Also:

Constant Field Values

user

protected User user

clusterId

protected String clusterId

Method Detail

getAdmin

public AdminProtos.AdminService.BlockingInterface getAdmin(ServerName sn)
                                                    throws IOException

Description copied from interface: ClusterConnection

Establishes a connection to the region server at the specified address.

Specified by:

getAdmin in interface ClusterConnection

Parameters:

sn - the region server to connect to

Returns:

proxy for HRegionServer

Throws:

IOException - if a remote or network exception occurs

getClient

public ClientProtos.ClientService.BlockingInterface getClient(ServerName sn)
                                                       throws IOException

Description copied from interface: ClusterConnection

Establishes a connection to the region server at the specified address, and returns a region client protocol.

Specified by:

getClient in interface ClusterConnection

Parameters:

sn - the region server to connect to

Returns:

ClientProtocol proxy for RegionServer

Throws:

IOException - if a remote or network exception occurs

getMaster

public org.apache.hadoop.hbase.client.MasterKeepAliveConnection getMaster()
                                                                   throws IOException

Description copied from interface: ClusterConnection

Returns a MasterKeepAliveConnection to the active master

Specified by:

getMaster in interface ClusterConnection

Throws:

IOException

getTable

public Table getTable(TableName tableName)
               throws IOException

Description copied from interface: Connection

Retrieve a Table implementation for accessing a table. The returned Table is not thread safe, a new instance should be created for each using thread. This is a lightweight operation, pooling or caching of the returned Table is neither required nor desired.

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

Since 0.98.1 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:

getTable in interface Connection

Parameters:

tableName - the name of the table

Returns:

a Table to use for interactions with this table

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

getBufferedMutator

public BufferedMutator getBufferedMutator(BufferedMutatorParams params)

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.

getBufferedMutator

public BufferedMutator getBufferedMutator(TableName tableName)

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 BufferedMutator will use the Connection's ExecutorService. This object can be used for long lived operations.

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

This accessor will use the connection's ExecutorService and will throw an exception in the main thread when an asynchronous exception occurs.

Specified by:

getBufferedMutator in interface Connection

Parameters:

tableName - the name of the table

Returns:

a BufferedMutator for the supplied tableName.

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

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

getHbck

public Hbck getHbck()
             throws IOException

Description copied from interface: ClusterConnection

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 ClusterConnection

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: ClusterConnection

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 ClusterConnection

Parameters:

masterServer - explicit ServerName for master server

Returns:

an Hbck instance for a specified master server

Throws:

IOException

getConnectionMetrics

public MetricsConnection getConnectionMetrics()

Specified by:

getConnectionMetrics in interface ClusterConnection

Returns:

the MetricsConnection instance associated with this connection.

getCurrentMetaLookupPool

protected ExecutorService getCurrentMetaLookupPool()

getCurrentBatchPool

protected ExecutorService getCurrentBatchPool()

toString

public String toString()

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

Overrides:

toString in class Object

retrieveClusterId

protected void retrieveClusterId()

getConfiguration

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

Specified by:

getConfiguration in interface Connection

Returns:

Configuration instance being used by this Connection instance.

isMasterRunning

@Deprecated
public boolean isMasterRunning()
                                    throws MasterNotRunningException,
                                           ZooKeeperConnectionException

Deprecated. this has been deprecated without a replacement

Specified by:

isMasterRunning in interface ClusterConnection

Returns:

true if the master is running, throws an exception otherwise

Throws:

MasterNotRunningException - - if the master is not running

ZooKeeperConnectionException

getRegionLocation

public HRegionLocation getRegionLocation(TableName tableName,
                                         byte[] row,
                                         boolean reload)
                                  throws IOException

Description copied from interface: ClusterConnection

Find region location hosting passed row

Specified by:

getRegionLocation in interface ClusterConnection

Parameters:

tableName - table name

row - Row to find.

reload - If true do not use cache, otherwise bypass.

Returns:

Location of row.

Throws:

IOException - if a remote or network exception occurs

isTableEnabled

public boolean isTableEnabled(TableName tableName)
                       throws IOException

Description copied from interface: ClusterConnection

A table that isTableEnabled == false and isTableDisabled == false is possible. This happens when a table has a lot of regions that must be processed.

Specified by:

isTableEnabled in interface ClusterConnection

Parameters:

tableName - table name

Returns:

true if the table is enabled, false otherwise

Throws:

IOException - if a remote or network exception occurs

isTableDisabled

public boolean isTableDisabled(TableName tableName)
                        throws IOException

Specified by:

isTableDisabled in interface ClusterConnection

Parameters:

tableName - table name

Returns:

true if the table is disabled, false otherwise

Throws:

IOException - if a remote or network exception occurs

isTableAvailable

public boolean isTableAvailable(TableName tableName,
                                @Nullable
                                byte[][] splitKeys)
                         throws IOException

Description copied from interface: ClusterConnection

Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table. Note : If this api is used after a table's region gets splitted, the api may return false.

Specified by:

isTableAvailable in interface ClusterConnection

Parameters:

tableName - tableName

splitKeys - splitKeys used while creating table

Throws:

IOException - if a remote or network exception occurs

locateRegion

public HRegionLocation locateRegion(byte[] regionName)
                             throws IOException

Description copied from interface: ClusterConnection

Gets the location of the region of regionName.

Specified by:

locateRegion in interface ClusterConnection

Parameters:

regionName - name of the region to locate

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

locateRegions

public List<HRegionLocation> locateRegions(TableName tableName)
                                    throws IOException

Description copied from interface: ClusterConnection

Gets the locations of all regions in the specified table, tableName.

Specified by:

locateRegions in interface ClusterConnection

Parameters:

tableName - table to get regions of

Returns:

list of region locations for all regions of table

Throws:

IOException - if IO failure occurs

locateRegions

public List<HRegionLocation> locateRegions(TableName tableName,
                                           boolean useCache,
                                           boolean offlined)
                                    throws IOException

Description copied from interface: ClusterConnection

Gets the locations of all regions in the specified table, tableName.

Specified by:

locateRegions in interface ClusterConnection

Parameters:

tableName - table to get regions of

useCache - Should we use the cache to retrieve the region information.

offlined - True if we are to include offlined regions, false and we'll leave out offlined regions from returned list.

Returns:

list of region locations for all regions of table

Throws:

IOException - if IO failure occurs

locateRegion

public HRegionLocation locateRegion(TableName tableName,
                                    byte[] row)
                             throws IOException

Description copied from interface: ClusterConnection

Find the location of the region of tableName that row lives in.

Specified by:

locateRegion in interface ClusterConnection

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

relocateRegion

public HRegionLocation relocateRegion(TableName tableName,
                                      byte[] row)
                               throws IOException

Description copied from interface: ClusterConnection

Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.

Specified by:

relocateRegion in interface ClusterConnection

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

relocateRegion

public RegionLocations relocateRegion(TableName tableName,
                                      byte[] row,
                                      int replicaId)
                               throws IOException

Description copied from interface: ClusterConnection

Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.

Specified by:

relocateRegion in interface ClusterConnection

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

replicaId - the replicaId of the region

Returns:

RegionLocations that describe where to find the region in question

Throws:

IOException - if a remote or network exception occurs

locateRegion

public RegionLocations locateRegion(TableName tableName,
                                    byte[] row,
                                    boolean useCache,
                                    boolean retry)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Parameters:

tableName - table to get regions of

row - the row

useCache - Should we use the cache to retrieve the region information.

retry - do we retry

Returns:

region locations for this row.

Throws:

IOException - if IO failure occurs

locateRegion

public RegionLocations locateRegion(TableName tableName,
                                    byte[] row,
                                    boolean useCache,
                                    boolean retry,
                                    int replicaId)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Parameters:

tableName - table to get regions of

row - the row

useCache - Should we use the cache to retrieve the region information.

retry - do we retry

replicaId - the replicaId for the region

Returns:

region locations for this row.

Throws:

IOException - if IO failure occurs

cacheLocation

public void cacheLocation(TableName tableName,
                          RegionLocations location)

Put a newly discovered HRegionLocation into the cache.

Specified by:

cacheLocation in interface ClusterConnection

Parameters:

tableName - The table name.

location - the new location

clearRegionCache

public void clearRegionCache(TableName tableName,
                             byte[] row)

clearCaches

public void clearCaches(ServerName serverName)

Description copied from interface: ClusterConnection

Clear any caches that pertain to server name sn.

Specified by:

clearCaches in interface ClusterConnection

Parameters:

serverName - A server name

clearRegionCache

public void clearRegionCache()

Description copied from interface: ClusterConnection

Allows flushing the region cache.

Specified by:

clearRegionCache in interface ClusterConnection

clearRegionCache

public void clearRegionCache(TableName tableName)

Description copied from interface: ClusterConnection

Allows flushing the region cache of all locations that pertain to tableName

Specified by:

clearRegionCache in interface ClusterConnection

Parameters:

tableName - Name of the table whose regions we are to remove from cache.

getAdminForMaster

public AdminProtos.AdminService.BlockingInterface getAdminForMaster()
                                                             throws IOException

Description copied from interface: ClusterConnection

Get the admin service for master.

Specified by:

getAdminForMaster in interface ClusterConnection

Throws:

IOException

deleteCachedRegionLocation

public void deleteCachedRegionLocation(HRegionLocation location)

Description copied from interface: ClusterConnection

Deletes cached locations for the specific region.

Specified by:

deleteCachedRegionLocation in interface ClusterConnection

Parameters:

location - The location object for the region, to be purged from cache.

updateCachedLocations

public void updateCachedLocations(TableName tableName,
                                  byte[] regionName,
                                  byte[] rowkey,
                                  Object exception,
                                  ServerName source)

Update the location with the new value (if the exception is a RegionMovedException) or delete it from the cache. Does nothing if we can be sure from the exception that the location is still accurate, or if the cache has already been updated.

Specified by:

updateCachedLocations in interface ClusterConnection

Parameters:

exception - an object (to simplify user code) on which we will try to find a nested or wrapped or both RegionMovedException

source - server that is the source of the location update.

tableName - the table name

regionName - the region name

rowkey - the row

getAsyncProcess

public org.apache.hadoop.hbase.client.AsyncProcess getAsyncProcess()

Specified by:

getAsyncProcess in interface ClusterConnection

Returns:

Default AsyncProcess associated with this connection.

getStatisticsTracker

public ServerStatisticTracker getStatisticsTracker()

Specified by:

getStatisticsTracker in interface ClusterConnection

Returns:

the current statistics tracker associated with this connection

getBackoffPolicy

public ClientBackoffPolicy getBackoffPolicy()

Specified by:

getBackoffPolicy in interface ClusterConnection

Returns:

the configured client backoff policy

abort

public void abort(String msg,
                  Throwable t)

Description copied from interface: Abortable

Abort the server or client.

Specified by:

abort in interface Abortable

Parameters:

msg - Why we're aborting.

t - Throwable that caused abort. Can be null.

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

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

getCurrentNrHRS

public int getCurrentNrHRS()
                    throws IOException

Specified by:

getCurrentNrHRS in interface ClusterConnection

Returns:

the number of region servers that are currently running

Throws:

IOException - if a remote or network exception occurs

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

finalize

protected void finalize()
                 throws Throwable

Close the connection for good. On the off chance that someone is unable to close the connection, perhaps because it bailed out prematurely, the method below will ensure that this instance is cleaned up. Caveat: The JVM may take an unknown amount of time to call finalize on an unreachable object, so our hope is that every consumer cleans up after itself, like any good citizen.

Overrides:

finalize in class Object

Throws:

Throwable

getNonceGenerator

public NonceGenerator getNonceGenerator()

Specified by:

getNonceGenerator in interface ClusterConnection

Returns:

Nonce generator for this ClusterConnection; may be null if disabled in configuration.

getTableState

public TableState getTableState(TableName tableName)
                         throws IOException

Description copied from interface: ClusterConnection

Retrieve TableState, represent current table state.

Specified by:

getTableState in interface ClusterConnection

Parameters:

tableName - table state for

Returns:

state of the table

Throws:

IOException

getNewRpcRetryingCallerFactory

public RpcRetryingCallerFactory getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration conf)

Description copied from interface: ClusterConnection

Returns a new RpcRetryingCallerFactory from the given Configuration. This RpcRetryingCallerFactory lets the users create RpcRetryingCallers which can be intercepted with the configured RetryingCallerInterceptor

Specified by:

getNewRpcRetryingCallerFactory in interface ClusterConnection

Parameters:

conf - configuration

Returns:

RpcRetryingCallerFactory

hasCellBlockSupport

public boolean hasCellBlockSupport()

Specified by:

hasCellBlockSupport in interface ClusterConnection

Returns:

true when this connection uses a Codec and so supports cell blocks.

getConnectionConfiguration

public ConnectionConfiguration getConnectionConfiguration()

Specified by:

getConnectionConfiguration in interface ClusterConnection

Returns:

a ConnectionConfiguration object holding parsed configuration values

getRpcRetryingCallerFactory

public RpcRetryingCallerFactory getRpcRetryingCallerFactory()

Specified by:

getRpcRetryingCallerFactory in interface ClusterConnection

Returns:

Connection's RpcRetryingCallerFactory instance

getRpcControllerFactory

public RpcControllerFactory getRpcControllerFactory()

Specified by:

getRpcControllerFactory in interface ClusterConnection

Returns:

Connection's RpcControllerFactory instance