Package org.springframework.statemachine.data

Class RepositoryStateMachinePersist<M extends RepositoryStateMachine,S,E>

java.lang.Object

org.springframework.statemachine.data.RepositoryStateMachinePersist<M,S,E>

Type Parameters:

S - the type of state

E - the type of event

M - the type of entity

All Implemented Interfaces:

StateMachinePersist<S,E,Object>

Direct Known Subclasses:

JpaRepositoryStateMachinePersist, MongoDbRepositoryStateMachinePersist, RedisRepositoryStateMachinePersist

public abstract class RepositoryStateMachinePersist<M extends RepositoryStateMachine,S,E>
extends Object
implements StateMachinePersist<S,E,Object>

Base implementation of a StateMachinePersist using Spring Data Repositories.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RepositoryStateMachinePersist()	Instantiates a new repository state machine persist using the default KryoStateMachineSerialisationService with no extra registrations.
protected	RepositoryStateMachinePersist(Consumer<com.esotericsoftware.kryo.Kryo> kryoCustomizer)	Instantiates a new repository state machine persist using a KryoStateMachineSerialisationService pre-configured with the supplied kryoCustomizer.
protected	RepositoryStateMachinePersist(StateMachineSerialisationService<S,E> serialisationService)	Instantiates a new repository state machine persist.

Method Summary

Modifier and Type	Method	Description
protected abstract M	build(StateMachineContext<S,E> context, Object contextObj, byte[] serialisedContext)	Builds the generic RepositoryStateMachine entity.
protected abstract StateMachineRepository<M>	getRepository()	Gets the repository.
StateMachineContext<S,E>	read(Object contextObj)	Read a StateMachineContext from a persistent store with a context object T.
void	write(StateMachineContext<S,E> context, Object contextObj)	Write a StateMachineContext into a persistent store with a context object T.

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryStateMachinePersist

protected RepositoryStateMachinePersist()

Instantiates a new repository state machine persist using the default KryoStateMachineSerialisationService with no extra registrations.

RepositoryStateMachinePersist

protected RepositoryStateMachinePersist(Consumer<com.esotericsoftware.kryo.Kryo> kryoCustomizer)

Instantiates a new repository state machine persist using a KryoStateMachineSerialisationService pre-configured with the supplied kryoCustomizer.

Use this constructor to register application-specific state and event types (typically enums) with Kryo's registration-required allowlist:

 new JpaRepositoryStateMachinePersist<>(repo, kryo -> {
     kryo.register(MyStates.class);
     kryo.register(MyEvents.class);
 })
 

Parameters:

kryoCustomizer - callback applied to each new Kryo instance; may be null

Since:

4.0.2

RepositoryStateMachinePersist

protected RepositoryStateMachinePersist(StateMachineSerialisationService<S,E> serialisationService)

Instantiates a new repository state machine persist.

Parameters:

serialisationService - the serialisation service

Method Details

write

public void write(StateMachineContext<S,E> context,
 Object contextObj)
           throws Exception

Description copied from interface: StateMachinePersist

Write a StateMachineContext into a persistent store with a context object T.

Specified by:

write in interface StateMachinePersist<M extends RepositoryStateMachine,S,E>

Parameters:

context - the context

contextObj - the context ojb

Throws:

Exception - the exception

read

public StateMachineContext<S,E> read(Object contextObj)
                              throws Exception

Description copied from interface: StateMachinePersist

Read a StateMachineContext from a persistent store with a context object T.

Specified by:

read in interface StateMachinePersist<M extends RepositoryStateMachine,S,E>

Parameters:

contextObj - the context ojb

Returns:

the state machine context

Throws:

Exception - the exception

getRepository

protected abstract StateMachineRepository<M> getRepository()

Gets the repository.

Returns:

the repository

build

protected abstract M build(StateMachineContext<S,E> context,
 Object contextObj,
 byte[] serialisedContext)

Builds the generic RepositoryStateMachine entity.

Parameters:

context - the context

contextObj - the context obj

serialisedContext - the serialised context

Returns:

the repository state machine entity