org.apache.hadoop.hbase.procedure2

Class TestProcedureReplayOrder.TestSingleStepProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.SequentialProcedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestSingleStepProcedure

All Implemented Interfaces:

Comparable<Procedure>

Enclosing class:

TestProcedureReplayOrder

public static class TestProcedureReplayOrder.TestSingleStepProcedure
extends SequentialProcedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

Constructor Summary

Constructors

Constructor and Description
TestSingleStepProcedure()

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env) The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
protected boolean	acquireLock(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env) The user should override this method, and try to take a lock if necessary.
protected Procedure[]	execute(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env) The main code of the procedure.
protected void	rollback(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env) The code to undo what done by the execute() code.

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

deserializeStateData, doExecute, doRollback, serializeStateData

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

addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, elapsedTime, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcId, getResult, getRootProcedureId, getStackIndexes, getStartTime, getState, getTimeout, getTimeRemaining, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, isSuccess, isWaiting, newInstance, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setNonceKey, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, updateTimestamp, validateClass, wasExecuted

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSingleStepProcedure

public TestSingleStepProcedure()

Method Detail

execute

protected Procedure[] execute(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env)

Description copied from class: Procedure

The main code of the procedure. It must be idempotent since execute() may be called multiple time in case of machine failure in the middle of the execution.

Specified by:

execute in class Procedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

Returns:

a set of sub-procedures or null if there is nothing else to execute.

acquireLock

protected boolean acquireLock(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env)

Description copied from class: Procedure

The user should override this method, and try to take a lock if necessary. A lock can be anything, and it is up to the implementor. Example: in our Master we can execute request in parallel for different tables create t1 and create t2 can be executed at the same time. anything else on t1/t2 is queued waiting that specific table create to happen.

Overrides:

acquireLock in class Procedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

Returns:

true if the lock was acquired and false otherwise

rollback

protected void rollback(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env)

Description copied from class: Procedure

The code to undo what done by the execute() code. It is called when the procedure or one of the sub-procedure failed or an abort was requested. It should cleanup all the resources created by the execute() call. The implementation must be idempotent since rollback() may be called multiple time in case of machine failure in the middle of the execution.

Specified by:

rollback in class Procedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

abort

protected boolean abort(org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv env)

Description copied from class: Procedure

The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable. The simplest implementation is to have an AtomicBoolean set in the abort() method and then the execute() will check if the abort flag is set or not. abort() may be called multiple times from the client, so the implementation must be idempotent. NOTE: abort() is not like Thread.interrupt() it is just a notification that allows the procedure implementor where to abort to avoid leak and have a better control on what was executed and what not.

Specified by:

abort in class Procedure<org.apache.hadoop.hbase.procedure2.TestProcedureReplayOrder.TestProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor