org.apache.hadoop.hbase.master.procedure

Class DeleteNamespaceProcedure

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,TState>

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

org.apache.hadoop.hbase.master.procedure.DeleteNamespaceProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@InterfaceAudience.Private
public class DeleteNamespaceProcedure
extends AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

The procedure to remove a namespace.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

StateMachineProcedure.Flow

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
private String	namespaceName
private NamespaceDescriptor	nsDescriptor
private Boolean	traceEnabled

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DeleteNamespaceProcedure()
DeleteNamespaceProcedure(MasterProcedureEnv env, String namespaceName)
DeleteNamespaceProcedure(MasterProcedureEnv env, String namespaceName, ProcedurePrepareLatch latch)

Method Summary

Modifier and Type	Method and Description
protected static void	deleteDirectory(MasterProcedureEnv env, String namespaceName) Delete the namespace directories from the file system
protected static void	deleteFromNSTable(MasterProcedureEnv env, String namespaceName) delete the row from namespace table
protected void	deserializeStateData(ProcedureStateSerializer serializer) Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state) called to perform a single step of the specified 'state' of the procedure
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
protected String	getNamespaceName()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState	getState(int stateId) Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state) Convert the Enum (or more descriptive) state object to an ordinal (or state id).
private static TableNamespaceManager	getTableNamespaceManager(MasterProcedureEnv env)
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected boolean	isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state) Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.
private Boolean	isTraceEnabled() The procedure could be restarted from a different machine.
private boolean	prepareDelete(MasterProcedureEnv env) Action before any real action of deleting namespace.
protected static void	removeFromZKNamespaceManager(MasterProcedureEnv env, String namespaceName) remove from ZooKeeper.
protected static void	removeNamespaceQuota(MasterProcedureEnv env, String namespaceName) remove quota for the namespace
private void	rollbackDeleteDirectory(MasterProcedureEnv env) undo delete directory
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state) called to perform the rollback of the specified state
private void	rollbacRemoveNamespaceQuota(MasterProcedureEnv env) undo remove quota for the namespace
protected void	serializeStateData(ProcedureStateSerializer serializer) The user-level code of the procedure may have some state to persist (e.g.
private void	undoDeleteFromNSTable(MasterProcedureEnv env) undo the delete
private void	undoRemoveFromZKNamespaceManager(MasterProcedureEnv env) undo the remove from ZooKeeper

Methods inherited from class org.apache.hadoop.hbase.master.procedure.AbstractStateMachineNamespaceProcedure

acquireLock, getTableName, releaseLock, releaseSyncLatch, toStringClassDetails, waitInitialized

Methods inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

addStackIndex, afterReplay, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, wasExecuted

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

nsDescriptor

private NamespaceDescriptor nsDescriptor

namespaceName

private String namespaceName

traceEnabled

private Boolean traceEnabled

Constructor Detail

DeleteNamespaceProcedure

public DeleteNamespaceProcedure()

DeleteNamespaceProcedure

public DeleteNamespaceProcedure(MasterProcedureEnv env,
                                String namespaceName)

DeleteNamespaceProcedure

public DeleteNamespaceProcedure(MasterProcedureEnv env,
                                String namespaceName,
                                ProcedurePrepareLatch latch)

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state)
                                               throws InterruptedException

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

state - state to execute

Returns:

Flow.NO_MORE_STATE if the procedure is completed, Flow.HAS_MORE_STATE if there is another step.

Throws:

InterruptedException

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state)
                      throws IOException

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

isRollbackSupported

protected boolean isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state)

Description copied from class: StateMachineProcedure

Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.

Overrides:

isRollbackSupported in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState getState(int stateId)

Description copied from class: StateMachineProcedure

Convert an ordinal (or state id) to an Enum (or more descriptive) state object.

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Parameters:

stateId - the ordinal() of the state enum (or state id)

Returns:

the state enum object

getStateId

protected int getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState state)

Description copied from class: StateMachineProcedure

Convert the Enum (or more descriptive) state object to an ordinal (or state id).

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Parameters:

state - the state enum object

Returns:

stateId the ordinal() of the state enum (or state id)

getInitialState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState getInitialState()

Description copied from class: StateMachineProcedure

Return the initial state object that will be used for the first call to executeFromState().

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Returns:

the initial state enum object

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Parameters:

serializer - contains the serialized state

Throws:

IOException

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Specified by:

getTableOperationType in class AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

Returns:

the operation type that the procedure is executing.

getNamespaceName

protected String getNamespaceName()

Specified by:

getNamespaceName in class AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.DeleteNamespaceState>

prepareDelete

private boolean prepareDelete(MasterProcedureEnv env)
                       throws IOException

Action before any real action of deleting namespace.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

deleteFromNSTable

protected static void deleteFromNSTable(MasterProcedureEnv env,
                                        String namespaceName)
                                 throws IOException

delete the row from namespace table

Parameters:

env - MasterProcedureEnv

namespaceName - name of the namespace in string format

Throws:

IOException

undoDeleteFromNSTable

private void undoDeleteFromNSTable(MasterProcedureEnv env)

undo the delete

Parameters:

env - MasterProcedureEnv

Throws:

IOException

removeFromZKNamespaceManager

protected static void removeFromZKNamespaceManager(MasterProcedureEnv env,
                                                   String namespaceName)
                                            throws IOException

remove from ZooKeeper.

Parameters:

env - MasterProcedureEnv

namespaceName - name of the namespace in string format

Throws:

IOException

undoRemoveFromZKNamespaceManager

private void undoRemoveFromZKNamespaceManager(MasterProcedureEnv env)

undo the remove from ZooKeeper

Parameters:

env - MasterProcedureEnv

Throws:

IOException

deleteDirectory

protected static void deleteDirectory(MasterProcedureEnv env,
                                      String namespaceName)
                               throws IOException

Delete the namespace directories from the file system

Parameters:

env - MasterProcedureEnv

namespaceName - name of the namespace in string format

Throws:

IOException

rollbackDeleteDirectory

private void rollbackDeleteDirectory(MasterProcedureEnv env)
                              throws IOException

undo delete directory

Parameters:

env - MasterProcedureEnv

Throws:

IOException

removeNamespaceQuota

protected static void removeNamespaceQuota(MasterProcedureEnv env,
                                           String namespaceName)
                                    throws IOException

remove quota for the namespace

Parameters:

env - MasterProcedureEnv

namespaceName - name of the namespace in string format

Throws:

IOException

rollbacRemoveNamespaceQuota

private void rollbacRemoveNamespaceQuota(MasterProcedureEnv env)
                                  throws IOException

undo remove quota for the namespace

Parameters:

env - MasterProcedureEnv

Throws:

IOException

getTableNamespaceManager

private static TableNamespaceManager getTableNamespaceManager(MasterProcedureEnv env)

isTraceEnabled

private Boolean isTraceEnabled()

The procedure could be restarted from a different machine. If the variable is null, we need to retrieve it.

Returns:

traceEnabled