Package org.apache.pekko.persistence.testkit.javadsl

Class DurableStateBehaviorTestKit<Command,State>

java.lang.Object

org.apache.pekko.persistence.testkit.javadsl.DurableStateBehaviorTestKit<Command,State>

public final class DurableStateBehaviorTestKit<Command,State>
extends Object

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DurableStateBehaviorTestKit.CommandResult<Command,State>	The result of running a command.
static final class	DurableStateBehaviorTestKit.CommandResultWithReply<Command,State,Reply>	The result of running a command with an ActorRef replyTo, i.e.
static final class	DurableStateBehaviorTestKit.RestartResult<State>	The result of restarting the behavior.
static final class	DurableStateBehaviorTestKit.SerializationSettings	Customization of which serialization checks that are performed.

Constructor Summary

Constructors

Constructor	Description
DurableStateBehaviorTestKit(DurableStateBehaviorTestKit<Command,State> delegate)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the state for this behavior from the in-memory durable state store and restart the behavior.
static com.typesafe.config.Config	config()	The configuration to be included in the configuration of the ActorSystem.
static <Command, State> DurableStateBehaviorTestKit<Command,State>	create(ActorSystem<?> system, Behavior<Command> behavior)	Factory method to create a new DurableStateBehaviorTestKit.
static <Command, State> DurableStateBehaviorTestKit<Command,State>	create(ActorSystem<?> system, Behavior<Command> behavior, DurableStateBehaviorTestKit.SerializationSettings serializationSettings)	Factory method to create a new DurableStateBehaviorTestKit with custom DurableStateBehaviorTestKit.SerializationSettings.
static DurableStateBehaviorTestKit.SerializationSettings	disabledSerializationSettings()
static DurableStateBehaviorTestKit.SerializationSettings	enabledSerializationSettings()
State	getState()	Retrieve the current state of the behavior.
DurableStateBehaviorTestKit.RestartResult<State>	restart()	Restart the behavior, which will then recover from the durable state store.
DurableStateBehaviorTestKit.CommandResult<Command,State>	runCommand(Command command)	Run one command through the behavior.
<R> DurableStateBehaviorTestKit.CommandResultWithReply<Command,State,R>	runCommand(Function<ActorRef<R>,Command> creator)	Run one command with a replyTo: ActorRef through the behavior.

Methods inherited from class java.lang.Object

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

Constructor Details

DurableStateBehaviorTestKit

public DurableStateBehaviorTestKit(DurableStateBehaviorTestKit<Command,State> delegate)

Method Details

config

public static com.typesafe.config.Config config()

The configuration to be included in the configuration of the ActorSystem. Typically used as constructor parameter to TestKitJunitResource. The configuration enables the in-memory durable state store.

enabledSerializationSettings

public static DurableStateBehaviorTestKit.SerializationSettings enabledSerializationSettings()

disabledSerializationSettings

public static DurableStateBehaviorTestKit.SerializationSettings disabledSerializationSettings()

create

public static <Command,
State>
DurableStateBehaviorTestKit<Command,State> create(ActorSystem<?> system,
 Behavior<Command> behavior)

Factory method to create a new DurableStateBehaviorTestKit.

create

public static <Command,
State>
DurableStateBehaviorTestKit<Command,State> create(ActorSystem<?> system,
 Behavior<Command> behavior,
 DurableStateBehaviorTestKit.SerializationSettings serializationSettings)

Factory method to create a new DurableStateBehaviorTestKit with custom DurableStateBehaviorTestKit.SerializationSettings.

Note that equals must be implemented in the commands and state if verifyEquality is enabled.

runCommand

public DurableStateBehaviorTestKit.CommandResult<Command,State> runCommand(Command command)

Run one command through the behavior. The returned result contains the state after the command has been processed.

runCommand

public <R>
DurableStateBehaviorTestKit.CommandResultWithReply<Command,State,R> runCommand(Function<ActorRef<R>,Command> creator)

Run one command with a replyTo: ActorRef through the behavior. The returned result contains the state after the command has been processed, and the reply.

getState

public State getState()

Retrieve the current state of the behavior.

restart

public DurableStateBehaviorTestKit.RestartResult<State> restart()

Restart the behavior, which will then recover from the durable state store. Can be used for testing that the recovery is correct.

clear

public void clear()

Clear the state for this behavior from the in-memory durable state store and restart the behavior.