org.apache.hadoop.hbase.master.replication

Class AddPeerProcedure

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

org.apache.hadoop.hbase.master.replication.AddPeerProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, PeerProcedureInterface

@InterfaceAudience.Private
public class AddPeerProcedure
extends ModifyPeerProcedure

The procedure for adding a new replication peer.

Nested Class Summary

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

StateMachineProcedure.Flow

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

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
private boolean	enabled
private static org.slf4j.Logger	LOG
private ReplicationPeerConfig	peerConfig

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

SLEEP_INTERVAL_MS, 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

Constructor and Description
AddPeerProcedure()
AddPeerProcedure(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)

Method Summary

Modifier and Type	Method and Description
protected void	deserializeStateData(ProcedureStateSerializer serializer) Called on store load to allow the user to decode the previously serialized state.
protected boolean	enablePeerBeforeFinish() The implementation class should override this method if the procedure may enter the serial related states.
protected ReplicationPeerConfig	getNewPeerConfig()
PeerProcedureInterface.PeerOperationType	getPeerOperationType()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState	nextStateAfterRefresh() Implementation class can override this method.
protected void	postPeerModification(MasterProcedureEnv env) Called before we finish the procedure.
protected void	prePeerModification(MasterProcedureEnv env) Called before we start the actual processing.
protected void	serializeStateData(ProcedureStateSerializer serializer) The user-level code of the procedure may have some state to persist (e.g.
protected void	updateLastPushedSequenceIdForSerialPeer(MasterProcedureEnv env)
protected void	updatePeerStorage(MasterProcedureEnv env)

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

enablePeer, executeFromState, getInitialState, getOldPeerConfig, getState, getStateId, reopenRegions, rollbackState, setLastPushedSequenceId, setLastPushedSequenceIdForTable, setTimeoutFailure

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

acquireLock, getLatch, getPeerId, holdLock, releaseLock, 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

Field Detail

LOG

private static final org.slf4j.Logger LOG

peerConfig

private ReplicationPeerConfig peerConfig

enabled

private boolean enabled

Constructor Detail

AddPeerProcedure

public AddPeerProcedure()

AddPeerProcedure

public AddPeerProcedure(String peerId,
                        ReplicationPeerConfig peerConfig,
                        boolean enabled)

Method Detail

getPeerOperationType

public PeerProcedureInterface.PeerOperationType getPeerOperationType()

nextStateAfterRefresh

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

Description copied from class: ModifyPeerProcedure

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

Overrides:

nextStateAfterRefresh in class ModifyPeerProcedure

updateLastPushedSequenceIdForSerialPeer

protected void updateLastPushedSequenceIdForSerialPeer(MasterProcedureEnv env)
                                                throws IOException,
                                                       ReplicationException

Overrides:

updateLastPushedSequenceIdForSerialPeer in class ModifyPeerProcedure

Throws:

IOException

ReplicationException

enablePeerBeforeFinish

protected boolean enablePeerBeforeFinish()

Description copied from class: ModifyPeerProcedure

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

Overrides:

enablePeerBeforeFinish in class ModifyPeerProcedure

getNewPeerConfig

protected ReplicationPeerConfig getNewPeerConfig()

Overrides:

getNewPeerConfig in class ModifyPeerProcedure

prePeerModification

protected void prePeerModification(MasterProcedureEnv env)
                            throws IOException,
                                   ReplicationException

Description copied from class: ModifyPeerProcedure

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.

Specified by:

prePeerModification in class ModifyPeerProcedure

Throws:

IOException

ReplicationException

updatePeerStorage

protected void updatePeerStorage(MasterProcedureEnv env)
                          throws ReplicationException

Specified by:

updatePeerStorage in class ModifyPeerProcedure

Throws:

ReplicationException

postPeerModification

protected void postPeerModification(MasterProcedureEnv env)
                             throws IOException,
                                    ReplicationException

Description copied from class: ModifyPeerProcedure

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.

Specified by:

postPeerModification in class ModifyPeerProcedure

Throws:

IOException

ReplicationException

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Overrides:

serializeStateData in class AbstractPeerProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             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 AbstractPeerProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.PeerModificationState>

Parameters:

serializer - contains the serialized state

Throws:

IOException