org.apache.hadoop.hbase.procedure

Class ProcedureCoordinator

java.lang.Object

org.apache.hadoop.hbase.procedure.ProcedureCoordinator

@InterfaceAudience.Private
public class ProcedureCoordinator
extends java.lang.Object

This is the master side of a distributed complex procedure execution.

The Procedure is generic and subclassing or customization shouldn't be necessary -- any customization should happen just in Subprocedures.

Constructor Summary

Constructors

Constructor and Description
ProcedureCoordinator(ProcedureCoordinatorRpcs rpcs, java.util.concurrent.ThreadPoolExecutor pool) Create and start a ProcedureCoordinator.
ProcedureCoordinator(ProcedureCoordinatorRpcs rpcs, java.util.concurrent.ThreadPoolExecutor pool, long timeoutMillis, long wakeTimeMillis) Create and start a ProcedureCoordinator.

Method Summary

Modifier and Type	Method and Description
void	abortProcedure(java.lang.String procName, ForeignException reason) Abort the procedure with the given name
void	close() Shutdown the thread pools and release rpc resources
static java.util.concurrent.ThreadPoolExecutor	defaultPool(java.lang.String coordName, int opThreads) Default thread pool for the procedure
static java.util.concurrent.ThreadPoolExecutor	defaultPool(java.lang.String coordName, int opThreads, long keepAliveMillis) Default thread pool for the procedure
Procedure	getProcedure(java.lang.String name) Returns the procedure.
java.util.Set<java.lang.String>	getProcedureNames()
Procedure	startProcedure(ForeignExceptionDispatcher fed, java.lang.String procName, byte[] procArgs, java.util.List<java.lang.String> expectedMembers) Kick off the named procedure Currently only one procedure with the same type and name is allowed to run at a time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcedureCoordinator

public ProcedureCoordinator(ProcedureCoordinatorRpcs rpcs,
                            java.util.concurrent.ThreadPoolExecutor pool)

Create and start a ProcedureCoordinator. The rpc object registers the ProcedureCoordinator and starts any threads in this constructor.

Parameters:

rpcs -

pool - Used for executing procedures.

ProcedureCoordinator

public ProcedureCoordinator(ProcedureCoordinatorRpcs rpcs,
                            java.util.concurrent.ThreadPoolExecutor pool,
                            long timeoutMillis,
                            long wakeTimeMillis)

Create and start a ProcedureCoordinator. The rpc object registers the ProcedureCoordinator and starts any threads in this constructor.

Parameters:

rpcs -

pool - Used for executing procedures.

timeoutMillis -

Method Detail

defaultPool

public static java.util.concurrent.ThreadPoolExecutor defaultPool(java.lang.String coordName,
                                                                  int opThreads)

Default thread pool for the procedure

Parameters:

coordName -

opThreads - the maximum number of threads to allow in the pool

defaultPool

public static java.util.concurrent.ThreadPoolExecutor defaultPool(java.lang.String coordName,
                                                                  int opThreads,
                                                                  long keepAliveMillis)

Default thread pool for the procedure

Parameters:

coordName -

opThreads - the maximum number of threads to allow in the pool

keepAliveMillis - the maximum time (ms) that excess idle threads will wait for new tasks

close

public void close()
           throws java.io.IOException

Shutdown the thread pools and release rpc resources

Throws:

java.io.IOException

abortProcedure

public void abortProcedure(java.lang.String procName,
                           ForeignException reason)

Abort the procedure with the given name

Parameters:

procName - name of the procedure to abort

reason - serialized information about the abort

startProcedure

public Procedure startProcedure(ForeignExceptionDispatcher fed,
                                java.lang.String procName,
                                byte[] procArgs,
                                java.util.List<java.lang.String> expectedMembers)

Kick off the named procedure Currently only one procedure with the same type and name is allowed to run at a time.

Parameters:

procName - name of the procedure to start

procArgs - arguments for the procedure

expectedMembers - expected members to start

Returns:

handle to the running procedure, if it was started correctly, null otherwise. Null could be due to submitting a procedure multiple times (or one with the same name), or runtime exception. Check the procedure's monitor that holds a reference to the exception that caused the failure.

getProcedure

public Procedure getProcedure(java.lang.String name)

Returns the procedure. This Procedure is a live instance so should not be modified but can be inspected.

Parameters:

name - Name of the procedure

Returns:

Procedure or null if not present any more

getProcedureNames

public java.util.Set<java.lang.String> getProcedureNames()

Returns:

Return set of all procedure names.