org.apache.hadoop.hbase.procedure2

Class ProcedureUtil

java.lang.Object

org.apache.hadoop.hbase.procedure2.ProcedureUtil

@InterfaceAudience.Private
public final class ProcedureUtil
extends Object

Helper to convert to/from ProcedureProtos

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ProcedureUtil.CompatStateSerializer A serializer (deserializer) for those Procedures which were serialized before this patch.
private static class	ProcedureUtil.StateSerializer A serializer for our Procedures.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_PROCEDURE_RETRY_MAX_SLEEP_TIME_MS
static long	DEFAULT_PROCEDURE_RETRY_SLEEP_INTERVAL_MS
static String	PROCEDURE_RETRY_MAX_SLEEP_TIME_MS
static String	PROCEDURE_RETRY_SLEEP_INTERVAL_MS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProcedureUtil()

Method Summary

Modifier and Type	Method and Description
static Procedure<?>	convertToProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proto) Helper to convert the protobuf procedure.
static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockedResource	convertToProtoLockedResource(LockedResource lockedResource)
static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType	convertToProtoLockType(LockType lockType)
static org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure	convertToProtoProcedure(Procedure<?> proc) Helper to convert the procedure to protobuf.
static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockedResourceType	convertToProtoResourceType(LockedResourceType resourceType)
static RetryCounter	createRetryCounter(org.apache.hadoop.conf.Configuration conf) Get a retry counter for getting the backoff time.
static boolean	isFinished(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)
private static Procedure<?>	newProcedure(String className)
(package private) static void	validateClass(Procedure<?> proc)

Methods inherited from class java.lang.Object

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

Field Detail

PROCEDURE_RETRY_SLEEP_INTERVAL_MS

public static final String PROCEDURE_RETRY_SLEEP_INTERVAL_MS

See Also:

Constant Field Values

DEFAULT_PROCEDURE_RETRY_SLEEP_INTERVAL_MS

public static final long DEFAULT_PROCEDURE_RETRY_SLEEP_INTERVAL_MS

See Also:

Constant Field Values

PROCEDURE_RETRY_MAX_SLEEP_TIME_MS

public static final String PROCEDURE_RETRY_MAX_SLEEP_TIME_MS

See Also:

Constant Field Values

DEFAULT_PROCEDURE_RETRY_MAX_SLEEP_TIME_MS

public static final long DEFAULT_PROCEDURE_RETRY_MAX_SLEEP_TIME_MS

Constructor Detail

ProcedureUtil

private ProcedureUtil()

Method Detail

newProcedure

private static Procedure<?> newProcedure(String className)
                                  throws BadProcedureException

Throws:

BadProcedureException

validateClass

static void validateClass(Procedure<?> proc)
                   throws BadProcedureException

Throws:

BadProcedureException

convertToProtoProcedure

public static org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure convertToProtoProcedure(Procedure<?> proc)
                                                                                                           throws IOException

Helper to convert the procedure to protobuf.

Used by ProcedureStore implementations.

Throws:

IOException

convertToProcedure

public static Procedure<?> convertToProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proto)
                                       throws IOException

Helper to convert the protobuf procedure.

Used by ProcedureStore implementations.

TODO: OPTIMIZATION: some of the field never change during the execution (e.g. className, procId, parentId, ...). We can split in 'data' and 'state', and the store may take advantage of it by storing the data only on insert().

Throws:

IOException

convertToProtoResourceType

public static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockedResourceType convertToProtoResourceType(LockedResourceType resourceType)

convertToProtoLockType

public static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType convertToProtoLockType(LockType lockType)

convertToProtoLockedResource

public static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockedResource convertToProtoLockedResource(LockedResource lockedResource)
                                                                                                                       throws IOException

Throws:

IOException

createRetryCounter

public static RetryCounter createRetryCounter(org.apache.hadoop.conf.Configuration conf)

Get a retry counter for getting the backoff time. We will use the RetryCounter.ExponentialBackoffPolicyWithLimit policy, and the base unit is 1 second, max sleep time is 10 minutes by default.

For UTs, you can set the PROCEDURE_RETRY_SLEEP_INTERVAL_MS and PROCEDURE_RETRY_MAX_SLEEP_TIME_MS to make more frequent retry so your UT will not timeout.

isFinished

public static boolean isFinished(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)