org.apache.hadoop.hbase.client

Class CoprocessorHConnection

java.lang.Object

org.apache.hadoop.hbase.client.CoprocessorHConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, ClusterConnection, Connection, HConnection

@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

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

HBASE_CLIENT_CONNECTION_IMPL

Constructor Summary

Constructors

Constructor and Description
CoprocessorHConnection(ClusterConnection delegate, HRegionServer server) Deprecated. delegate is not used
CoprocessorHConnection(org.apache.hadoop.conf.Configuration conf, HRegionServer server) Constructor that accepts custom configuration
CoprocessorHConnection(HRegionServer server) Constructor that uses server configuration

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(String arg0, Throwable arg1)
void	clearCaches(ServerName arg0)
void	clearRegionCache()
void	clearRegionCache(byte[] arg0)
void	clearRegionCache(TableName arg0)
void	clearRegionCache(TableName arg0, byte[] arg1)
void	close()
protected org.apache.hadoop.hbase.client.AsyncProcess	createAsyncProcess(org.apache.hadoop.conf.Configuration arg0)
void	deleteCachedRegionLocation(HRegionLocation arg0)
protected void	finalize()
Admin	getAdmin()
AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName arg0)
AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName arg0, boolean arg1)
org.apache.hadoop.hbase.client.AsyncProcess	getAsyncProcess()
ClientBackoffPolicy	getBackoffPolicy()
BufferedMutator	getBufferedMutator(BufferedMutatorParams arg0)
BufferedMutator	getBufferedMutator(TableName arg0)
ClientProtos.ClientService.BlockingInterface	getClient(ServerName serverName)
org.apache.hadoop.conf.Configuration	getConfiguration()
static ClusterConnection	getConnectionForEnvironment(CoprocessorEnvironment env) Create an unmanaged HConnection based on the environment in which we are running the coprocessor.
protected ExecutorService	getCurrentBatchPool()
int	getCurrentNrHRS()
HTableDescriptor	getHTableDescriptor(byte[] arg0) Deprecated.
HTableDescriptor	getHTableDescriptor(TableName arg0) Deprecated.
HTableDescriptor[]	getHTableDescriptors(List<String> arg0) Deprecated.
HTableDescriptor[]	getHTableDescriptorsByTableName(List<TableName> arg0) Deprecated.
org.apache.hadoop.hbase.client.MasterKeepAliveConnection	getKeepAliveMasterService()
MasterProtos.MasterService.BlockingInterface	getMaster()
RpcRetryingCallerFactory	getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration arg0)
NonceGenerator	getNonceGenerator()
boolean	getRegionCachePrefetch(byte[] arg0) Deprecated.
boolean	getRegionCachePrefetch(TableName arg0) Deprecated.
HRegionLocation	getRegionLocation(byte[] arg0, byte[] arg1, boolean arg2)
HRegionLocation	getRegionLocation(TableName arg0, byte[] arg1, boolean arg2)
RegionLocator	getRegionLocator(TableName arg0)
ServerStatisticTracker	getStatisticsTracker()
HTableInterface	getTable(byte[] arg0)
HTableInterface	getTable(byte[] arg0, ExecutorService arg1)
HTableInterface	getTable(String arg0)
HTableInterface	getTable(String arg0, ExecutorService arg1)
HTableInterface	getTable(TableName arg0)
HTableInterface	getTable(TableName arg0, ExecutorService arg1)
String[]	getTableNames() Deprecated.
boolean	isAborted()
boolean	isClosed()
boolean	isDeadServer(ServerName arg0)
boolean	isManaged()
boolean	isMasterRunning() Deprecated.
boolean	isTableAvailable(byte[] arg0)
boolean	isTableAvailable(byte[] arg0, byte[][] arg1)
boolean	isTableAvailable(TableName arg0)
boolean	isTableAvailable(TableName arg0, byte[][] arg1)
boolean	isTableDisabled(byte[] arg0)
boolean	isTableDisabled(TableName arg0)
boolean	isTableEnabled(byte[] arg0)
boolean	isTableEnabled(TableName arg0)
TableName[]	listTableNames() Deprecated.
HTableDescriptor[]	listTables() Deprecated.
HRegionLocation	locateRegion(byte[] arg0)
HRegionLocation	locateRegion(byte[] arg0, byte[] arg1)
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(byte[] arg0)
List<HRegionLocation>	locateRegions(byte[] arg0, boolean arg1, boolean arg2)
List<HRegionLocation>	locateRegions(TableName arg0)
List<HRegionLocation>	locateRegions(TableName arg0, boolean arg1, boolean arg2)
void	processBatch(List<? extends Row> arg0, byte[] arg1, ExecutorService arg2, Object[] arg3) Deprecated.
void	processBatch(List<? extends Row> arg0, TableName arg1, ExecutorService arg2, Object[] arg3) Deprecated.
<R> void	processBatchCallback(List<? extends Row> arg0, byte[] arg1, ExecutorService arg2, Object[] arg3, Batch.Callback<R> arg4) Deprecated.
<R> void	processBatchCallback(List<? extends Row> arg0, TableName arg1, ExecutorService arg2, Object[] arg3, Batch.Callback<R> arg4) Deprecated.
HRegionLocation	relocateRegion(byte[] arg0, byte[] arg1)
HRegionLocation	relocateRegion(TableName arg0, byte[] arg1)
RegionLocations	relocateRegion(TableName arg0, byte[] arg1, int arg2)
void	setRegionCachePrefetch(byte[] arg0, boolean arg1) Deprecated.
void	setRegionCachePrefetch(TableName arg0, boolean arg1) Deprecated.
String	toString()
void	updateCachedLocations(byte[] arg0, byte[] arg1, Object arg2, HRegionLocation arg3)
void	updateCachedLocations(TableName arg0, byte[] arg1, byte[] arg2, Object arg3, ServerName arg4)
void	updateCachedLocations(TableName arg0, byte[] arg1, Object arg2, HRegionLocation arg3)

