org.apache.hadoop.hbase.client

Class RegionAdminServiceCallable<T>

java.lang.Object

org.apache.hadoop.hbase.client.RegionAdminServiceCallable<T>

All Implemented Interfaces:

RetryingCallable<T>

Direct Known Subclasses:

FlushRegionCallable, RegionReplicaReplicationEndpoint.RegionReplicaReplayCallable

@InterfaceAudience.Private
public abstract class RegionAdminServiceCallable<T>
extends Object
implements RetryingCallable<T>

Similar to RegionServerCallable but for the AdminService interface. This service callable assumes a Table and row and thus does region locating similar to RegionServerCallable. Works against Admin stub rather than Client stub.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterConnection	connection
private HBaseRpcController	controller
protected HRegionLocation	location
protected int	replicaId
protected byte[]	row
protected RpcControllerFactory	rpcControllerFactory
protected org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface	stub
protected TableName	tableName

Constructor Summary

Constructors

Constructor and Description
RegionAdminServiceCallable(ClusterConnection connection, RpcControllerFactory rpcControllerFactory, HRegionLocation location, TableName tableName, byte[] row)
RegionAdminServiceCallable(ClusterConnection connection, RpcControllerFactory rpcControllerFactory, HRegionLocation location, TableName tableName, byte[] row, int replicaId)
RegionAdminServiceCallable(ClusterConnection connection, RpcControllerFactory rpcControllerFactory, TableName tableName, byte[] row)

Method Summary

Modifier and Type	Method and Description
protected abstract T	call(HBaseRpcController rpcController) Run RPC call.
T	call(int callTimeout) Override that changes Exception from Exception to IOException.
(package private) Connection	getConnection() Returns Connection instance used by this Callable.
(package private) HBaseRpcController	getCurrentPayloadCarryingRpcController()
protected String	getExceptionMessage()
String	getExceptionMessageAdditionalDetail() Returns Some details from the implementation that we would like to add to a terminating exception; i.e.
HRegionLocation	getLocation(boolean useCache)
static RegionLocations	getRegionLocations(ClusterConnection connection, TableName tableName, byte[] row, boolean useCache, int replicaId)
void	prepare(boolean reload) Prepare by setting up any connections to servers, etc., ahead of call invocation.
protected void	setStub(org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface stub)
long	sleep(long pause, int tries) Sleep and retry.
void	throwable(Throwable t, boolean retrying) Called when call throws an exception and we are going to retry; take action to make it so we succeed on next call (clear caches, do relookup of locations, etc.).

Methods inherited from class java.lang.Object

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

Field Detail

stub

protected org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface stub

rpcControllerFactory

protected final RpcControllerFactory rpcControllerFactory

controller

private HBaseRpcController controller

connection

protected final ClusterConnection connection

location

protected HRegionLocation location

tableName

protected final TableName tableName

row

protected final byte[] row

replicaId

protected final int replicaId

Constructor Detail

RegionAdminServiceCallable

public RegionAdminServiceCallable(ClusterConnection connection,
                                  RpcControllerFactory rpcControllerFactory,
                                  TableName tableName,
                                  byte[] row)

RegionAdminServiceCallable

public RegionAdminServiceCallable(ClusterConnection connection,
                                  RpcControllerFactory rpcControllerFactory,
                                  HRegionLocation location,
                                  TableName tableName,
                                  byte[] row)

RegionAdminServiceCallable

public RegionAdminServiceCallable(ClusterConnection connection,
                                  RpcControllerFactory rpcControllerFactory,
                                  HRegionLocation location,
                                  TableName tableName,
                                  byte[] row,
                                  int replicaId)

Method Detail

prepare

public void prepare(boolean reload)
             throws IOException

Description copied from interface: RetryingCallable

Prepare by setting up any connections to servers, etc., ahead of call invocation. TODO: We call prepare before EVERY call. Seems wrong. FIX!!!!

Specified by:

prepare in interface RetryingCallable<T>

Parameters:

reload - Set this to true if need to requery locations

Throws:

IOException - e

setStub

protected void setStub(org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface stub)

getLocation

public HRegionLocation getLocation(boolean useCache)
                            throws IOException

Throws:

IOException

throwable

public void throwable(Throwable t,
                      boolean retrying)

Description copied from interface: RetryingCallable

Called when call throws an exception and we are going to retry; take action to make it so we succeed on next call (clear caches, do relookup of locations, etc.).

Specified by:

throwable in interface RetryingCallable<T>

Parameters:

t - throwable which was thrown

retrying - True if we are in retrying mode (we are not in retrying mode when max retries == 1; we ARE in retrying mode if retries > 1 even when we are the last attempt)

getConnection

Connection getConnection()

Returns Connection instance used by this Callable.

getExceptionMessage

protected String getExceptionMessage()

getExceptionMessageAdditionalDetail

public String getExceptionMessageAdditionalDetail()

Description copied from interface: RetryingCallable

Returns Some details from the implementation that we would like to add to a terminating exception; i.e. a fatal exception is being thrown ending retries and we might like to add more implementation-specific detail on to the exception being thrown.

Specified by:

getExceptionMessageAdditionalDetail in interface RetryingCallable<T>

sleep

public long sleep(long pause,
                  int tries)

Description copied from interface: RetryingCallable

Sleep and retry.

Specified by:

sleep in interface RetryingCallable<T>

Parameters:

pause - time to pause

tries - amount of tries until till sleep

Returns:

Suggestion on how much to sleep between retries

getRegionLocations

public static RegionLocations getRegionLocations(ClusterConnection connection,
                                                 TableName tableName,
                                                 byte[] row,
                                                 boolean useCache,
                                                 int replicaId)
                                          throws RetriesExhaustedException,
                                                 DoNotRetryIOException,
                                                 InterruptedIOException

Throws:

RetriesExhaustedException

DoNotRetryIOException

InterruptedIOException

call

public T call(int callTimeout)
       throws IOException

Override that changes Exception from Exception to IOException. It also does setup of an rpcController and calls through to the unimplemented call(PayloadCarryingRpcController) method; implement this method to add your rpc invocation.

Specified by:

call in interface RetryingCallable<T>

Parameters:

callTimeout - - the time available for this call. 0 for infinite.

Returns:

computed result

Throws:

IOException

getCurrentPayloadCarryingRpcController

HBaseRpcController getCurrentPayloadCarryingRpcController()

call

protected abstract T call(HBaseRpcController rpcController)
                   throws Exception

Run RPC call.

Parameters:

rpcController - PayloadCarryingRpcController is a mouthful but it at a minimum is a facade on protobuf so we don't have to put protobuf everywhere; we can keep it behind this class. n

Throws:

Exception