RegionAdminServiceCallable (Apache HBase 1.2.12 API)

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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClusterConnection`	`connection`
`protected HRegionLocation`	`location`
`protected int`	`replicaId`
`protected byte[]`	`row`
`protected RpcControllerFactory`	`rpcControllerFactory`
`protected org.apache.hadoop.hbase.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

Methods
Modifier and Type	Method and Description
`(package private) HConnection`	`getConnection()`
`protected String`	`getExceptionMessage()`
`String`	`getExceptionMessageAdditionalDetail()`
`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 `RetryingCallable.call(int)` invocation.
`protected void`	`setStub(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface stub)`
`long`	`sleep(long pause, int tries)`
`void`	`throwable(Throwable t, boolean retrying)` Called when `RetryingCallable.call(int)` 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

Methods inherited from interface org.apache.hadoop.hbase.client.RetryingCallable
call

Field Detail

connection

protected final ClusterConnection connection

rpcControllerFactory

protected final RpcControllerFactory rpcControllerFactory

stub

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

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 RetryingCallable.call(int) invocation.
  
  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.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 RetryingCallable.call(int) 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>
  
  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
```
HConnection getConnection()
```
  Returns:
  HConnection instance used by this Callable.
- getExceptionMessage
```
protected String getExceptionMessage()
```
- getExceptionMessageAdditionalDetail
```
public String getExceptionMessageAdditionalDetail()
```
  Specified by:
  
  getExceptionMessageAdditionalDetail in interface RetryingCallable<T>
  
  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.
- sleep
```
public long sleep(long pause,
         int tries)
```
  Specified by:
  
  sleep in interface RetryingCallable<T>
  
  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

Class RegionAdminServiceCallable<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

connection

rpcControllerFactory

stub

location

tableName

row

replicaId

Constructor Detail

RegionAdminServiceCallable

RegionAdminServiceCallable

RegionAdminServiceCallable

Method Detail

prepare

setStub

getLocation

throwable

getConnection

getExceptionMessage

getExceptionMessageAdditionalDetail

sleep

getRegionLocations