org.apache.hadoop.hbase.procedure2

Class ProcedureExecutor<TEnvironment>

java.lang.Object

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

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class ProcedureExecutor<TEnvironment>
extends java.lang.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
static interface	ProcedureExecutor.ProcedureExecutorListener
static class	ProcedureExecutor.Testing

Constructor Summary

Constructors

Constructor and Description
ProcedureExecutor(Configuration conf, TEnvironment environment, ProcedureStore store)
ProcedureExecutor(Configuration conf, TEnvironment environment, ProcedureStore store, ProcedureRunnableSet runqueue)

Method Summary

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 the specified procedure.
NonceKey	createNonceKey(long nonceGroup, long nonce) Create a NoneKey from the specified nonceGroup and nonce.
int	getActiveExecutorCount()
TEnvironment	getEnvironment()
int	getNumThreads()
Procedure	getProcedure(long procId)
ProcedureInfo	getResult(long procId)
Pair<ProcedureInfo,Procedure>	getResultOrProcedure(long procId)
java.util.Map<java.lang.Long,ProcedureInfo>	getResults()
protected ProcedureRunnableSet	getRunnableSet()
ProcedureStore	getStore()
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
boolean	isRunning()
boolean	isStarted(long procId) Return true if the procedure is started.
void	join()
java.util.List<ProcedureInfo>	listProcedures() List procedures.
void	registerListener(ProcedureExecutor.ProcedureExecutorListener listener)
long	registerNonce(NonceKey nonceKey) Register a nonce for a procedure that is going to be submitted.
void	removeResult(long procId) Mark the specified completed procedure, as ready to remove.
void	setFailureResultForNonce(NonceKey nonceKey, java.lang.String procName, User procOwner, java.io.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	start(int numThreads)
void	stop()
long	submitProcedure(Procedure proc) Add a new root-procedure to the executor.
long	submitProcedure(Procedure proc, NonceKey nonceKey) Add a 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcedureExecutor

public ProcedureExecutor(Configuration conf,
                         TEnvironment environment,
                         ProcedureStore store)

ProcedureExecutor

public ProcedureExecutor(Configuration conf,
                         TEnvironment environment,
                         ProcedureStore store,
                         ProcedureRunnableSet runqueue)

Method Detail

start

public void start(int numThreads)
           throws java.io.IOException

Throws:

java.io.IOException

stop

public void stop()

join

public void join()

isRunning

public boolean isRunning()

getNumThreads

public int getNumThreads()

Returns:

the number of execution threads.

getActiveExecutorCount

public int getActiveExecutorCount()

getEnvironment

public TEnvironment getEnvironment()

getStore

public ProcedureStore getStore()

registerListener

public void registerListener(ProcedureExecutor.ProcedureExecutorListener listener)

unregisterListener

public boolean unregisterListener(ProcedureExecutor.ProcedureExecutorListener listener)

listProcedures

public java.util.List<ProcedureInfo> listProcedures()

List procedures.

Returns:

the procedures in a list

createNonceKey

public NonceKey createNonceKey(long nonceGroup,
                               long nonce)

Create a NoneKey from the specified nonceGroup and nonce.

Parameters:

nonceGroup -

nonce -

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,
                                     java.lang.String procName,
                                     User procOwner,
                                     java.io.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 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

submitProcedure

public long submitProcedure(Procedure 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

getResult

public ProcedureInfo 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

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 exist and has received the abort, otherwise false.

abort

public boolean abort(long procId,
                     boolean mayInterruptIfRunning)

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

mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?

Returns:

true if the procedure exist and has received the abort, otherwise false.

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.

getResults

public java.util.Map<java.lang.Long,ProcedureInfo> getResults()

getProcedure

public Procedure getProcedure(long procId)

getRunnableSet

protected ProcedureRunnableSet getRunnableSet()

getResultOrProcedure

public Pair<ProcedureInfo,Procedure> getResultOrProcedure(long procId)