org.apache.hadoop.hbase.client

Class CoprocessorHConnection

java.lang.Object

org.apache.hadoop.hbase.client.CoprocessorHConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, ClusterConnection, Connection

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class CoprocessorHConnection
extends Object

Connection to an HTable from within a Coprocessor. We can do some nice tricks since we know we are on a regionserver, for instance skipping the full serialization/deserialization of objects when talking to the server.

You should not use this class from any client - its an internal class meant for use by the coprocessor framework.

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

Constructor Summary

Constructors

Constructor and Description
CoprocessorHConnection(org.apache.hadoop.conf.Configuration conf, HRegionServer server) Constructor that accepts custom configuration
CoprocessorHConnection(HRegionServer server) Constructor that uses server configuration

Method Summary

Modifier and Type	Method and Description
void	abort(String arg0, Throwable arg1)
void	cacheLocation(TableName arg0, RegionLocations arg1)
void	clearCaches(ServerName arg0)
void	clearRegionCache()
void	clearRegionCache(TableName arg0)
void	clearRegionCache(TableName arg0, byte[] arg1)
void	close()
void	deleteCachedRegionLocation(HRegionLocation arg0)
protected void	finalize()
Admin	getAdmin()
org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName arg0)
org.apache.hadoop.hbase.client.AsyncProcess	getAsyncProcess()
ClientBackoffPolicy	getBackoffPolicy()
BufferedMutator	getBufferedMutator(BufferedMutatorParams arg0)
BufferedMutator	getBufferedMutator(TableName arg0)
org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.BlockingInterface	getClient(ServerName serverName)
org.apache.hadoop.conf.Configuration	getConfiguration()
ConnectionConfiguration	getConnectionConfiguration()
static ClusterConnection	getConnectionForEnvironment(CoprocessorEnvironment env) Create a ClusterConnection based on the environment in which we are running the coprocessor.
MetricsConnection	getConnectionMetrics()
protected ExecutorService	getCurrentBatchPool()
protected ExecutorService	getCurrentMetaLookupPool()
int	getCurrentNrHRS()
org.apache.hadoop.hbase.client.MasterKeepAliveConnection	getKeepAliveMasterService()
org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.BlockingInterface	getMaster()
RpcRetryingCallerFactory	getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration arg0)
NonceGenerator	getNonceGenerator()
HRegionLocation	getRegionLocation(TableName arg0, byte[] arg1, boolean arg2)
RegionLocator	getRegionLocator(TableName arg0)
RpcControllerFactory	getRpcControllerFactory()
RpcRetryingCallerFactory	getRpcRetryingCallerFactory()
ServerStatisticTracker	getStatisticsTracker()
Table	getTable(TableName arg0)
TableBuilder	getTableBuilder(TableName arg0, ExecutorService arg1)
TableState	getTableState(TableName arg0)
boolean	hasCellBlockSupport()
boolean	isAborted()
boolean	isClosed()
boolean	isDeadServer(ServerName arg0)
boolean	isMasterRunning() Deprecated.
boolean	isTableAvailable(TableName arg0, byte[][] arg1)
boolean	isTableDisabled(TableName arg0)
boolean	isTableEnabled(TableName arg0)
HRegionLocation	locateRegion(byte[] arg0)
HRegionLocation	locateRegion(TableName arg0, byte[] arg1)
RegionLocations	locateRegion(TableName arg0, byte[] arg1, boolean arg2, boolean arg3)
RegionLocations	locateRegion(TableName arg0, byte[] arg1, boolean arg2, boolean arg3, int arg4)
List<HRegionLocation>	locateRegions(TableName arg0)
List<HRegionLocation>	locateRegions(TableName arg0, boolean arg1, boolean arg2)
HRegionLocation	relocateRegion(TableName arg0, byte[] arg1)
RegionLocations	relocateRegion(TableName arg0, byte[] arg1, int arg2)
protected void	retrieveClusterId()
String	toString()
void	updateCachedLocations(TableName arg0, byte[] arg1, byte[] arg2, Object arg3, ServerName arg4)

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

Constructor Detail

CoprocessorHConnection

public CoprocessorHConnection(HRegionServer server)
                       throws IOException

Constructor that uses server configuration

Parameters:

server -

Throws:

