org.apache.hadoop.hbase.client

Class HBaseAdmin.ProcedureFuture<V>

java.lang.Object

org.apache.hadoop.hbase.client.HBaseAdmin.ProcedureFuture<V>

All Implemented Interfaces:

Future<V>

Direct Known Subclasses:

HBaseAdmin.AbortProcedureFuture, HBaseAdmin.NamespaceFuture, HBaseAdmin.TableFuture

Enclosing class:

HBaseAdmin

@InterfaceAudience.Private
 @InterfaceStability.Evolving
protected static class HBaseAdmin.ProcedureFuture<V>
extends Object
implements Future<V>

Future that waits on a procedure result. Returned by the async version of the Admin calls, and used internally by the sync calls to wait on the result of the procedure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	HBaseAdmin.ProcedureFuture.WaitForStateCallable

Field Summary

Fields

Modifier and Type	Field and Description
private HBaseAdmin	admin
private boolean	cancelled
private boolean	done
private ExecutionException	exception
protected Long	procId
private boolean	procResultFound
private V	result

Constructor Summary

Constructors

Constructor and Description
ProcedureFuture(HBaseAdmin admin, Long procId)

Method Summary

Modifier and Type	Method and Description
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.AbortProcedureResponse	abortProcedureResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.AbortProcedureRequest request)
boolean	cancel(boolean mayInterruptIfRunning)
protected V	convertResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultResponse response) Convert the procedure result response to a specified type.
V	get()
V	get(long timeout, TimeUnit unit)
protected HBaseAdmin	getAdmin()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultResponse	getProcedureResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultRequest request)
boolean	isCancelled()
boolean	isDone()
protected V	postOperationFailure(IOException exception, long deadlineTs) Called after the operation is terminated with a failure.
protected V	postOperationResult(V result, long deadlineTs) Called after the operation is completed and the result fetched.
private static IOException	unwrapException(IOException e)
protected void	waitForState(long deadlineTs, HBaseAdmin.ProcedureFuture.WaitForStateCallable callable)
protected V	waitOperationResult(long deadlineTs) Fallback implementation in case the procedure is not supported by the server.
private V	waitProcedureResult(long procId, long deadlineTs)

Methods inherited from class java.lang.Object

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

Field Detail

exception

private ExecutionException exception

procResultFound

private boolean procResultFound

done

private boolean done

cancelled

private boolean cancelled

result

private V result

admin

private final HBaseAdmin admin

procId

protected final Long procId

Constructor Detail

ProcedureFuture

public ProcedureFuture(HBaseAdmin admin,
                       Long procId)

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

abortProcedureResult

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.AbortProcedureResponse abortProcedureResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.AbortProcedureRequest request)
                                                                                                              throws IOException

Throws:

IOException

get

public V get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

get

public V get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

TimeoutException

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

getAdmin

protected HBaseAdmin getAdmin()

waitProcedureResult

private V waitProcedureResult(long procId,
                              long deadlineTs)
                       throws IOException,
                              TimeoutException,
                              InterruptedException

Throws:

IOException

TimeoutException

InterruptedException

unwrapException

private static IOException unwrapException(IOException e)

getProcedureResult

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultResponse getProcedureResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultRequest request)
                                                                                                                throws IOException

Throws:

IOException

convertResult

protected V convertResult(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetProcedureResultResponse response)
                   throws IOException

Convert the procedure result response to a specified type.

Parameters:

response - the procedure result object to parse

Returns:

the result data of the procedure.

Throws:

IOException

waitOperationResult

protected V waitOperationResult(long deadlineTs)
                         throws IOException,
                                TimeoutException

Fallback implementation in case the procedure is not supported by the server. It should try to wait until the operation is completed.

Parameters:

deadlineTs - the timestamp after which this method should throw a TimeoutException

Returns:

the result data of the operation

Throws:

IOException

TimeoutException

postOperationResult

protected V postOperationResult(V result,
                                long deadlineTs)
                         throws IOException,
                                TimeoutException

Called after the operation is completed and the result fetched. this allows to perform extra steps after the procedure is completed. it allows to apply transformations to the result that will be returned by get().

Parameters:

result - the result of the procedure

deadlineTs - the timestamp after which this method should throw a TimeoutException

Returns:

the result of the procedure, which may be the same as the passed one

Throws:

IOException

TimeoutException

postOperationFailure

protected V postOperationFailure(IOException exception,
                                 long deadlineTs)
                          throws IOException,
                                 TimeoutException

Called after the operation is terminated with a failure. this allows to perform extra steps after the procedure is terminated. it allows to apply transformations to the result that will be returned by get(). The default implementation will rethrow the exception

Parameters:

exception - the exception got from fetching the result

deadlineTs - the timestamp after which this method should throw a TimeoutException

Returns:

the result of the procedure, which may be the same as the passed one

Throws:

IOException

TimeoutException

waitForState

protected void waitForState(long deadlineTs,
                            HBaseAdmin.ProcedureFuture.WaitForStateCallable callable)
                     throws IOException,
                            TimeoutException

Throws:

IOException

TimeoutException