ProcedureInMemoryChore (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>
- - org.apache.hadoop.hbase.procedure2.ProcedureInMemoryChore<TEnvironment>

All Implemented Interfaces:

Comparable<Procedure>
```
@InterfaceAudience.Private
@InterfaceStability.Evolving
public abstract class ProcedureInMemoryChore<TEnvironment>
extends Procedure<TEnvironment>
```
Special procedure used as a chore. instead of bringing the Chore class in (dependencies reason), we reuse the executor timeout thread for this special case. The assumption is that procedure is used as hook to dispatch other procedures or trigger some cleanups. It does not store state in the ProcedureStore. this is just for in-memory chore executions.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProcedureInMemoryChore(int timeoutMsec)

Constructors
Modifier	Constructor and Description
`protected`	`ProcedureInMemoryChore(int timeoutMsec)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`abort(TEnvironment env)` The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
`void`	`deserializeStateData(InputStream stream)` Called on store load to allow the user to decode the previously serialized state.
`protected Procedure[]`	`execute(TEnvironment env)` The main code of the procedure.
`protected abstract void`	`periodicExecute(TEnvironment env)`
`protected void`	`rollback(TEnvironment env)` The code to undo what done by the execute() code.
`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, getNonceKey, getOwner, getParentProcId, getProcId, getProcIdHashCode, getResult, getRootProcedureId, getStackIndexes, getStartTime, getState, getTimeout, getTimeRemaining, hasChildren, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, newInstance, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setNonceKey, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, shouldWaitClientAck, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, toStringState, updateTimestamp, validateClass, wasExecuted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProcedureInMemoryChore
```
protected ProcedureInMemoryChore(int timeoutMsec)
```
- Method Detail
  - periodicExecute
```
protected abstract void periodicExecute(TEnvironment env)
```
  - execute
```
protected Procedure[] execute(TEnvironment 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<TEnvironment>
    
    Parameters:
    env - the environment passed to the ProcedureExecutor
    
    Returns:
    a set of sub-procedures or null if there is nothing else to execute.
  - rollback
```
protected void rollback(TEnvironment 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<TEnvironment>
    
    Parameters:
    env - the environment passed to the ProcedureExecutor
  - abort
```
protected boolean abort(TEnvironment 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<TEnvironment>
  - serializeStateData
```
public void serializeStateData(OutputStream stream)
```
    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<TEnvironment>
    
    Parameters:
    stream - the stream that will contain the user serialized data
  - deserializeStateData
```
public void deserializeStateData(InputStream stream)
```
    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<TEnvironment>
    
    Parameters:
    stream - the stream that contains the user serialized data

Class ProcedureInMemoryChore<TEnvironment>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ProcedureInMemoryChore

Method Detail

periodicExecute

execute

rollback

abort

serializeStateData

deserializeStateData