ProcedureExecutor.CompletedProcedureCleaner (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

Comparable<Procedure>

Enclosing class:

ProcedureExecutor<TEnvironment>
```
private static class ProcedureExecutor.CompletedProcedureCleaner<TEnvironment>
extends Procedure<TEnvironment>
```
Internal cleaner that removes the completed procedure results after a TTL. NOTE: This is a special case handled in timeoutLoop(). Since the client code looks more or less like: procId = master.doOperation() while (master.getProcResult(procId) == ProcInProgress); The master should not throw away the proc result as soon as the procedure is done but should wait a result request from the client (see executor.removeResult(procId)) The client will call something like master.isProcDone() or master.getProcResult() which will return the result/state to the client, and it will mark the completed proc as ready to delete. note that the client may not receive the response from the master (e.g. master failover) so, if we delay a bit the real deletion of the proc result the client will be able to get the result the next try.

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`CLEANER_INTERVAL_CONF_KEY`
`private Map<Long,ProcedureInfo>`	`completed`
`private org.apache.hadoop.conf.Configuration`	`conf`
`private static int`	`DEFAULT_ACKED_EVICT_TTL`
`private static int`	`DEFAULT_CLEANER_INTERVAL`
`private static int`	`DEFAULT_EVICT_TTL`
`private static String`	`EVICT_ACKED_TTL_CONF_KEY`
`private static String`	`EVICT_TTL_CONF_KEY`
`private static org.apache.commons.logging.Log`	`LOG`
`private Map<NonceKey,Long>`	`nonceKeysToProcIdsMap`
`private ProcedureStore`	`store`

Constructor Summary

Constructors
Constructor and Description
`ProcedureExecutor.CompletedProcedureCleaner(org.apache.hadoop.conf.Configuration conf, ProcedureStore store, Map<Long,ProcedureInfo> completedMap, Map<NonceKey,Long> nonceKeysToProcIdsMap)`

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.
`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, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, 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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - CLEANER_INTERVAL_CONF_KEY
```
private static final String CLEANER_INTERVAL_CONF_KEY
```
    See Also:
    Constant Field Values
  - DEFAULT_CLEANER_INTERVAL
```
private static final int DEFAULT_CLEANER_INTERVAL
```
    See Also:
    Constant Field Values
  - EVICT_TTL_CONF_KEY
```
private static final String EVICT_TTL_CONF_KEY
```
    See Also:
    Constant Field Values
  - DEFAULT_EVICT_TTL
```
private static final int DEFAULT_EVICT_TTL
```
    See Also:
    Constant Field Values
  - EVICT_ACKED_TTL_CONF_KEY
```
private static final String EVICT_ACKED_TTL_CONF_KEY
```
    See Also:
    Constant Field Values
  - DEFAULT_ACKED_EVICT_TTL
```
private static final int DEFAULT_ACKED_EVICT_TTL
```
    See Also:
    Constant Field Values
  - completed
```
private final Map<Long,ProcedureInfo> completed
```
  - nonceKeysToProcIdsMap
```
private final Map<NonceKey,Long> nonceKeysToProcIdsMap
```
  - store
```
private final ProcedureStore store
```
  - conf
```
private final org.apache.hadoop.conf.Configuration conf
```
- Constructor Detail
  - ProcedureExecutor.CompletedProcedureCleaner
```
public ProcedureExecutor.CompletedProcedureCleaner(org.apache.hadoop.conf.Configuration conf,
                                           ProcedureStore store,
                                           Map<Long,ProcedureInfo> completedMap,
                                           Map<NonceKey,Long> nonceKeysToProcIdsMap)
```
- Method Detail
  - periodicExecute
```
public 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 ProcedureExecutor.CompletedProcedureCleaner<TEnvironment>

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOG

CLEANER_INTERVAL_CONF_KEY

DEFAULT_CLEANER_INTERVAL

EVICT_TTL_CONF_KEY

DEFAULT_EVICT_TTL

EVICT_ACKED_TTL_CONF_KEY

DEFAULT_ACKED_EVICT_TTL

completed

nonceKeysToProcIdsMap

store

conf

Constructor Detail

ProcedureExecutor.CompletedProcedureCleaner

Method Detail

periodicExecute

execute

rollback

abort

serializeStateData

deserializeStateData