org.apache.hadoop.hbase.client

Class HBaseAdmin.TableFuture<V>

java.lang.Object

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

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

All Implemented Interfaces:

Future<V>

Direct Known Subclasses:

HBaseAdmin.CreateTableFuture, HBaseAdmin.DeleteTableFuture, HBaseAdmin.DisableTableFuture, HBaseAdmin.EnableTableFuture, HBaseAdmin.MergeTableRegionsFuture, HBaseAdmin.ModifyTableFuture, HBaseAdmin.RestoreSnapshotFuture, HBaseAdmin.SplitTableRegionFuture, HBaseAdmin.TruncateTableFuture

Enclosing class:

HBaseAdmin

@InterfaceAudience.Private
 @InterfaceStability.Evolving
protected abstract static class HBaseAdmin.TableFuture<V>
extends HBaseAdmin.ProcedureFuture<V>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HBaseAdmin.TableFuture.TableWaitForStateCallable

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.client.HBaseAdmin.ProcedureFuture

HBaseAdmin.ProcedureFuture.WaitForStateCallable

Field Summary

Fields

Modifier and Type	Field and Description
private TableName	tableName

Fields inherited from class org.apache.hadoop.hbase.client.HBaseAdmin.ProcedureFuture

procId

Constructor Summary

Constructors

Constructor and Description
TableFuture(HBaseAdmin admin, TableName tableName, Long procId)

Method Summary

Modifier and Type	Method and Description
protected String	getDescription()
abstract String	getOperationType()
protected TableDescriptor	getTableDescriptor()
protected TableName	getTableName()
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.
String	toString()
protected void	waitForAllRegionsOnline(long deadlineTs, byte[][] splitKeys)
protected void	waitForSchemaUpdate(long deadlineTs)
protected void	waitForTableDisabled(long deadlineTs)
protected void	waitForTableEnabled(long deadlineTs)
protected void	waitTableNotFound(long deadlineTs)

Methods inherited from class org.apache.hadoop.hbase.client.HBaseAdmin.ProcedureFuture

abortProcedureResult, cancel, convertResult, get, get, getAdmin, getProcedureResult, isCancelled, isDone, waitForState, waitOperationResult

Methods inherited from class java.lang.Object

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

Field Detail

tableName

private final TableName tableName

Constructor Detail

TableFuture

public TableFuture(HBaseAdmin admin,
                   TableName tableName,
                   Long procId)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getTableName

protected TableName getTableName()

Returns:

the table name

getTableDescriptor

protected TableDescriptor getTableDescriptor()
                                      throws IOException

Returns:

the table descriptor

Throws:

IOException

getOperationType

public abstract String getOperationType()

Returns:

the operation type like CREATE, DELETE, DISABLE etc.

getDescription

protected String getDescription()

Returns:

a description of the operation

postOperationResult

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

Description copied from class: HBaseAdmin.ProcedureFuture

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().

Overrides:

postOperationResult in class HBaseAdmin.ProcedureFuture<V>

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

Description copied from class: HBaseAdmin.ProcedureFuture

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

Overrides:

postOperationFailure in class HBaseAdmin.ProcedureFuture<V>

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

waitForTableEnabled

protected void waitForTableEnabled(long deadlineTs)
                            throws IOException,
                                   TimeoutException

Throws:

IOException

TimeoutException

waitForTableDisabled

protected void waitForTableDisabled(long deadlineTs)
                             throws IOException,
                                    TimeoutException

Throws:

IOException

TimeoutException

waitTableNotFound

protected void waitTableNotFound(long deadlineTs)
                          throws IOException,
                                 TimeoutException

Throws:

IOException

TimeoutException

waitForSchemaUpdate

protected void waitForSchemaUpdate(long deadlineTs)
                            throws IOException,
                                   TimeoutException

Throws:

IOException

TimeoutException

waitForAllRegionsOnline

protected void waitForAllRegionsOnline(long deadlineTs,
                                       byte[][] splitKeys)
                                throws IOException,
                                       TimeoutException

Throws:

IOException

TimeoutException