Package org.apache.iotdb.confignode.procedure.impl.subscription

Class AbstractOperateSubscriptionProcedure

java.lang.Object

org.apache.iotdb.confignode.procedure.Procedure<Env>

org.apache.iotdb.confignode.procedure.impl.StateMachineProcedure<ConfigNodeProcedureEnv,TState>

org.apache.iotdb.confignode.procedure.impl.node.AbstractNodeProcedure<OperateSubscriptionState>

org.apache.iotdb.confignode.procedure.impl.subscription.AbstractOperateSubscriptionProcedure

All Implemented Interfaces:

Comparable<Procedure<ConfigNodeProcedureEnv>>

Direct Known Subclasses:

AbstractOperateSubscriptionAndPipeProcedure, AlterConsumerGroupProcedure, AlterTopicProcedure, ConsumerGroupMetaSyncProcedure, CreateTopicProcedure, DropTopicProcedure, TopicMetaSyncProcedure

public abstract class AbstractOperateSubscriptionProcedure
extends AbstractNodeProcedure<OperateSubscriptionState>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.iotdb.confignode.procedure.impl.StateMachineProcedure

StateMachineProcedure.Flow

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isRollbackFromOperateOnDataNodesSuccessful
protected boolean	isRollbackFromValidateSuccessful
protected AtomicReference<SubscriptionInfo>	subscriptionInfo

Fields inherited from class org.apache.iotdb.confignode.procedure.impl.StateMachineProcedure

isGeneratedByPipe

Fields inherited from class org.apache.iotdb.confignode.procedure.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractOperateSubscriptionProcedure()

Method Summary

Modifier and Type	Method	Description
protected ProcedureLockState	acquireLock(ConfigNodeProcedureEnv configNodeProcedureEnv)	Acquire a lock, user should override it if necessary.
protected AtomicReference<SubscriptionInfo>	acquireLockInternal(ConfigNodeProcedureEnv configNodeProcedureEnv)
protected abstract void	executeFromOperateOnConfigNodes(ConfigNodeProcedureEnv env)
protected abstract void	executeFromOperateOnDataNodes(ConfigNodeProcedureEnv env)
protected StateMachineProcedure.Flow	executeFromState(ConfigNodeProcedureEnv env, OperateSubscriptionState state)	Called to perform a single step of the specified 'state' of the procedure.
protected abstract boolean	executeFromValidate(ConfigNodeProcedureEnv env)
protected OperateSubscriptionState	getInitialState()	Return the initial state object that will be used for the first call to executeFromState().
protected abstract SubscriptionOperation	getOperation()
protected OperateSubscriptionState	getState(int stateId)	Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(OperateSubscriptionState state)	Convert the Enum (or more descriptive) state object to an ordinal (or state id).
static boolean	pushConsumerGroupMetaHasException(Map<Integer,TPushConsumerGroupMetaResp> respMap)
protected Map<Integer,TPushConsumerGroupMetaResp>	pushConsumerGroupMetaToDataNodes(ConfigNodeProcedureEnv env)	Pushing all the topicMeta's to all the dataNodes.
static boolean	pushTopicMetaHasException(Map<Integer,TPushTopicMetaResp> respMap)
protected Map<Integer,TPushTopicMetaResp>	pushTopicMetaToDataNodes(ConfigNodeProcedureEnv env)	Pushing all the topicMeta's to all the dataNodes.
protected void	releaseLock(ConfigNodeProcedureEnv configNodeProcedureEnv)	Release a lock, user should override it if necessary.
protected abstract void	rollbackFromOperateOnConfigNodes(ConfigNodeProcedureEnv env)
protected abstract void	rollbackFromOperateOnDataNodes(ConfigNodeProcedureEnv env)
protected abstract void	rollbackFromValidate(ConfigNodeProcedureEnv env)
protected void	rollbackState(ConfigNodeProcedureEnv env, OperateSubscriptionState state)	Called to perform the rollback of the specified state.

Methods inherited from class org.apache.iotdb.confignode.procedure.impl.StateMachineProcedure

addChildProcedure, deserialize, execute, getCurrentState, getCycles, isEofState, isRollbackSupported, isStateDeserialized, rollback, serialize, setNextState, toStringState

Methods inherited from class org.apache.iotdb.confignode.procedure.Procedure

addStackIndex, compareTo, deserializeTypeInfoForCompatibility, doAcquireLock, doExecute, doReleaseLock, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getParentProcId, getProcId, getProcType, getResult, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, isYieldAfterExecution, removeStackIndex, restoreLock, setChildrenLatch, setFailure, setFailure, setLastUpdate, setParentProcId, setProcId, setProcRunnable, setResult, setRootProcedureId, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, toString, 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 Details

isRollbackFromOperateOnDataNodesSuccessful

protected boolean isRollbackFromOperateOnDataNodesSuccessful

isRollbackFromValidateSuccessful

