org.apache.hadoop.hbase.procedure2

Class TestProcedureExecution.TestSequentialProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.SequentialProcedure<Void>

org.apache.hadoop.hbase.procedure2.TestProcedureExecution.TestSequentialProcedure

All Implemented Interfaces:

Comparable<Procedure>

Enclosing class:

TestProcedureExecution

public static class TestProcedureExecution.TestSequentialProcedure
extends SequentialProcedure<Void>

Constructor Summary

Constructors

Constructor and Description
TestSequentialProcedure()
TestSequentialProcedure(String name, List<String> state, Exception failure)
TestSequentialProcedure(String name, List<String> state, Procedure... subProcs)

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(Void env) The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
protected Procedure[]	execute(Void env) The main code of the procedure.
protected void	rollback(Void 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

acquireLock, addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, elapsedTime, getException, getLastUpdate, 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, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, toStringClass, toStringClassDetails, updateTimestamp, validateClass, wasExecuted

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSequentialProcedure

public TestSequentialProcedure()

TestSequentialProcedure

public TestSequentialProcedure(String name,
                               List<String> state,
                               Procedure... subProcs)

TestSequentialProcedure

public TestSequentialProcedure(String name,
                               List<String> state,
                               Exception failure)

Method Detail

execute

protected Procedure[] execute(Void 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<Void>

Returns:

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

rollback

protected void rollback(Void 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<Void>

abort

protected boolean abort(Void 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<Void>