Methods inherited from class java.lang.Object

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

Field Detail

clusterId

protected String clusterId

Constructor Detail

CoprocessorHConnection

@Deprecated
public CoprocessorHConnection(ClusterConnection delegate,
                                 HRegionServer server)
                       throws IOException

Deprecated. delegate is not used

Legacy constructor

Parameters:

delegate -

server -

Throws:

IOException - if we cannot create the connection

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 an unmanaged HConnection based on the environment in which we are running the coprocessor. The HConnection must be externally cleaned up (we bypass the usual HTable cleanup mechanisms since we own everything).

Parameters:

env - environment hosting the HConnection

Returns:

an unmanaged HConnection.

Throws:

IOException - if we cannot create the connection

getClient

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

Specified by:

getClient in interface ClusterConnection

Specified by:

getClient in interface HConnection

Throws:

IOException

getNonceGenerator

public NonceGenerator getNonceGenerator()

Specified by:

getNonceGenerator in interface ClusterConnection

Specified by:

getNonceGenerator in interface HConnection

getTable

public HTableInterface getTable(String arg0)
                         throws IOException

Specified by:

getTable in interface HConnection

Throws:

IOException

getTable

public HTableInterface getTable(byte[] arg0)
                         throws IOException

Specified by:

getTable in interface HConnection

Throws:

IOException

getTable

public HTableInterface getTable(TableName arg0)
                         throws IOException

Specified by:

getTable in interface Connection

Specified by:

getTable in interface HConnection

Throws:

IOException

getTable

public HTableInterface getTable(String arg0,
                       ExecutorService arg1)
                         throws IOException

Specified by:

getTable in interface HConnection

Throws:

IOException

getTable

public HTableInterface getTable(byte[] arg0,
                       ExecutorService arg1)
                         throws IOException

Specified by:

getTable in interface HConnection

Throws:

IOException

getTable

public HTableInterface getTable(TableName arg0,
                       ExecutorService arg1)
                         throws IOException

Specified by:

getTable in interface Connection

Specified by:

getTable in interface HConnection

Throws:

IOException

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

Specified by:

getRegionLocator in interface HConnection

Throws:

IOException

getAdmin

public Admin getAdmin()
               throws IOException

Specified by:

getAdmin in interface Connection

Specified by:

getAdmin in interface HConnection

Throws:

IOException

getCurrentBatchPool

protected ExecutorService getCurrentBatchPool()

toString

public String toString()

Overrides:

toString in class Object

getConfiguration

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

Specified by:

getConfiguration in interface Connection

Specified by:

getConfiguration in interface HConnection

isMasterRunning

@Deprecated
public boolean isMasterRunning()
                        throws MasterNotRunningException,
                               ZooKeeperConnectionException

Deprecated.

Specified by:

isMasterRunning in interface ClusterConnection

Specified by:

isMasterRunning in interface HConnection

Throws:

MasterNotRunningException

ZooKeeperConnectionException

getRegionLocation

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

Specified by:

getRegionLocation in interface ClusterConnection

Specified by:

getRegionLocation in interface HConnection

Throws:

IOException

getRegionLocation

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

Specified by:

getRegionLocation in interface HConnection

Throws:

IOException

isTableEnabled

public boolean isTableEnabled(TableName arg0)
                       throws IOException

Specified by:

isTableEnabled in interface HConnection

Throws:

IOException

isTableEnabled

public boolean isTableEnabled(byte[] arg0)
                       throws IOException

Specified by:

isTableEnabled in interface HConnection

Throws:

IOException

isTableDisabled

public boolean isTableDisabled(TableName arg0)
                        throws IOException

Specified by:

isTableDisabled in interface HConnection

Throws:

IOException

isTableDisabled

public boolean isTableDisabled(byte[] arg0)
                        throws IOException

Specified by:

isTableDisabled in interface HConnection

Throws:

IOException

isTableAvailable

public boolean isTableAvailable(TableName arg0)
                         throws IOException

Specified by:

isTableAvailable in interface HConnection

Throws:

IOException

isTableAvailable

public boolean isTableAvailable(byte[] arg0)
                         throws IOException

Specified by:

isTableAvailable in interface HConnection

Throws:

IOException

isTableAvailable

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

Specified by:

isTableAvailable in interface ClusterConnection

Specified by:

isTableAvailable in interface HConnection

Throws:

IOException

isTableAvailable

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

Specified by:

isTableAvailable in interface HConnection

Throws:

IOException

locateRegion

public HRegionLocation locateRegion(byte[] arg0)
                             throws IOException

Specified by:

locateRegion in interface ClusterConnection

Specified by:

locateRegion in interface HConnection

Throws:

IOException

isDeadServer

public boolean isDeadServer(ServerName arg0)

Specified by:

isDeadServer in interface ClusterConnection

Specified by:

isDeadServer in interface HConnection

locateRegions

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

Specified by:

locateRegions in interface ClusterConnection

Specified by:

locateRegions in interface HConnection

Throws:

IOException

locateRegions

public List<HRegionLocation> locateRegions(byte[] arg0)
                                    throws IOException

Specified by:

locateRegions in interface HConnection

Throws:

IOException

locateRegions

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

Specified by:

locateRegions in interface ClusterConnection

Specified by:

locateRegions in interface HConnection

Throws:

IOException

locateRegions

public List<HRegionLocation> locateRegions(byte[] arg0,
                                  boolean arg1,
                                  boolean arg2)
                                    throws IOException

Specified by:

locateRegions in interface HConnection

Throws:

IOException

locateRegion

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

Specified by:

locateRegion in interface ClusterConnection

Specified by:

locateRegion in interface HConnection

Throws:

IOException

locateRegion

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

Specified by:

locateRegion in interface HConnection

Throws:

IOException

relocateRegion

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

Specified by:

relocateRegion in interface ClusterConnection

Specified by:

relocateRegion in interface HConnection

Throws:

IOException

relocateRegion

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

Specified by:

relocateRegion in interface ClusterConnection

Throws:

IOException

relocateRegion

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

Specified by:

relocateRegion in interface HConnection

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

clearRegionCache

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

clearCaches

public void clearCaches(ServerName arg0)

Specified by:

clearCaches in interface ClusterConnection

Specified by:

clearCaches in interface HConnection

clearRegionCache

public void clearRegionCache()

Specified by:

clearRegionCache in interface ClusterConnection

Specified by:

clearRegionCache in interface HConnection

clearRegionCache

public void clearRegionCache(TableName arg0)

Specified by:

clearRegionCache in interface ClusterConnection

Specified by:

clearRegionCache in interface HConnection

clearRegionCache

public void clearRegionCache(byte[] arg0)

Specified by:

clearRegionCache in interface HConnection

getAdmin

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

Specified by:

getAdmin in interface ClusterConnection

Specified by:

getAdmin in interface HConnection

Throws:

IOException

getAdmin

public AdminProtos.AdminService.BlockingInterface getAdmin(ServerName arg0,
                                                  boolean arg1)
                                                    throws IOException

Specified by:

getAdmin in interface HConnection

Throws:

IOException

getMaster

public MasterProtos.MasterService.BlockingInterface getMaster()
                                                       throws MasterNotRunningException

Specified by:

getMaster in interface ClusterConnection

Specified by:

getMaster in interface HConnection

Throws:

MasterNotRunningException

getKeepAliveMasterService

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

Specified by:

getKeepAliveMasterService in interface ClusterConnection

Specified by:

getKeepAliveMasterService in interface HConnection

Throws:

MasterNotRunningException

deleteCachedRegionLocation

public void deleteCachedRegionLocation(HRegionLocation arg0)

Specified by:

deleteCachedRegionLocation in interface ClusterConnection

Specified by:

deleteCachedRegionLocation in interface HConnection

updateCachedLocations

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

Specified by:

updateCachedLocations in interface HConnection

updateCachedLocations

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

Specified by:

updateCachedLocations in interface ClusterConnection

Specified by:

updateCachedLocations in interface HConnection

updateCachedLocations

