ProcedureExecutor (Apache HBase 2.5.0 API)

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

```
@InterfaceAudience.Private
public class ProcedureExecutor<TEnvironment>
extends Object
```
Thread Pool that executes the submitted procedures. The executor has a ProcedureStore associated. Each operation is logged and on restart the pending procedures are resumed. Unless the Procedure code throws an error (e.g. invalid user input) the procedure will complete (at some point in time), On restart the pending procedures are resumed and the once failed will be rolledback. The user can add procedures to the executor via submitProcedure(proc) check for the finished state via isFinished(procId) and get the result via getResult(procId)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`ProcedureExecutor.KeepAliveWorkerThread`
`static interface`	`ProcedureExecutor.ProcedureExecutorListener`
`static class`	`ProcedureExecutor.Testing` Class with parameters describing how to fail/die when in testing-context.
`private class`	`ProcedureExecutor.WorkerMonitor`
`private class`	`ProcedureExecutor.WorkerThread`

Field Summary

Fields
Modifier and Type	Field and Description
`private AtomicInteger`	`activeExecutorCount`
`static String`	`CHECK_OWNER_SET_CONF_KEY`
`private boolean`	`checkOwnerSet`
`private ConcurrentHashMap<Long,CompletedProcedureRetainer<TEnvironment>>`	`completed` Map the the procId returned by submitProcedure(), the Root-ProcID, to the Procedure.
`private org.apache.hadoop.conf.Configuration`	`conf`
`private int`	`corePoolSize`
`(package private) static int`	`DEFAULT_ACKED_EVICT_TTL`
`private static boolean`	`DEFAULT_CHECK_OWNER_SET`
`(package private) static int`	`DEFAULT_EVICT_TTL`
`private static long`	`DEFAULT_WORKER_KEEP_ALIVE_TIME`
`private TEnvironment`	`environment`
`static String`	`EVICT_ACKED_TTL_CONF_KEY`
`static String`	`EVICT_TTL_CONF_KEY`
`private Executor`	`forceUpdateExecutor`
`private long`	`keepAliveTime`
`private AtomicLong`	`lastProcId`
`private CopyOnWriteArrayList<ProcedureExecutor.ProcedureExecutorListener>`	`listeners`
`private static org.slf4j.Logger`	`LOG`
`private int`	`maxPoolSize`
`private ConcurrentHashMap<NonceKey,Long>`	`nonceKeysToProcIdsMap` Helper map to lookup whether the procedure already issued from the same client.
`private ConcurrentHashMap<Long,Procedure<TEnvironment>>`	`procedures` Helper map to lookup the live procedures by ID.
`private IdLock`	`procExecutionLock`
`private ConcurrentHashMap<Long,RootProcedureState<TEnvironment>>`	`rollbackStack` Map the the procId returned by submitProcedure(), the Root-ProcID, to the RootProcedureState.
`private AtomicBoolean`	`running`
`private ProcedureScheduler`	`scheduler` Scheduler/Queue that contains runnable procedures.
`private ProcedureStore`	`store`
`(package private) ProcedureExecutor.Testing`	`testing` `testing` is non-null when ProcedureExecutor is being tested.
`private ThreadGroup`	`threadGroup` Created in the `init(int, boolean)` method.
`private TimeoutExecutorThread<TEnvironment>`	`timeoutExecutor` Created in the `init(int, boolean)` method.
`static String`	`WORKER_KEEP_ALIVE_TIME_CONF_KEY`
`private AtomicLong`	`workerId`
`private TimeoutExecutorThread<TEnvironment>`	`workerMonitorExecutor` WorkerMonitor check for stuck workers and new worker thread when necessary, for example if there is no worker to assign meta, it will new worker thread for it, so it is very important.
`private CopyOnWriteArrayList<ProcedureExecutor.WorkerThread>`	`workerThreads` Created in the `init(int, boolean)` method.

Constructor Summary

