Package org.springframework.statemachine.zookeeper

Class ZookeeperStateMachineEnsemble<S,E>

java.lang.Object

org.springframework.statemachine.support.LifecycleObjectSupport

org.springframework.statemachine.ensemble.StateMachineEnsembleObjectSupport<S,E>

org.springframework.statemachine.zookeeper.ZookeeperStateMachineEnsemble<S,E>

Type Parameters:

S - the type of state

E - the type of event

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, StateMachineEnsemble<S,E>, StateMachineReactiveLifecycle

Direct Known Subclasses:

LeaderZookeeperStateMachineEnsemble

public class ZookeeperStateMachineEnsemble<S,E>
extends StateMachineEnsembleObjectSupport<S,E>

StateMachineEnsemble backed by a zookeeper.

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient, String basePath)	Instantiates a new zookeeper state machine ensemble.
ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient, String basePath, boolean cleanState, int logSize)	Instantiates a new zookeeper state machine ensemble.
ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient, String basePath, boolean cleanState, int logSize, Consumer<com.esotericsoftware.kryo.Kryo> kryoCustomizer)	Instantiates a new zookeeper state machine ensemble with a custom Kryo configurer for application-specific allowlist registrations.

Method Summary

Modifier and Type	Method	Description
protected reactor.core.publisher.Mono<Void>	doPreStartReactively()	Subclasses may implement this for pre start logic.
protected reactor.core.publisher.Mono<Void>	doPreStopReactively()	Subclasses may implement this for pre stop logic.
protected void	doStart()
protected void	doStop()
StateMachine<S,E>	getLeader()	Gets the ensemble leader.
StateMachineContext<S,E>	getState()	Gets the state as a StateMachineContext.
void	join(StateMachine<S,E> stateMachine)	Request a join to a state machine ensemble.
void	leave(StateMachine<S,E> stateMachine)	Request a leave from an ensemble.
protected void	onInit()	Subclasses may implement this for initialization logic.
protected void	registerWatcherForStatePath()	Register existing CuratorWatcher for a state path.
void	setState(StateMachineContext<S,E> context)	Sets the state as a StateMachineContext.
String	toString()

Methods inherited from class org.springframework.statemachine.ensemble.StateMachineEnsembleObjectSupport

addEnsembleListener, notifyError, notifyGranted, notifyJoined, notifyLeft, notifyRevoked, notifyStateChanged, removeEnsembleListener

Methods inherited from class org.springframework.statemachine.support.LifecycleObjectSupport

afterPropertiesSet, destroy, doDestroy, doPostStartReactively, doPostStopReactively, getBeanFactory, getPhase, isAutoStartup, isRunning, setAutoStartup, setBeanFactory, setPhase, start, startReactively, stop, stopReactively

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

ZookeeperStateMachineEnsemble

public ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient,
 String basePath)

Instantiates a new zookeeper state machine ensemble.

Parameters:

curatorClient - the curator client

basePath - the base zookeeper path

ZookeeperStateMachineEnsemble

public ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient,
 String basePath,
 boolean cleanState,
 int logSize)

Instantiates a new zookeeper state machine ensemble.

Parameters:

curatorClient - the curator client

basePath - the base zookeeper path

cleanState - if true clean existing state

logSize - the log size

ZookeeperStateMachineEnsemble

public ZookeeperStateMachineEnsemble(org.apache.curator.framework.CuratorFramework curatorClient,
 String basePath,
 boolean cleanState,
 int logSize,
 Consumer<com.esotericsoftware.kryo.Kryo> kryoCustomizer)

Instantiates a new zookeeper state machine ensemble with a custom Kryo configurer for application-specific allowlist registrations.

Parameters:

curatorClient - the curator client

basePath - the base zookeeper path

cleanState - if true clean existing state

logSize - the log size

kryoCustomizer - optional callback invoked once per Kryo instance after the framework's default registrations are applied. Use this to register application-specific state and event types (typically enums) so that they are accepted by the allowlist. May be null.

Since:

4.0.2

Method Details

onInit

protected void onInit()
               throws Exception

Description copied from class: LifecycleObjectSupport

Subclasses may implement this for initialization logic. Called during the InitializingBean phase.

Overrides:

onInit in class LifecycleObjectSupport

Throws:

Exception - exception

doPreStartReactively

protected reactor.core.publisher.Mono<Void> doPreStartReactively()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this for pre start logic.

Overrides:

doPreStartReactively in class LifecycleObjectSupport

Returns:

the mono for completion

doStart

protected void doStart()

doPreStopReactively

protected reactor.core.publisher.Mono<Void> doPreStopReactively()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this for pre stop logic.

Overrides:

doPreStopReactively in class LifecycleObjectSupport

Returns:

the mono for completion

doStop

protected void doStop()

join

public void join(StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineEnsemble

Request a join to a state machine ensemble. This method is a request to join an ensemble and doesn't guarantee a requester will eventually successfully join. Join operation needs to be used together with EnsembleListener and EnsembleListener.stateMachineJoined(StateMachine, StateMachineContext) is called with a StateMachine instance for successful join.

Specified by:

join in interface StateMachineEnsemble<S,E>

Specified by:

join in class StateMachineEnsembleObjectSupport<S,E>

Parameters:

stateMachine - the state machine

getLeader

public StateMachine<S,E> getLeader()

Description copied from interface: StateMachineEnsemble

Gets the ensemble leader. If returned machine is NULL it indicates that this ensemble doesn't know any leader.

Returns:

the ensemble leader

leave

public void leave(StateMachine<S,E> stateMachine)

Description copied from interface: StateMachineEnsemble

Request a leave from an ensemble. This method is a request to leave an ensemble. After this method is called no further processing is done for a instance of StateMachine. Additionally EnsembleListener.stateMachineLeft(StateMachine, StateMachineContext) is called when leave request is fully processed.

Specified by:

leave in interface StateMachineEnsemble<S,E>

Specified by:

leave in class StateMachineEnsembleObjectSupport<S,E>

Parameters:

stateMachine - the state machine

setState

public void setState(StateMachineContext<S,E> context)

Description copied from interface: StateMachineEnsemble

Sets the state as a StateMachineContext.

Parameters:

context - the state machine context

getState

public StateMachineContext<S,E> getState()

Description copied from interface: StateMachineEnsemble

Gets the state as a StateMachineContext.

Returns:

the state machine context

registerWatcherForStatePath

protected void registerWatcherForStatePath()

Register existing CuratorWatcher for a state path.

toString

public String toString()

Overrides:

toString in class Object