org.apache.hadoop.hbase.master.replication

Class ModifyPeerProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,TState>

org.apache.hadoop.hbase.master.replication.AbstractPeerProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

org.apache.hadoop.hbase.master.replication.ModifyPeerProcedure

All Implemented Interfaces:

Comparable<org.apache.hadoop.hbase.procedure2.Procedure<MasterProcedureEnv>>, PeerProcedureInterface

Direct Known Subclasses:

AddPeerProcedure, DisablePeerProcedure, EnablePeerProcedure, RemovePeerProcedure, UpdatePeerConfigProcedure

@InterfaceAudience.Private
public abstract class ModifyPeerProcedure
extends AbstractPeerProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

The base class for all replication peer related procedure except sync replication state transition.

Nested Class Summary

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure.Flow

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

org.apache.hadoop.hbase.procedure2.Procedure.LockState

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

PeerProcedureInterface.PeerOperationType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SLEEP_INTERVAL_MS
protected static int	UPDATE_LAST_SEQ_ID_BATCH_SIZE

Fields inherited from class org.apache.hadoop.hbase.master.replication.AbstractPeerProcedure

latch, peerId

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

stateCount

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

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModifyPeerProcedure()
protected	ModifyPeerProcedure(String peerId)

Method Summary

Modifier and Type	Method and Description
protected void	enablePeer(MasterProcedureEnv env)
protected boolean	enablePeerBeforeFinish() The implementation class should override this method if the procedure may enter the serial related states.
protected org.apache.hadoop.hbase.procedure2.StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState	getInitialState()
protected org.apache.hadoop.hbase.replication.ReplicationPeerConfig	getNewPeerConfig()
protected org.apache.hadoop.hbase.replication.ReplicationPeerConfig	getOldPeerConfig()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState	getState(int stateId)
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState	nextStateAfterRefresh() Implementation class can override this method.
protected abstract void	postPeerModification(MasterProcedureEnv env) Called before we finish the procedure.
protected abstract void	prePeerModification(MasterProcedureEnv env) Called before we start the actual processing.
protected void	reopenRegions(MasterProcedureEnv env)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)
protected void	setLastPushedSequenceId(MasterProcedureEnv env, org.apache.hadoop.hbase.replication.ReplicationPeerConfig peerConfig)
protected void	setLastPushedSequenceIdForTable(MasterProcedureEnv env, org.apache.hadoop.hbase.TableName tableName, Map<String,Long> lastSeqIds)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)
protected void	updateLastPushedSequenceIdForSerialPeer(MasterProcedureEnv env)
protected abstract void	updatePeerStorage(MasterProcedureEnv env)

Methods inherited from class org.apache.hadoop.hbase.master.replication.AbstractPeerProcedure

acquireLock, deserializeStateData, getLatch, getPeerId, holdLock, releaseLock, serializeStateData, waitInitialized

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

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

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

addStackIndex, afterReplay, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, wasExecuted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.master.procedure.PeerProcedureInterface

getPeerOperationType

Field Detail

UPDATE_LAST_SEQ_ID_BATCH_SIZE

protected static final int UPDATE_LAST_SEQ_ID_BATCH_SIZE

See Also:

Constant Field Values

SLEEP_INTERVAL_MS

protected static final int SLEEP_INTERVAL_MS

See Also:

Constant Field Values

Constructor Detail

ModifyPeerProcedure

protected ModifyPeerProcedure()

ModifyPeerProcedure

protected ModifyPeerProcedure(String peerId)

Method Detail

prePeerModification

protected abstract void prePeerModification(MasterProcedureEnv env)
                                     throws IOException,
                                            org.apache.hadoop.hbase.replication.ReplicationException

Called before we start the actual processing. The implementation should call the pre CP hook, and also the pre-check for the peer modification.

If an IOException is thrown then we will give up and mark the procedure as failed directly. If all checks passes then the procedure can not be rolled back any more.

Throws:

IOException

org.apache.hadoop.hbase.replication.ReplicationException

updatePeerStorage

protected abstract void updatePeerStorage(MasterProcedureEnv env)
                                   throws org.apache.hadoop.hbase.replication.ReplicationException

Throws:

org.apache.hadoop.hbase.replication.ReplicationException

postPeerModification

protected abstract void postPeerModification(MasterProcedureEnv env)
                                      throws IOException,
                                             org.apache.hadoop.hbase.replication.ReplicationException

Called before we finish the procedure. The implementation can do some logging work, and also call the coprocessor hook if any.

Notice that, since we have already done the actual work, throwing IOException here will not fail this procedure, we will just ignore it and finish the procedure as suceeded. If ReplicationException is thrown we will retry since this usually means we fails to update the peer storage.

Throws:

IOException

org.apache.hadoop.hbase.replication.ReplicationException

nextStateAfterRefresh

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState nextStateAfterRefresh()

Implementation class can override this method. By default we will jump to POST_PEER_MODIFICATION and finish the procedure.

enablePeerBeforeFinish

protected boolean enablePeerBeforeFinish()

The implementation class should override this method if the procedure may enter the serial related states.

getOldPeerConfig

protected org.apache.hadoop.hbase.replication.ReplicationPeerConfig getOldPeerConfig()

getNewPeerConfig

protected org.apache.hadoop.hbase.replication.ReplicationPeerConfig getNewPeerConfig()

updateLastPushedSequenceIdForSerialPeer

protected void updateLastPushedSequenceIdForSerialPeer(MasterProcedureEnv env)
                                                throws IOException,
                                                       org.apache.hadoop.hbase.replication.ReplicationException

Throws:

IOException

org.apache.hadoop.hbase.replication.ReplicationException

reopenRegions

protected void reopenRegions(MasterProcedureEnv env)
                      throws IOException

Throws:

IOException

enablePeer

protected void enablePeer(MasterProcedureEnv env)
                   throws org.apache.hadoop.hbase.replication.ReplicationException

Throws:

org.apache.hadoop.hbase.replication.ReplicationException

setLastPushedSequenceId

protected final void setLastPushedSequenceId(MasterProcedureEnv env,
                                             org.apache.hadoop.hbase.replication.ReplicationPeerConfig peerConfig)
                                      throws IOException,
                                             org.apache.hadoop.hbase.replication.ReplicationException

Throws:

IOException

org.apache.hadoop.hbase.replication.ReplicationException

setLastPushedSequenceIdForTable

protected final void setLastPushedSequenceIdForTable(MasterProcedureEnv env,
                                                     org.apache.hadoop.hbase.TableName tableName,
                                                     Map<String,Long> lastSeqIds)
                                              throws IOException,
                                                     org.apache.hadoop.hbase.replication.ReplicationException

Throws:

IOException

org.apache.hadoop.hbase.replication.ReplicationException

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

Overrides:

setTimeoutFailure in class org.apache.hadoop.hbase.procedure2.Procedure<MasterProcedureEnv>

executeFromState

protected org.apache.hadoop.hbase.procedure2.StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                                                         org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)
                                                                                  throws org.apache.hadoop.hbase.procedure2.ProcedureSuspendedException

Specified by:

executeFromState in class org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

Throws:

org.apache.hadoop.hbase.procedure2.ProcedureSuspendedException

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)
                      throws IOException,
                             InterruptedException

Specified by:

rollbackState in class org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

Throws:

IOException

InterruptedException

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState getState(int stateId)

Specified by:

getState in class org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

getStateId

protected int getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState state)

Specified by:

getStateId in class org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

getInitialState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState getInitialState()

Specified by:

getInitialState in class org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>