Constructors
Constructor and Description
`ProcedureExecutor(org.apache.hadoop.conf.Configuration conf, TEnvironment environment, ProcedureStore store)`
`ProcedureExecutor(org.apache.hadoop.conf.Configuration conf, TEnvironment environment, ProcedureStore store, ProcedureScheduler scheduler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`abort(long procId)` Send an abort notification the specified procedure.
`boolean`	`abort(long procId, boolean mayInterruptIfRunning)` Send an abort notification to the specified procedure.
`private Procedure.LockState`	`acquireLock(Procedure<TEnvironment> proc)`
`void`	`addChore(ProcedureInMemoryChore<TEnvironment> chore)` Add a chore procedure to the executor
`List<Boolean>`	`bypassProcedure(List<Long> pids, long lockWait, boolean force, boolean recursive)` Bypass a procedure.
`(package private) boolean`	`bypassProcedure(long pid, long lockWait, boolean override, boolean recursive)`
`private void`	`cleanupAfterRollbackOneStep(Procedure<TEnvironment> proc)`
`private void`	`countDownChildren(RootProcedureState<TEnvironment> procStack, Procedure<TEnvironment> procedure)`
`NonceKey`	`createNonceKey(long nonceGroup, long nonce)` Create a NonceKey from the specified nonceGroup and nonce.
`private void`	`execCompletionCleanup(Procedure<TEnvironment> proc)`
`private void`	`execProcedure(RootProcedureState<TEnvironment> procStack, Procedure<TEnvironment> procedure)` Executes `procedure` Calls the doExecute() of the procedure If the procedure execution didn't fail (i.e.
`private void`	`executeProcedure(Procedure<TEnvironment> proc)`
`private Procedure.LockState`	`executeRollback(long rootProcId, RootProcedureState<TEnvironment> procStack)` Execute the rollback of the full procedure stack.
`private Procedure.LockState`	`executeRollback(Procedure<TEnvironment> proc)` Execute the rollback of the procedure step.
`private void`	`forceUpdateProcedure(long procId)`
`int`	`getActiveExecutorCount()`
`Collection<Procedure<TEnvironment>>`	`getActiveProceduresNoCopy()` Should only be used when starting up, where the procedure workers have not been started.
`Set<Long>`	`getActiveProcIds()`
`(package private) int`	`getCompletedSize()`
`int`	`getCorePoolSize()` Returns the core pool size settings.
`TEnvironment`	`getEnvironment()`
`long`	`getKeepAliveTime(TimeUnit timeUnit)`
`protected long`	`getLastProcId()`
`<T extends Procedure<TEnvironment>> T`	`getProcedure(Class<T> clazz, long procId)`
`Procedure<TEnvironment>`	`getProcedure(long procId)`
`List<Procedure<TEnvironment>>`	`getProcedures()` Get procedures.
`(package private) ProcedureScheduler`	`getProcedureScheduler()`
`IdLock`	`getProcExecutionLock()`
`(package private) RootProcedureState<TEnvironment>`	`getProcStack(long rootProcId)`
`Procedure<TEnvironment>`	`getResult(long procId)`
`Procedure<TEnvironment>`	`getResultOrProcedure(long procId)`
`(package private) Long`	`getRootProcedureId(Procedure<TEnvironment> proc)`
`(package private) ProcedureScheduler`	`getScheduler()`
`ProcedureStore`	`getStore()`
`int`	`getWorkerThreadCount()` Returns the current number of worker threads.
`private void`	`handleInterruptedException(Procedure<TEnvironment> proc, InterruptedException e)`
`void`	`init(int numThreads, boolean abortOnCorruption)` Initialize the procedure executor, but do not start workers.
`private Procedure<TEnvironment>[]`	`initializeChildren(RootProcedureState<TEnvironment> procStack, Procedure<TEnvironment> procedure, Procedure<TEnvironment>[] subprocs)`
`boolean`	`isFinished(long procId)` Return true if the procedure is finished.
`boolean`	`isProcedureOwner(long procId, User user)` Check if the user is this procedure's owner
`private boolean`	`isRootFinished(Procedure<?> proc)`
`boolean`	`isRunning()`
`boolean`	`isStarted(long procId)` Return true if the procedure is started.
`void`	`join()`
`private void`	`kill(String msg)`
`private void`	`load(boolean abortOnCorruption)`
`private void`	`loadProcedures(ProcedureStore.ProcedureIterator procIter, boolean abortOnCorruption)`
`private long`	`nextProcId()`
`private Procedure<TEnvironment>`	`prepareProcedure(Procedure<TEnvironment> proc)`
`private void`	`procedureFinished(Procedure<TEnvironment> proc)`
`private long`	`pushProcedure(Procedure<TEnvironment> proc)`
`void`	`refreshConfiguration(org.apache.hadoop.conf.Configuration conf)`
`void`	`registerListener(ProcedureExecutor.ProcedureExecutorListener listener)`
`long`	`registerNonce(NonceKey nonceKey)` Register a nonce for a procedure that is going to be submitted.
`private void`	`releaseLock(Procedure<TEnvironment> proc, boolean force)`
`boolean`	`removeChore(ProcedureInMemoryChore<TEnvironment> chore)` Remove a chore procedure from the executor
`void`	`removeResult(long procId)` Mark the specified completed procedure, as ready to remove.
`private void`	`restoreLock(Procedure<TEnvironment> proc, Set<Long> restored)`
`private void`	`restoreLocks()`
`private void`	`restoreLocks(Deque<Procedure<TEnvironment>> stack, Set<Long> restored)`
`private void`	`sendProcedureAddedNotification(long procId)`
`private void`	`sendProcedureFinishedNotification(long procId)`
`private void`	`sendProcedureLoadedNotification(long procId)`
`void`	`setFailureResultForNonce(NonceKey nonceKey, String procName, User procOwner, IOException exception)` If the failure failed before submitting it, we may want to give back the same error to the requests with the same nonceKey.
`void`	`setKeepAliveTime(long keepAliveTime, TimeUnit timeUnit)`
`void`	`startWorkers()` Start the workers.
`void`	`stop()`
`private void`	`submitChildrenProcedures(Procedure<TEnvironment>[] subprocs)`
`long`	`submitProcedure(Procedure<TEnvironment> proc)` Add a new root-procedure to the executor.
`long`	`submitProcedure(Procedure<TEnvironment> proc, NonceKey nonceKey)` Add a new root-procedure to the executor.
`void`	`submitProcedures(Procedure<TEnvironment>[] procs)` Add a set of new root-procedure to the executor.
`boolean`	`unregisterListener(ProcedureExecutor.ProcedureExecutorListener listener)`
`void`	`unregisterNonceIfProcedureWasNotSubmitted(NonceKey nonceKey)` Remove the NonceKey if the procedure was not submitted to the executor.
`private void`	`updateStoreOnExec(RootProcedureState<TEnvironment> procStack, Procedure<TEnvironment> procedure, Procedure<TEnvironment>[] subprocs)`
`private void`	`yieldProcedure(Procedure<TEnvironment> proc)`

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

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
  - CHECK_OWNER_SET_CONF_KEY
```
public static final String CHECK_OWNER_SET_CONF_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CHECK_OWNER_SET
```
private static final boolean DEFAULT_CHECK_OWNER_SET
```
    See Also:
    
    Constant Field Values
  - WORKER_KEEP_ALIVE_TIME_CONF_KEY