protected boolean isRollbackFromValidateSuccessful

subscriptionInfo

protected AtomicReference<SubscriptionInfo> subscriptionInfo

Constructor Details

AbstractOperateSubscriptionProcedure

public AbstractOperateSubscriptionProcedure()

Method Details

acquireLockInternal

protected AtomicReference<SubscriptionInfo> acquireLockInternal(ConfigNodeProcedureEnv configNodeProcedureEnv)

acquireLock

protected ProcedureLockState acquireLock(ConfigNodeProcedureEnv configNodeProcedureEnv)

Description copied from class: Procedure

Acquire a lock, user should override it if necessary.

Overrides:

acquireLock in class AbstractNodeProcedure<OperateSubscriptionState>

Parameters:

configNodeProcedureEnv - environment

Returns:

state of lock

releaseLock

protected void releaseLock(ConfigNodeProcedureEnv configNodeProcedureEnv)

Description copied from class: Procedure

Release a lock, user should override it if necessary.

Overrides:

releaseLock in class AbstractNodeProcedure<OperateSubscriptionState>

Parameters:

configNodeProcedureEnv - env

getOperation

protected abstract SubscriptionOperation getOperation()

executeFromValidate

protected abstract boolean executeFromValidate(ConfigNodeProcedureEnv env)
                                        throws SubscriptionException

Throws:

SubscriptionException

executeFromOperateOnConfigNodes

protected abstract void executeFromOperateOnConfigNodes(ConfigNodeProcedureEnv env)
                                                 throws SubscriptionException

Throws:

SubscriptionException

executeFromOperateOnDataNodes

protected abstract void executeFromOperateOnDataNodes(ConfigNodeProcedureEnv env)
                                               throws SubscriptionException,
IOException

Throws:

SubscriptionException

IOException

executeFromState

protected StateMachineProcedure.Flow executeFromState(ConfigNodeProcedureEnv env,
 OperateSubscriptionState state)
                                               throws InterruptedException

Description copied from class: StateMachineProcedure

Called to perform a single step of the specified 'state' of the procedure.

Specified by:

executeFromState in class StateMachineProcedure<ConfigNodeProcedureEnv,OperateSubscriptionState>

state - state to execute

Returns:

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

Throws:

InterruptedException

rollbackState

protected void rollbackState(ConfigNodeProcedureEnv env,
 OperateSubscriptionState state)
                      throws IOException,
InterruptedException,
ProcedureException

Description copied from class: StateMachineProcedure

Called to perform the rollback of the specified state.

Specified by:

rollbackState in class StateMachineProcedure<ConfigNodeProcedureEnv,OperateSubscriptionState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

ProcedureException

rollbackFromValidate

protected abstract void rollbackFromValidate(ConfigNodeProcedureEnv env)

rollbackFromOperateOnConfigNodes

protected abstract void rollbackFromOperateOnConfigNodes(ConfigNodeProcedureEnv env)
                                                  throws SubscriptionException

Throws:

SubscriptionException

rollbackFromOperateOnDataNodes

protected abstract void rollbackFromOperateOnDataNodes(ConfigNodeProcedureEnv env)
                                                throws SubscriptionException,
IOException

Throws:

SubscriptionException

IOException

pushTopicMetaToDataNodes

protected Map<Integer,TPushTopicMetaResp> pushTopicMetaToDataNodes(ConfigNodeProcedureEnv env)
                                                            throws IOException

Pushing all the topicMeta's to all the dataNodes.

Parameters:

env - ConfigNodeProcedureEnv

Returns:

The responseMap after pushing topic meta

Throws:

IOException - Exception when Serializing to byte buffer

pushTopicMetaHasException

public static boolean pushTopicMetaHasException(Map<Integer,TPushTopicMetaResp> respMap)

pushConsumerGroupMetaToDataNodes

protected Map<Integer,TPushConsumerGroupMetaResp> pushConsumerGroupMetaToDataNodes(ConfigNodeProcedureEnv env)
                                                                            throws IOException

Pushing all the topicMeta's to all the dataNodes.

Parameters:

env - ConfigNodeProcedureEnv

Returns:

The responseMap after pushing topic meta

Throws:

IOException - Exception when Serializing to byte buffer

pushConsumerGroupMetaHasException

public static boolean pushConsumerGroupMetaHasException(Map<Integer,TPushConsumerGroupMetaResp> respMap)

getState

protected OperateSubscriptionState 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<ConfigNodeProcedureEnv,OperateSubscriptionState>

Parameters:

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

Returns:

the state enum object

getStateId

protected int getStateId(OperateSubscriptionState 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<ConfigNodeProcedureEnv,OperateSubscriptionState>

Parameters:

state - the state enum object

Returns:

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

getInitialState

protected OperateSubscriptionState 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<ConfigNodeProcedureEnv,OperateSubscriptionState>

Returns:

the initial state enum object