public void updateCachedLocations(byte[] arg0,
                         byte[] arg1,
                         Object arg2,
                         HRegionLocation arg3)

Specified by:

updateCachedLocations in interface HConnection

processBatch

@Deprecated
public void processBatch(List<? extends Row> arg0,
                           TableName arg1,
                           ExecutorService arg2,
                           Object[] arg3)
                  throws IOException,
                         InterruptedException

Deprecated.

Specified by:

processBatch in interface HConnection

Throws:

IOException

InterruptedException

processBatch

@Deprecated
public void processBatch(List<? extends Row> arg0,
                           byte[] arg1,
                           ExecutorService arg2,
                           Object[] arg3)
                  throws IOException,
                         InterruptedException

Deprecated.

Specified by:

processBatch in interface HConnection

Throws:

IOException

InterruptedException

processBatchCallback

@Deprecated
public <R> void processBatchCallback(List<? extends Row> arg0,
                                       TableName arg1,
                                       ExecutorService arg2,
                                       Object[] arg3,
                                       Batch.Callback<R> arg4)
                          throws IOException,
                                 InterruptedException

Deprecated.

Specified by:

processBatchCallback in interface HConnection

Throws:

IOException

InterruptedException

processBatchCallback

@Deprecated
public <R> void processBatchCallback(List<? extends Row> arg0,
                                       byte[] arg1,
                                       ExecutorService arg2,
                                       Object[] arg3,
                                       Batch.Callback<R> arg4)
                          throws IOException,
                                 InterruptedException

Deprecated.

Specified by:

processBatchCallback in interface HConnection

Throws:

IOException

InterruptedException

createAsyncProcess

protected org.apache.hadoop.hbase.client.AsyncProcess createAsyncProcess(org.apache.hadoop.conf.Configuration arg0)

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

setRegionCachePrefetch

@Deprecated
public void setRegionCachePrefetch(TableName arg0,
                                     boolean arg1)

Deprecated.

Specified by:

setRegionCachePrefetch in interface HConnection

setRegionCachePrefetch

@Deprecated
public void setRegionCachePrefetch(byte[] arg0,
                                     boolean arg1)

Deprecated.

Specified by:

setRegionCachePrefetch in interface HConnection

getRegionCachePrefetch

@Deprecated
public boolean getRegionCachePrefetch(TableName arg0)

Deprecated.

Specified by:

getRegionCachePrefetch in interface HConnection

getRegionCachePrefetch

@Deprecated
public boolean getRegionCachePrefetch(byte[] arg0)

Deprecated.

Specified by:

getRegionCachePrefetch in interface HConnection

abort

public void abort(String arg0,
         Throwable arg1)

Specified by:

abort in interface Abortable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Connection

Specified by:

isClosed in interface HConnection

isAborted

public boolean isAborted()

Specified by:

isAborted in interface Abortable

getCurrentNrHRS

public int getCurrentNrHRS()
                    throws IOException

Specified by:

getCurrentNrHRS in interface HConnection

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

listTables

@Deprecated
public HTableDescriptor[] listTables()
                              throws IOException

Deprecated.

Specified by:

listTables in interface HConnection

Throws:

IOException

getTableNames

@Deprecated
public String[] getTableNames()
                       throws IOException

Deprecated.

Specified by:

getTableNames in interface HConnection

Throws:

IOException

listTableNames

@Deprecated
public TableName[] listTableNames()
                           throws IOException

Deprecated.

Specified by:

listTableNames in interface HConnection

Throws:

IOException

getHTableDescriptorsByTableName

@Deprecated
public HTableDescriptor[] getHTableDescriptorsByTableName(List<TableName> arg0)
                                                   throws IOException

Deprecated.

Specified by:

getHTableDescriptorsByTableName in interface HConnection

Throws:

IOException

getHTableDescriptors

@Deprecated
public HTableDescriptor[] getHTableDescriptors(List<String> arg0)
                                        throws IOException

Deprecated.

Specified by:

getHTableDescriptors in interface HConnection

Throws:

IOException

getHTableDescriptor

@Deprecated
public HTableDescriptor getHTableDescriptor(TableName arg0)
                                     throws IOException

Deprecated.

Specified by:

getHTableDescriptor in interface HConnection

Throws:

IOException

getHTableDescriptor

@Deprecated
public HTableDescriptor getHTableDescriptor(byte[] arg0)
                                     throws IOException

Deprecated.

Specified by:

getHTableDescriptor in interface HConnection

Throws:

IOException

getNewRpcRetryingCallerFactory

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

Specified by:

getNewRpcRetryingCallerFactory in interface ClusterConnection

isManaged

public boolean isManaged()

Specified by:

isManaged in interface ClusterConnection