```
public static final String WORKER_KEEP_ALIVE_TIME_CONF_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_WORKER_KEEP_ALIVE_TIME
```
private static final long DEFAULT_WORKER_KEEP_ALIVE_TIME
```
  - EVICT_TTL_CONF_KEY
```
public static final String EVICT_TTL_CONF_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EVICT_TTL
```
static final int DEFAULT_EVICT_TTL
```
    See Also:
    
    Constant Field Values
  - EVICT_ACKED_TTL_CONF_KEY
```
public static final String EVICT_ACKED_TTL_CONF_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ACKED_EVICT_TTL
```
static final int DEFAULT_ACKED_EVICT_TTL
```
    See Also:
    
    Constant Field Values
  - testing
```
volatile ProcedureExecutor.Testing testing
```
    testing is non-null when ProcedureExecutor is being tested. Tests will try to break PE having it fail at various junctures. When non-null, testing is set to an instance of the below internal ProcedureExecutor.Testing class with flags set for the particular test.
  - completed
```
private final ConcurrentHashMap<Long,CompletedProcedureRetainer<TEnvironment>> completed
```
    Map the the procId returned by submitProcedure(), the Root-ProcID, to the Procedure. Once a Root-Procedure completes (success or failure), the result will be added to this map. The user of ProcedureExecutor should call getResult(procId) to get the result.
  - rollbackStack
```
private final ConcurrentHashMap<Long,RootProcedureState<TEnvironment>> rollbackStack
```
    Map the the procId returned by submitProcedure(), the Root-ProcID, to the RootProcedureState. The RootProcedureState contains the execution stack of the Root-Procedure, It is added to the map by submitProcedure() and removed on procedure completion.
  - procedures
```
private final ConcurrentHashMap<Long,Procedure<TEnvironment>> procedures
```
    Helper map to lookup the live procedures by ID. This map contains every procedure. root-procedures and subprocedures.
  - nonceKeysToProcIdsMap
```
private final ConcurrentHashMap<NonceKey,Long> nonceKeysToProcIdsMap
```
    Helper map to lookup whether the procedure already issued from the same client. This map contains every root procedure.
  - listeners
```
private final CopyOnWriteArrayList<ProcedureExecutor.ProcedureExecutorListener> listeners
```
  - conf
```
private org.apache.hadoop.conf.Configuration conf
```
  - threadGroup
```
private ThreadGroup threadGroup
```
    Created in the init(int, boolean) method. Destroyed in join() (FIX! Doing resource handling rather than observing in a #join is unexpected). Overridden when we do the ProcedureTestingUtility.testRecoveryAndDoubleExecution trickery (Should be ok).
  - workerThreads
```
private CopyOnWriteArrayList<ProcedureExecutor.WorkerThread> workerThreads
```
    Created in the init(int, boolean) method. Terminated in join() (FIX! Doing resource handling rather than observing in a #join is unexpected). Overridden when we do the ProcedureTestingUtility.testRecoveryAndDoubleExecution trickery (Should be ok).
  - timeoutExecutor
```
private TimeoutExecutorThread<TEnvironment> timeoutExecutor
```
    Created in the init(int, boolean) method. Terminated in join() (FIX! Doing resource handling rather than observing in a #join is unexpected). Overridden when we do the ProcedureTestingUtility.testRecoveryAndDoubleExecution trickery (Should be ok).
  - workerMonitorExecutor
```
private TimeoutExecutorThread<TEnvironment> workerMonitorExecutor
```
    WorkerMonitor check for stuck workers and new worker thread when necessary, for example if there is no worker to assign meta, it will new worker thread for it, so it is very important. TimeoutExecutor execute many tasks like DeadServerMetricRegionChore RegionInTransitionChore and so on, some tasks may execute for a long time so will block other tasks like WorkerMonitor, so use a dedicated thread for executing WorkerMonitor.
  - corePoolSize
```
private int corePoolSize
```
  - maxPoolSize
```
private int maxPoolSize
```
  - keepAliveTime
```
private volatile long keepAliveTime
```
  - scheduler
```
private final ProcedureScheduler scheduler
```
    Scheduler/Queue that contains runnable procedures.
  - forceUpdateExecutor
```
private final Executor forceUpdateExecutor
```
  - lastProcId
```
private final AtomicLong lastProcId
```
  - workerId
```
private final AtomicLong workerId
```
  - activeExecutorCount
```
private final AtomicInteger activeExecutorCount
```
  - running
```
private final AtomicBoolean running
```
  - environment
```
private final TEnvironment environment
```
  - store
```
private final ProcedureStore store
```
  - checkOwnerSet
```
private final boolean checkOwnerSet
```
  - procExecutionLock
```
private final IdLock procExecutionLock
```
- Constructor Detail
  - ProcedureExecutor
```
public ProcedureExecutor(org.apache.hadoop.conf.Configuration conf,
                         TEnvironment environment,
                         ProcedureStore store)