IOException - if we cannot create the connection

CoprocessorHConnection

public CoprocessorHConnection(org.apache.hadoop.conf.Configuration conf,
                              HRegionServer server)
                       throws IOException

Constructor that accepts custom configuration

Parameters:

conf -

server -

Throws:

IOException - if we cannot create the connection

Method Detail

getConnectionForEnvironment

public static ClusterConnection getConnectionForEnvironment(CoprocessorEnvironment env)
                                                     throws IOException

Create a ClusterConnection based on the environment in which we are running the coprocessor. The ClusterConnection must be externally cleaned up (we bypass the usual HTable cleanup mechanisms since we own everything).

Parameters:

env - environment hosting the ClusterConnection

Returns:

instance of ClusterConnection.

Throws:

IOException - if we cannot create the connection

getClient

public org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.BlockingInterface getClient(ServerName serverName)
                                                                                                         throws IOException

Specified by:

getClient in interface ClusterConnection

Throws:

IOException

getNonceGenerator

public NonceGenerator getNonceGenerator()

Specified by:

getNonceGenerator in interface ClusterConnection

getTable

public Table getTable(TableName arg0)
               throws IOException

Specified by:

getTable in interface Connection

Throws:

IOException

getTableBuilder

public TableBuilder getTableBuilder(TableName arg0,
                                    ExecutorService arg1)

Specified by:

getTableBuilder in interface Connection

getBufferedMutator

public BufferedMutator getBufferedMutator(BufferedMutatorParams arg0)

Specified by:

getBufferedMutator in interface Connection

getBufferedMutator

public BufferedMutator getBufferedMutator(TableName arg0)

Specified by:

getBufferedMutator in interface Connection

getRegionLocator

public RegionLocator getRegionLocator(TableName arg0)
                               throws IOException

Specified by:

getRegionLocator in interface Connection

Throws:

IOException

getAdmin

public Admin getAdmin()
               throws IOException

Specified by:

getAdmin in interface Connection

Throws:

IOException

getConnectionMetrics

public MetricsConnection getConnectionMetrics()

Specified by:

getConnectionMetrics in interface ClusterConnection

getCurrentMetaLookupPool

protected ExecutorService getCurrentMetaLookupPool()

getCurrentBatchPool

protected ExecutorService getCurrentBatchPool()

toString

public String toString()

Overrides:

toString in class Object

retrieveClusterId

protected void retrieveClusterId()

getConfiguration

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

Specified by:

getConfiguration in interface Connection

isMasterRunning

@Deprecated
public boolean isMasterRunning()
                                    throws MasterNotRunningException,
                                           ZooKeeperConnectionException

Deprecated.

Specified by:

isMasterRunning in interface ClusterConnection

Throws:

MasterNotRunningException

ZooKeeperConnectionException

getRegionLocation

public HRegionLocation getRegionLocation(TableName arg0,
                                         byte[] arg1,
                                         boolean arg2)
                                  throws IOException

Specified by:

getRegionLocation in interface ClusterConnection

Throws:

IOException

isTableEnabled

public boolean isTableEnabled(TableName arg0)
                       throws IOException

Specified by:

isTableEnabled in interface ClusterConnection

Throws:

IOException

isTableDisabled

public boolean isTableDisabled(TableName arg0)
                        throws IOException

Specified by:

isTableDisabled in interface ClusterConnection

Throws:

IOException

isTableAvailable

public boolean isTableAvailable(TableName arg0,
                                @Nullable
                                byte[][] arg1)
                         throws IOException

Specified by:

isTableAvailable in interface ClusterConnection

Throws:

IOException

locateRegion

public HRegionLocation locateRegion(byte[] arg0)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Throws:

IOException

isDeadServer

public boolean isDeadServer(ServerName arg0)

Specified by:

isDeadServer in interface ClusterConnection

locateRegions

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

Specified by:

locateRegions in interface ClusterConnection

Throws:

IOException

locateRegions

public List<HRegionLocation> locateRegions(TableName arg0,
                                           boolean arg1,
                                           boolean arg2)
                                    throws IOException

Specified by:

locateRegions in interface ClusterConnection

Throws:

IOException

locateRegion

public HRegionLocation locateRegion(TableName arg0,
                                    byte[] arg1)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Throws:

