abstract class EventSourcedEntity[Command, Event, State] extends EventSourcedBehavior[Command, Event, State]
Any akka.actor.typed.Behavior can be used as a sharded entity actor, but the combination of sharding and persistent
actors is very common and therefore this PersistentEntity
class is provided as convenience.
It is a EventSourcedBehavior and is implemented in the same way. It selects the persistenceId
automatically from the EntityTypeKey and entityId
constructor parameters by using
EntityTypeKey.persistenceIdFrom.
- Source
- EventSourcedEntity.scala
- Alphabetic
- By Inheritance
- EventSourcedEntity
- EventSourcedBehavior
- DeferredBehavior
- Behavior
- AnyRef
- Any
- by BehaviorDecorators
- by BehaviorDecorators
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new EventSourcedEntity(entityTypeKey: EntityTypeKey[Command], entityId: String, onPersistFailure: BackoffSupervisorStrategy)
- new EventSourcedEntity(entityTypeKey: EntityTypeKey[Command], entityId: String)
Abstract Value Members
-
abstract
def
commandHandler(): CommandHandler[Command, Event, State]
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.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 EventSourcedBehavior#newCommandHandlerBuilder to define the command handlers.
The command handlers are only invoked when the actor is running (i.e. not replaying). While the actor is persisting events, the incoming messages are stashed and only delivered to the handler once persisting them has completed.
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
abstract
def
emptyState: State
Implement by returning the initial empty state object.
Implement by returning the initial empty state object. This object will be passed into this behaviors handlers, until a new state replaces it.
Also known as "zero state" or "neutral state".
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
abstract
def
eventHandler(): EventHandler[State, Event]
Implement by applying the event to the current state in order to return a new state.
Implement by applying the event to the current state in order to return a new state.
Use EventSourcedBehavior#newEventHandlerBuilder to define the event handlers.
The event handlers are invoked during recovery as well as running operation of this behavior, in order to keep updating the state state.
For that reason it is strongly discouraged to perform side-effects in this handler; Side effects should be executed in
andThen
orrecoveryCompleted
blocks.- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to any2stringadd[EventSourcedEntity[Command, Event, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (EventSourcedEntity[Command, Event, State], B)
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to ArrowAssoc[EventSourcedEntity[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
Effect: EffectFactories[Event, State]
Factory of effects.
Factory of effects.
Return effects from your handlers in order to instruct persistence on how to act on the incoming message (i.e. persist events).
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
def
apply(context: TypedActorContext[Command]): Behavior[Command]
INTERNAL API: DeferredBehavior init
INTERNAL API: DeferredBehavior init
- Definition Classes
- EventSourcedBehavior → DeferredBehavior
- Annotations
- @InternalApi()
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (EventSourcedEntity[Command, Event, State]) ⇒ Boolean, msg: ⇒ Any): EventSourcedEntity[Command, Event, State]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to Ensuring[EventSourcedEntity[Command, Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (EventSourcedEntity[Command, Event, State]) ⇒ Boolean): EventSourcedEntity[Command, Event, State]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to Ensuring[EventSourcedEntity[Command, Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): EventSourcedEntity[Command, Event, State]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to Ensuring[EventSourcedEntity[Command, Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): EventSourcedEntity[Command, Event, State]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to Ensuring[EventSourcedEntity[Command, Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- val entityId: String
- val entityTypeKey: EntityTypeKey[Command]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
eventAdapter(): EventAdapter[Event, _]
- Definition Classes
- EventSourcedBehavior
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to StringFormat[EventSourcedEntity[Command, Event, State]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
journalPluginId: String
Override and define the journal plugin id that this actor should use instead of the default.
Override and define the journal plugin id that this actor should use instead of the default.
- Definition Classes
- EventSourcedBehavior
-
final
def
lastSequenceNumber(ctx: ActorContext[_]): Long
The last sequence number that was persisted, can only be called from inside the handlers of an
EventSourcedBehavior
The last sequence number that was persisted, can only be called from inside the handlers of an
EventSourcedBehavior
- Definition Classes
- EventSourcedBehavior
-
final
def
narrow[U <: Command]: Behavior[U]
Narrow the type of this Behavior, which is always a safe operation.
Narrow the type of this Behavior, which is always a safe operation. This method is necessary to implement the contravariant nature of Behavior (which cannot be expressed directly due to type inference problems).
- Definition Classes
- Behavior
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newCommandHandlerBuilder(): CommandHandlerBuilder[Command, Event, State]
- returns
A new, mutable, command handler builder
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
final
def
newEventHandlerBuilder(): EventHandlerBuilder[State, Event]
- returns
A new, mutable, event handler builder
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
final
def
newSignalHandlerBuilder(): SignalHandlerBuilder[State]
- returns
A new, mutable signal handler builder
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
orElse(that: Behavior[Command]): Behavior[Command]
Composes this
Behavior
with a fallbackBehavior
which is used when thisBehavior
doesn't handle the message or signal, i.e.Composes this
Behavior
with a fallbackBehavior
which is used when thisBehavior
doesn't handle the message or signal, i.e. whenunhandled
is returned.- that
the fallback
Behavior
- Definition Classes
- Behavior
-
val
persistenceId: PersistenceId
- Definition Classes
- EventSourcedBehavior
-
def
retentionCriteria: RetentionCriteria
Criteria for retention/deletion of snapshots and events.
Criteria for retention/deletion of snapshots and events. By default, retention is disabled and snapshots are not saved and deleted automatically.
- Definition Classes
- EventSourcedBehavior
-
def
shouldSnapshot(state: State, event: Event, sequenceNr: Long): Boolean
Initiates a snapshot if the given predicate evaluates to true.
Initiates a snapshot if the given predicate evaluates to true.
Decide to store a snapshot based on the State, Event and sequenceNr when the event has been successfully persisted.
When persisting multiple events at once the snapshot is triggered after all the events have been persisted.
Snapshots triggered by
snapshotWhen
will not trigger deletes of old snapshots and events if EventSourcedBehavior.retentionCriteria with RetentionCriteria.snapshotEvery is used together withshouldSnapshot
. Such deletes are only triggered by snapshots matching thenumberOfEvents
in the RetentionCriteria.- returns
true
if snapshot should be saved at the givenstate
,event
andsequenceNr
when the event has been successfully persisted
- Definition Classes
- EventSourcedBehavior
-
def
signalHandler(): SignalHandler[State]
Override to react on general lifecycle signals and persistence specific signals (subtypes of akka.persistence.typed.EventSourcedSignal).
Override to react on general lifecycle signals and persistence specific signals (subtypes of akka.persistence.typed.EventSourcedSignal).
Use EventSourcedBehavior#newSignalHandlerBuilder to define the signal handler.
- Attributes
- protected
- Definition Classes
- EventSourcedBehavior
-
def
snapshotPluginId: String
Override and define the snapshot store plugin id that this actor should use instead of the default.
Override and define the snapshot store plugin id that this actor should use instead of the default.
- Definition Classes
- EventSourcedBehavior
-
def
snapshotSelectionCriteria: SnapshotSelectionCriteria
Override and define the snapshot selection criteria used by this actor instead of the default.
Override and define the snapshot selection criteria used by this actor instead of the default. By default the most recent snapshot is used, and the remaining state updates are recovered by replaying events from the sequence number up until which the snapshot reached.
You may configure the behavior to skip replaying snapshots completely, in which case the recovery will be performed by replaying all events -- which may take a long time.
- Definition Classes
- EventSourcedBehavior
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tagsFor(event: Event): Set[String]
The
tagger
function should give event tags, which will be used in persistence queryThe
tagger
function should give event tags, which will be used in persistence query- Definition Classes
- EventSourcedBehavior
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (EventSourcedEntity[Command, Event, State], B)
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to ArrowAssoc[EventSourcedEntity[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
val
behavior: Behavior[Command]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to BehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(eventSourcedEntity: BehaviorDecorators[Command]).behavior
- Definition Classes
- BehaviorDecorators
-
val
behavior: Behavior[Command]
- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to BehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(eventSourcedEntity: BehaviorDecorators[Command]).behavior
- Definition Classes
- BehaviorDecorators
-
def
widen[U](matcher: PartialFunction[U, Command]): Behavior[U]
Widen the wrapped Behavior by placing a funnel in front of it: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy.
Widen the wrapped Behavior by placing a funnel in front of it: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy. Signals are not transformed.
Example:
receive[String] { (ctx, msg) => println(msg); same }.widen[Number] { case b: BigDecimal => s"BigDecimal($b)" case i: BigInteger => s"BigInteger($i)" // all other kinds of Number will be `unhandled` }
Scheduled messages via akka.actor.typed.scaladsl.TimerScheduler can currently not be used together with
widen
, see issue #25318.- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to BehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(eventSourcedEntity: BehaviorDecorators[Command]).widen(matcher)
- Definition Classes
- BehaviorDecorators
-
def
widen[U](matcher: PartialFunction[U, Command]): Behavior[U]
Widen the wrapped Behavior by placing a funnel in front of it: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy.
Widen the wrapped Behavior by placing a funnel in front of it: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy. Signals are not transformed.
Example:
receive[String] { (ctx, msg) => println(msg); same }.widen[Number] { case b: BigDecimal => s"BigDecimal($b)" case i: BigInteger => s"BigInteger($i)" // all other kinds of Number will be `unhandled` }
Scheduled messages via akka.actor.typed.scaladsl.TimerScheduler can currently not be used together with
widen
, see issue #25318.- Implicit
- This member is added by an implicit conversion from EventSourcedEntity[Command, Event, State] to BehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
- Shadowing
- This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:(eventSourcedEntity: BehaviorDecorators[Command]).widen(matcher)
- Definition Classes
- BehaviorDecorators