org.apache.hadoop.hbase.backup.master

Class IncrementalTableBackupProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

org.apache.hadoop.hbase.backup.master.IncrementalTableBackupProcedure

All Implemented Interfaces:

Comparable<Procedure>, TableProcedureInterface

@InterfaceAudience.Private
public class IncrementalTableBackupProcedure
extends StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>
implements TableProcedureInterface

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

StateMachineProcedure.Flow

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Constructor Summary

Constructors

Constructor and Description
IncrementalTableBackupProcedure()
IncrementalTableBackupProcedure(MasterProcedureEnv env, String backupId, List<TableName> tableList, String targetRootDir, int workers, long bandwidth)

Method Summary

Modifier and Type	Method and Description
boolean	abort(MasterProcedureEnv env) The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
protected boolean	acquireLock(MasterProcedureEnv env) The user should override this method, and try to take a lock if necessary.
void	deserializeStateData(InputStream stream) Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, BackupProtos.IncrementalTableBackupState state) called to perform a single step of the specified 'state' of the procedure
protected BackupProtos.IncrementalTableBackupState	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
byte[]	getResult()
protected BackupProtos.IncrementalTableBackupState	getState(int stateId) Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(BackupProtos.IncrementalTableBackupState state) Convert the Enum (or more descriptive) state object to an ordinal (or state id).
TableName	getTableName()
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected void	releaseLock(MasterProcedureEnv env) The user should override this method, and release lock if necessary.
protected void	rollbackState(MasterProcedureEnv env, BackupProtos.IncrementalTableBackupState state) called to perform the rollback of the specified state
void	serializeStateData(OutputStream stream) The user-level code of the procedure may have some state to persist (e.g.
protected void	setNextState(BackupProtos.IncrementalTableBackupState state) Set the next state for the procedure.
void	toStringClassDetails(StringBuilder sb) Extend the toString() information with the procedure details e.g.

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

execute, rollback

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

addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, doExecute, doRollback, elapsedTime, getException, getLastUpdate, getOwner, getParentProcId, getProcId, getRootProcedureId, getStackIndexes, getStartTime, getState, getTimeout, getTimeRemaining, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, isSuccess, isWaiting, newInstance, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, toStringClass, toStringDetails, toStringSimpleSB, updateTimestamp, validateClass, wasExecuted

Methods inherited from class java.lang.Object

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

Constructor Detail

IncrementalTableBackupProcedure

public IncrementalTableBackupProcedure()

IncrementalTableBackupProcedure

public IncrementalTableBackupProcedure(MasterProcedureEnv env,
                                       String backupId,
                                       List<TableName> tableList,
                                       String targetRootDir,
                                       int workers,
                                       long bandwidth)
                                throws IOException

Throws:

IOException

Method Detail

getResult

public byte[] getResult()

Overrides:

getResult in class Procedure<MasterProcedureEnv>

Returns:

the serialized result if any, otherwise null

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      BackupProtos.IncrementalTableBackupState state)

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

state - state to execute

Returns:

Flow.NO_MORE_STATE if the procedure is completed, Flow.HAS_MORE_STATE if there is another step.

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             BackupProtos.IncrementalTableBackupState state)
                      throws IOException

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

getState

protected BackupProtos.IncrementalTableBackupState getState(int stateId)

Description copied from class: StateMachineProcedure

Convert an ordinal (or state id) to an Enum (or more descriptive) state object.

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Parameters:

stateId - the ordinal() of the state enum (or state id)

Returns:

the state enum object

getStateId

protected int getStateId(BackupProtos.IncrementalTableBackupState state)

Description copied from class: StateMachineProcedure

Convert the Enum (or more descriptive) state object to an ordinal (or state id).

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Parameters:

state - the state enum object

Returns:

stateId the ordinal() of the state enum (or state id)

getInitialState

protected BackupProtos.IncrementalTableBackupState getInitialState()

Description copied from class: StateMachineProcedure

Return the initial state object that will be used for the first call to executeFromState().

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Returns:

the initial state enum object

setNextState

protected void setNextState(BackupProtos.IncrementalTableBackupState state)

Description copied from class: StateMachineProcedure

Set the next state for the procedure.

Overrides:

setNextState in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Parameters:

state - the state enum object

abort

public boolean abort(MasterProcedureEnv 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<MasterProcedureEnv>

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Description copied from class: Procedure

Extend the toString() information with the procedure details e.g. className and parameters

Overrides:

toStringClassDetails in class Procedure<MasterProcedureEnv>

Parameters:

sb - the string builder to use to append the proc specific information

serializeStateData

public void serializeStateData(OutputStream stream)
                        throws IOException

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.

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Parameters:

stream - the stream that will contain the user serialized data

Throws:

IOException

deserializeStateData

public void deserializeStateData(InputStream stream)
                          throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,BackupProtos.IncrementalTableBackupState>

Parameters:

stream - the stream that contains the user serialized data

Throws:

IOException

getTableName

public TableName getTableName()

Specified by:

getTableName in interface TableProcedureInterface

Returns:

the name of the table the procedure is operating on

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Returns:

the operation type that the procedure is executing.

acquireLock

protected boolean acquireLock(MasterProcedureEnv env)

Description copied from class: Procedure

The user should override this method, and try to take a lock if necessary. A lock can be anything, and it is up to the implementor. Example: in our Master we can execute request in parallel for different tables create t1 and create t2 can be executed at the same time. anything else on t1/t2 is queued waiting that specific table create to happen.

Overrides:

acquireLock in class Procedure<MasterProcedureEnv>

Returns:

true if the lock was acquired and false otherwise

releaseLock

protected void releaseLock(MasterProcedureEnv env)

Description copied from class: Procedure

The user should override this method, and release lock if necessary.

Overrides:

releaseLock in class Procedure<MasterProcedureEnv>