```
  - ProcedureExecutor
```
public ProcedureExecutor(org.apache.hadoop.conf.Configuration conf,
                         TEnvironment environment,
                         ProcedureStore store,
                         ProcedureScheduler scheduler)
```
- Method Detail
  - isRootFinished
```
private boolean isRootFinished(Procedure<?> proc)
```
  - forceUpdateProcedure
```
private void forceUpdateProcedure(long procId)
                           throws IOException
```
    Throws:
    
    IOException
  - load
```
private void load(boolean abortOnCorruption)
           throws IOException
```
    Throws:
    
    IOException
  - restoreLock
```
private void restoreLock(Procedure<TEnvironment> proc,
                         Set<Long> restored)
```
  - restoreLocks
```
private void restoreLocks(Deque<Procedure<TEnvironment>> stack,
                          Set<Long> restored)
```
  - restoreLocks
```
private void restoreLocks()
```
  - loadProcedures
```
private void loadProcedures(ProcedureStore.ProcedureIterator procIter,
                            boolean abortOnCorruption)
                     throws IOException
```
    Throws:
    
    IOException
  - init
```
public void init(int numThreads,
                 boolean abortOnCorruption)
          throws IOException
```
    Initialize the procedure executor, but do not start workers. We will start them later.
    It calls ProcedureStore.recoverLease() and ProcedureStore.load() to recover the lease, and ensure a single executor, and start the procedure replay to resume and recover the previous pending and in-progress procedures.
    
    Parameters:
    
    numThreads - number of threads available for procedure execution.
    
    abortOnCorruption - true if you want to abort your service in case a corrupted procedure is found on replay. otherwise false.
    
    Throws:
    
    IOException
  - startWorkers
```
public void startWorkers()
                  throws IOException
