org.apache.hadoop.hbase.procedure2

Class ProcedureTestingUtility.TestProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.ProcedureTestingUtility.TestProcedure

All Implemented Interfaces:

Comparable<Procedure>

Enclosing class:

ProcedureTestingUtility

public static class ProcedureTestingUtility.TestProcedure
extends Procedure<Void>

Constructor Summary

Constructors

Constructor and Description
TestProcedure()
TestProcedure(long procId)
TestProcedure(long procId, long parentId)

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.
void	addStackId(int index)
protected void	deserializeStateData(InputStream stream) Called on store load to allow the user to decode the previously serialized state.
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.
protected void	serializeStateData(OutputStream stream) The user-level code of the procedure may have some state to persist (e.g.

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

acquireLock, addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, doExecute, doRollback, 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

TestProcedure

public TestProcedure()

TestProcedure

public TestProcedure(long procId)

TestProcedure

public TestProcedure(long procId,
                     long parentId)

Method Detail

addStackId

public void addStackId(int index)

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>

serializeStateData

protected void serializeStateData(OutputStream stream)
                           throws IOException

Description copied from class: Procedure

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

Specified by:

serializeStateData in class Procedure<Void>

Parameters:

stream - the stream that will contain the user serialized data

Throws:

IOException

deserializeStateData

protected void deserializeStateData(InputStream stream)
                             throws IOException

Description copied from class: Procedure

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

Specified by:

deserializeStateData in class Procedure<Void>

Parameters:

stream - the stream that contains the user serialized data

Throws:

IOException