IOException

relocateRegion

public HRegionLocation relocateRegion(TableName arg0,
                                      byte[] arg1)
                               throws IOException

Specified by:

relocateRegion in interface ClusterConnection

Throws:

IOException

relocateRegion

public RegionLocations relocateRegion(TableName arg0,
                                      byte[] arg1,
                                      int arg2)
                               throws IOException

Specified by:

relocateRegion in interface ClusterConnection

Throws:

IOException

locateRegion

public RegionLocations locateRegion(TableName arg0,
                                    byte[] arg1,
                                    boolean arg2,
                                    boolean arg3)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Throws:

IOException

locateRegion

public RegionLocations locateRegion(TableName arg0,
                                    byte[] arg1,
                                    boolean arg2,
                                    boolean arg3,
                                    int arg4)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Throws:

IOException

cacheLocation

public void cacheLocation(TableName arg0,
                          RegionLocations arg1)

Specified by:

cacheLocation in interface ClusterConnection

clearRegionCache

public void clearRegionCache(TableName arg0,
                             byte[] arg1)

clearCaches

public void clearCaches(ServerName arg0)

Specified by:

clearCaches in interface ClusterConnection

clearRegionCache

public void clearRegionCache()

Specified by:

clearRegionCache in interface ClusterConnection

clearRegionCache

public void clearRegionCache(TableName arg0)

Specified by:

clearRegionCache in interface ClusterConnection

getAdmin

public org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface getAdmin(ServerName arg0)
                                                                                                      throws IOException

Specified by:

getAdmin in interface ClusterConnection

Throws:

IOException

getMaster

public org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.MasterService.BlockingInterface getMaster()
                                                                                                         throws MasterNotRunningException

Specified by:

getMaster in interface ClusterConnection

Throws:

MasterNotRunningException

getKeepAliveMasterService

public org.apache.hadoop.hbase.client.MasterKeepAliveConnection getKeepAliveMasterService()
                                                                                   throws MasterNotRunningException

Specified by:

getKeepAliveMasterService in interface ClusterConnection

Throws:

MasterNotRunningException

deleteCachedRegionLocation

public void deleteCachedRegionLocation(HRegionLocation arg0)

Specified by:

deleteCachedRegionLocation in interface ClusterConnection

updateCachedLocations

public void updateCachedLocations(TableName arg0,
                                  byte[] arg1,
                                  byte[] arg2,
                                  Object arg3,
                                  ServerName arg4)

Specified by:

updateCachedLocations in interface ClusterConnection

getAsyncProcess

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

Specified by:

getAsyncProcess in interface ClusterConnection

getStatisticsTracker

public ServerStatisticTracker getStatisticsTracker()

Specified by:

getStatisticsTracker in interface ClusterConnection

getBackoffPolicy

public ClientBackoffPolicy getBackoffPolicy()

Specified by:

getBackoffPolicy in interface ClusterConnection

abort

public void abort(String arg0,
                  Throwable arg1)

Specified by:

abort in interface Abortable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Connection

isAborted

public boolean isAborted()

Specified by:

isAborted in interface Abortable

getCurrentNrHRS

public int getCurrentNrHRS()
                    throws IOException

Specified by:

getCurrentNrHRS in interface ClusterConnection

Throws:

IOException

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

Overrides:

finalize in class Object

Throws:

Throwable

getTableState

public TableState getTableState(TableName arg0)
                         throws IOException

Specified by:

getTableState in interface ClusterConnection

Throws:

IOException

getNewRpcRetryingCallerFactory

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

Specified by:

getNewRpcRetryingCallerFactory in interface ClusterConnection

hasCellBlockSupport

public boolean hasCellBlockSupport()

Specified by:

hasCellBlockSupport in interface ClusterConnection

getConnectionConfiguration

public ConnectionConfiguration getConnectionConfiguration()

Specified by:

getConnectionConfiguration in interface ClusterConnection

getRpcRetryingCallerFactory

public RpcRetryingCallerFactory getRpcRetryingCallerFactory()

Specified by:

getRpcRetryingCallerFactory in interface ClusterConnection

getRpcControllerFactory

public RpcControllerFactory getRpcControllerFactory()

Specified by:

getRpcControllerFactory in interface ClusterConnection