```
    Start the workers.
    
    Throws:
    
    IOException
  - stop
```
public void stop()
```
  - join
```
public void join()
```
  - refreshConfiguration
```
public void refreshConfiguration(org.apache.hadoop.conf.Configuration conf)
```
  - isRunning
```
public boolean isRunning()
```
  - getWorkerThreadCount
```
public int getWorkerThreadCount()
```
    Returns the current number of worker threads.
  - getCorePoolSize
```
public int getCorePoolSize()
```
    Returns the core pool size settings.
  - getActiveExecutorCount
```
public int getActiveExecutorCount()
```
  - getEnvironment
```
public TEnvironment getEnvironment()
```
  - getStore
```
public ProcedureStore getStore()
```
  - getScheduler
```
ProcedureScheduler getScheduler()
```
  - setKeepAliveTime
```
public void setKeepAliveTime(long keepAliveTime,
                             TimeUnit timeUnit)
```
  - getKeepAliveTime
```
public long getKeepAliveTime(TimeUnit timeUnit)
```
  - addChore
```
public void addChore(@Nullable
                     ProcedureInMemoryChore<TEnvironment> chore)
```
    Add a chore procedure to the executor
    
    Parameters:
    
    chore - the chore to add
  - removeChore
```
public boolean removeChore(@Nullable
                           ProcedureInMemoryChore<TEnvironment> chore)
```
    Remove a chore procedure from the executor
    
    Parameters:
    
    chore - the chore to remove
    
    Returns:
    
    whether the chore is removed, or it will be removed later
  - createNonceKey
```
public NonceKey createNonceKey(long nonceGroup,
                               long nonce)
```
    Create a NonceKey from the specified nonceGroup and nonce.
    
    Parameters:
    
    nonceGroup - the group to use for the NonceKey
    
    nonce - the nonce to use in the NonceKey
    
    Returns:
    
    the generated NonceKey
  - registerNonce
```
public long registerNonce(NonceKey nonceKey)
```
    Register a nonce for a procedure that is going to be submitted. A procId will be reserved and on submitProcedure(), the procedure with the specified nonce will take the reserved ProcId. If someone already reserved the nonce, this method will return the procId reserved, otherwise an invalid procId will be returned. and the caller should procede and submit the procedure.
    
    Parameters:
    
    nonceKey - A unique identifier for this operation from the client or process.
    
    Returns:
    
    the procId associated with the nonce, if any otherwise an invalid procId.
  - unregisterNonceIfProcedureWasNotSubmitted
```
public void unregisterNonceIfProcedureWasNotSubmitted(NonceKey nonceKey)
```
    Remove the NonceKey if the procedure was not submitted to the executor.
    
    Parameters:
    
    nonceKey - A unique identifier for this operation from the client or process.
  - setFailureResultForNonce
```
public void setFailureResultForNonce(NonceKey nonceKey,
                                     String procName,
                                     User procOwner,
                                     IOException exception)
