Package org.apache.pekko.persistence.typed.state.javadsl

Class DurableStateBehaviorWithEnforcedReplies<Command,State>

java.lang.Object

org.apache.pekko.actor.typed.Behavior<T>

org.apache.pekko.actor.typed.internal.BehaviorImpl.DeferredBehavior<Command>

org.apache.pekko.persistence.typed.state.javadsl.DurableStateBehavior<Command,State>

org.apache.pekko.persistence.typed.state.javadsl.DurableStateBehaviorWithEnforcedReplies<Command,State>

public abstract class DurableStateBehaviorWithEnforcedReplies<Command,State>
extends DurableStateBehavior<Command,State>

A DurableStateBehavior that is enforcing that replies to commands are not forgotten. There will be compilation errors if the returned effect isn't a ReplyEffect, which can be created with Effects().reply, Effects().noReply, EffectBuilder.thenReply, or EffectBuilder.thenNoReply.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.actor.typed.Behavior

Behavior.BehaviorDecorators<Inner>, Behavior.BehaviorDecorators$

Constructor Summary

Constructors

Constructor	Description
DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId)
DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId, Optional<BackoffSupervisorStrategy> backoffSupervisorStrategy)
DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId, BackoffSupervisorStrategy backoffSupervisorStrategy)

Method Summary

Modifier and Type	Method	Description
protected abstract CommandHandlerWithReply<Command,State>	commandHandler()	Implement by handling incoming commands and return an Effect() to persist or signal other effects of the command handling such as stopping the behavior or others.
protected CommandHandlerBuilder<Command,State>	newCommandHandlerBuilder()	Use newCommandHandlerWithReplyBuilder() instead, or extend DurableStateBehavior instead of DurableStateBehaviorWithEnforcedReplies.
protected CommandHandlerWithReplyBuilder<Command,State>	newCommandHandlerWithReplyBuilder()

Methods inherited from class org.apache.pekko.persistence.typed.state.javadsl.DurableStateBehavior

apply, durableStateStorePluginConfig, durableStateStorePluginId, Effect, emptyState, lastSequenceNumber, newSignalHandlerBuilder, persistenceId, signalHandler, snapshotAdapter, tag

Methods inherited from class org.apache.pekko.actor.typed.Behavior

BehaviorDecorators, canonicalize, existsInStack, interpretMessage, interpretSignal, isAlive, isDeferred, isUnhandled, narrow, start, validateAsInitial

Methods inherited from class java.lang.Object

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

Constructor Details

DurableStateBehaviorWithEnforcedReplies

public DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId,
 Optional<BackoffSupervisorStrategy> backoffSupervisorStrategy)

DurableStateBehaviorWithEnforcedReplies

public DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId)

DurableStateBehaviorWithEnforcedReplies

public DurableStateBehaviorWithEnforcedReplies(PersistenceId persistenceId,
 BackoffSupervisorStrategy backoffSupervisorStrategy)

Method Details

commandHandler

protected abstract CommandHandlerWithReply<Command,State> commandHandler()

Implement by handling incoming commands and return an Effect() to persist or signal other effects of the command handling such as stopping the behavior or others.

Use newCommandHandlerWithReplyBuilder() to define the command handlers.

The command handlers are only invoked when the actor is running (i.e. not recovering). While the actor is persisting state, the incoming messages are stashed and only delivered to the handler once persisting them has completed.

Specified by:

commandHandler in class DurableStateBehavior<Command,State>

newCommandHandlerBuilder

protected CommandHandlerBuilder<Command,State> newCommandHandlerBuilder()

Use newCommandHandlerWithReplyBuilder() instead, or extend DurableStateBehavior instead of DurableStateBehaviorWithEnforcedReplies.

Overrides:

newCommandHandlerBuilder in class DurableStateBehavior<Command,State>

Returns:

A new, mutable, command handler builder

Throws:

UnsupportedOperationException - use newCommandHandlerWithReplyBuilder instead

newCommandHandlerWithReplyBuilder

protected CommandHandlerWithReplyBuilder<Command,State> newCommandHandlerWithReplyBuilder()

Returns:

A new, mutable, command handler builder