```
    If the failure failed before submitting it, we may want to give back the same error to the requests with the same nonceKey.
    
    Parameters:
    
    nonceKey - A unique identifier for this operation from the client or process
    
    procName - name of the procedure, used to inform the user
    
    procOwner - name of the owner of the procedure, used to inform the user
    
    exception - the failure to report to the user
  - submitProcedure
```
public long submitProcedure(Procedure<TEnvironment> proc)
```
    Add a new root-procedure to the executor.
    
    Parameters:
    
    proc - the new procedure to execute.
    
    Returns:
    
    the procedure id, that can be used to monitor the operation
  - bypassProcedure
```
public List<Boolean> bypassProcedure(List<Long> pids,
                                     long lockWait,
                                     boolean force,
                                     boolean recursive)
                              throws IOException
```
    Bypass a procedure. If the procedure is set to bypass, all the logic in execute/rollback will be ignored and it will return success, whatever. It is used to recover buggy stuck procedures, releasing the lock resources and letting other procedures run. Bypassing one procedure (and its ancestors will be bypassed automatically) may leave the cluster in a middle state, e.g. region not assigned, or some hdfs files left behind. After getting rid of those stuck procedures, the operators may have to do some clean up on hdfs or schedule some assign procedures to let region online. DO AT YOUR OWN RISK.
    A procedure can be bypassed only if 1. The procedure is in state of RUNNABLE, WAITING, WAITING_TIMEOUT or it is a root procedure without any child. 2. No other worker thread is executing it 3. No child procedure has been submitted
    If all the requirements are meet, the procedure and its ancestors will be bypassed and persisted to WAL.
    If the procedure is in WAITING state, will set it to RUNNABLE add it to run queue. TODO: What about WAITING_TIMEOUT?
    
    Parameters:
    
    pids - the procedure id
    
    lockWait - time to wait lock
    
    force - if force set to true, we will bypass the procedure even if it is executing. This is for procedures which can't break out during executing(due to bug, mostly) In this case, bypassing the procedure is not enough, since it is already stuck there. We need to restart the master after bypassing, and letting the problematic procedure to execute wth bypass=true, so in that condition, the procedure can be successfully bypassed.
    
    recursive - We will do an expensive search for children of each pid. EXPENSIVE!
    
    Returns:
    
    true if bypass success
    
    Throws:
    
    IOException - IOException
  - bypassProcedure
```
boolean bypassProcedure(long pid,
                        long lockWait,
                        boolean override,
                        boolean recursive)
                 throws IOException
```
    Throws:
    
    IOException
  - submitProcedure
```
public long submitProcedure(Procedure<TEnvironment> proc,
                            NonceKey nonceKey)
```
    Add a new root-procedure to the executor.
    
    Parameters:
    
    proc - the new procedure to execute.
    
    nonceKey - the registered unique identifier for this operation from the client or process.
    
    Returns:
    
    the procedure id, that can be used to monitor the operation
  - submitProcedures
```
public void submitProcedures(Procedure<TEnvironment>[] procs)
```
    Add a set of new root-procedure to the executor.
    
    Parameters:
    
    procs - the new procedures to execute.
  - prepareProcedure
```
private Procedure<TEnvironment> prepareProcedure(Procedure<TEnvironment> proc)
```
  - pushProcedure
```
private long pushProcedure(Procedure<TEnvironment> proc)
```
  - abort
```
public boolean abort(long procId)
```
    Send an abort notification the specified procedure. Depending on the procedure implementation the abort can be considered or ignored.
    
    Parameters:
    
    procId - the procedure to abort
    
    Returns:
    
    true if the procedure exists and has received the abort, otherwise false.
  - abort
```
public boolean abort(long procId,
                     boolean mayInterruptIfRunning)
```
    Send an abort notification to the specified procedure. Depending on the procedure implementation, the abort can be considered or ignored.
    
    Parameters:
    
    procId - the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    Returns:
    
    true if the procedure exists and has received the abort, otherwise false.
  - getProcedure
```
public Procedure<TEnvironment> getProcedure(long procId)
```
  - getProcedure
```
public <T extends Procedure<TEnvironment>> T getProcedure(Class<T> clazz,
                                                          long procId)
```
  - getResult
```
public Procedure<TEnvironment> getResult(long procId)
```
  - isFinished
```
public boolean isFinished(long procId)
```
    Return true if the procedure is finished. The state may be "completed successfully" or "failed and rolledback". Use getResult() to check the state or get the result data.
    
    Parameters:
    
    procId - the ID of the procedure to check
    
    Returns:
    
    true if the procedure execution is finished, otherwise false.
  - isStarted
```
public boolean isStarted(long procId)
```
    Return true if the procedure is started.
    
    Parameters:
    
    procId - the ID of the procedure to check
    
    Returns:
    
    true if the procedure execution is started, otherwise false.
  - removeResult
```
public void removeResult(long procId)
```
    Mark the specified completed procedure, as ready to remove.
    
    Parameters:
    
    procId - the ID of the procedure to remove
  - getResultOrProcedure
```
public Procedure<TEnvironment> getResultOrProcedure(long procId)
```
  - isProcedureOwner
```
public boolean isProcedureOwner(long procId,
                                User user)
```
    Check if the user is this procedure's owner
    
    Parameters:
    
    procId - the target procedure
    
    user - the user
    
    Returns:
    
    true if the user is the owner of the procedure, false otherwise or the owner is unknown.
  - getActiveProceduresNoCopy
```
public Collection<Procedure<TEnvironment>> getActiveProceduresNoCopy()
```
    Should only be used when starting up, where the procedure workers have not been started.
    If the procedure works has been started, the return values maybe changed when you are processing it so usually this is not safe. Use getProcedures() below for most cases as it will do a copy, and also include the finished procedures.
  - getProcedures
```
public List<Procedure<TEnvironment>> getProcedures()
```
    Get procedures.
    
    Returns:
    
    the procedures in a list
  - registerListener
```
public void registerListener(ProcedureExecutor.ProcedureExecutorListener listener)
```
  - unregisterListener
```
public boolean unregisterListener(ProcedureExecutor.ProcedureExecutorListener listener)
```
  - sendProcedureLoadedNotification
```
private void sendProcedureLoadedNotification(long procId)
```
  - sendProcedureAddedNotification
```
private void sendProcedureAddedNotification(long procId)
```
  - sendProcedureFinishedNotification
```
private void sendProcedureFinishedNotification(long procId)
```
  - nextProcId
```
private long nextProcId()
```
  - getLastProcId
```
protected long getLastProcId()
```
  - getActiveProcIds
```
public Set<Long> getActiveProcIds()
```
  - getRootProcedureId
```
Long getRootProcedureId(Procedure<TEnvironment> proc)
```
  - executeProcedure
```
private void executeProcedure(Procedure<TEnvironment> proc)
```
  - acquireLock
```
private Procedure.LockState acquireLock(Procedure<TEnvironment> proc)
```
  - releaseLock
```
private void releaseLock(Procedure<TEnvironment> proc,
                         boolean force)
```
  - executeRollback
```
private Procedure.LockState executeRollback(long rootProcId,
                                            RootProcedureState<TEnvironment> procStack)
```
    Execute the rollback of the full procedure stack. Once the procedure is rolledback, the root-procedure will be visible as finished to user, and the result will be the fatal exception.
  - cleanupAfterRollbackOneStep
```
private void cleanupAfterRollbackOneStep(Procedure<TEnvironment> proc)
```
  - executeRollback
```
private Procedure.LockState executeRollback(Procedure<TEnvironment> proc)
```
    Execute the rollback of the procedure step. It updates the store with the new state (stack index) or will remove completly the procedure in case it is a child.
  - yieldProcedure
```
private void yieldProcedure(Procedure<TEnvironment> proc)
```
  - execProcedure
```
private void execProcedure(RootProcedureState<TEnvironment> procStack,
                           Procedure<TEnvironment> procedure)
```
    Executes procedure
    - Calls the doExecute() of the procedure
    - If the procedure execution didn't fail (i.e. valid user input)
      
      ...and returned subprocedures
      
      The subprocedures are initialized.
      The subprocedures are added to the store
      The subprocedures are added to the runnable queue
      The procedure is now in a WAITING state, waiting for the subprocedures to complete
      
      ...if there are no subprocedure
      
      the procedure completed successfully
      if there is a parent (WAITING)
      the parent state will be set to RUNNABLE
    - In case of failure
      
      The store is updated with the new state
      
      The executor (caller of this method) will start the rollback of the procedure
  - kill
```
private void kill(String msg)
```
  - initializeChildren
```
private Procedure<TEnvironment>[] initializeChildren(RootProcedureState<TEnvironment> procStack,
                                                     Procedure<TEnvironment> procedure,
                                                     Procedure<TEnvironment>[] subprocs)
```
  - submitChildrenProcedures
```
private void submitChildrenProcedures(Procedure<TEnvironment>[] subprocs)
```
  - countDownChildren
```
private void countDownChildren(RootProcedureState<TEnvironment> procStack,
                               Procedure<TEnvironment> procedure)
```
  - updateStoreOnExec
```
private void updateStoreOnExec(RootProcedureState<TEnvironment> procStack,
                               Procedure<TEnvironment> procedure,
                               Procedure<TEnvironment>[] subprocs)
```
  - handleInterruptedException
```
private void handleInterruptedException(Procedure<TEnvironment> proc,
                                        InterruptedException e)
```
  - execCompletionCleanup
```
private void execCompletionCleanup(Procedure<TEnvironment> proc)
```
  - procedureFinished
```
private void procedureFinished(Procedure<TEnvironment> proc)
```
  - getProcStack
```
RootProcedureState<TEnvironment> getProcStack(long rootProcId)
```
  - getProcedureScheduler
```
ProcedureScheduler getProcedureScheduler()
```
  - getCompletedSize
```
int getCompletedSize()
```
  - getProcExecutionLock
```
public IdLock getProcExecutionLock()
```

Class ProcedureExecutor<TEnvironment>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

CHECK_OWNER_SET_CONF_KEY

DEFAULT_CHECK_OWNER_SET

WORKER_KEEP_ALIVE_TIME_CONF_KEY

DEFAULT_WORKER_KEEP_ALIVE_TIME

EVICT_TTL_CONF_KEY

DEFAULT_EVICT_TTL

EVICT_ACKED_TTL_CONF_KEY

DEFAULT_ACKED_EVICT_TTL

testing

completed

rollbackStack

procedures

nonceKeysToProcIdsMap

listeners

conf

threadGroup

workerThreads

timeoutExecutor

workerMonitorExecutor

corePoolSize

maxPoolSize

keepAliveTime

scheduler

forceUpdateExecutor

lastProcId

workerId

activeExecutorCount

running

environment

store

checkOwnerSet

procExecutionLock

Constructor Detail

ProcedureExecutor

ProcedureExecutor

Method Detail

isRootFinished

forceUpdateProcedure

load

restoreLock

restoreLocks

restoreLocks

loadProcedures

init

startWorkers

stop

join

refreshConfiguration

isRunning

getWorkerThreadCount

getCorePoolSize

getActiveExecutorCount

getEnvironment

getStore

getScheduler

setKeepAliveTime

getKeepAliveTime

addChore

removeChore

createNonceKey

registerNonce

unregisterNonceIfProcedureWasNotSubmitted

setFailureResultForNonce

submitProcedure

bypassProcedure

bypassProcedure

submitProcedure

submitProcedures

prepareProcedure

pushProcedure

abort

abort