c

akka.persistence.typed.javadsl

ReplicatedEventSourcedBehavior

abstract class ReplicatedEventSourcedBehavior[Command, Event, State] extends EventSourcedBehavior[Command, Event, State]

Base class for replicated event sourced behaviors.

Source
ReplicatedEventSourcedBehavior.scala
Linear Supertypes
EventSourcedBehavior[Command, Event, State], DeferredBehavior[Command], Behavior[Command], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReplicatedEventSourcedBehavior
  2. EventSourcedBehavior
  3. DeferredBehavior
  4. Behavior
  5. AnyRef
  6. Any
Implicitly
  1. by BehaviorDecorators
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReplicatedEventSourcedBehavior(replicationContext: ReplicationContext)
  2. new ReplicatedEventSourcedBehavior(replicationContext: ReplicationContext, onPersistFailure: Optional[BackoffSupervisorStrategy])

Abstract Value Members

  1. 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
  2. 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
  3. 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 thenRun or recoveryCompleted blocks.

    Attributes
    protected
    Definition Classes
    EventSourcedBehavior

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toany2stringadd[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReplicatedEventSourcedBehavior[Command, Event, State], B)
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toArrowAssoc[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. def apply(context: TypedActorContext[Command]): Behavior[Command]

    INTERNAL API: DeferredBehavior init, not for user extension

    INTERNAL API: DeferredBehavior init, not for user extension

    Definition Classes
    ReplicatedEventSourcedBehaviorEventSourcedBehavior → DeferredBehavior
    Annotations
    @InternalApi()
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val behavior: Behavior[Command]
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toBehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. def ensuring(cond: (ReplicatedEventSourcedBehavior[Command, Event, State]) => Boolean, msg: => Any): ReplicatedEventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toEnsuring[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (ReplicatedEventSourcedBehavior[Command, Event, State]) => Boolean): ReplicatedEventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toEnsuring[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): ReplicatedEventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toEnsuring[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): ReplicatedEventSourcedBehavior[Command, Event, State]
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toEnsuring[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def eventAdapter(): EventAdapter[Event, _]

    Transform the event in another type before giving to the journal.

    Transform the event in another type before giving to the journal. Can be used to wrap events in types Journals understand but is of a different type than Event.

    Definition Classes
    EventSourcedBehavior
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toStringFormat[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getReplicationContext(): ReplicationContext
    Attributes
    protected
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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
  24. 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
  25. 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
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def newCommandHandlerBuilder(): CommandHandlerBuilder[Command, Event, State]

    returns

    A new, mutable, command handler builder

    Attributes
    protected
    Definition Classes
    EventSourcedBehavior
  28. final def newEventHandlerBuilder(): EventHandlerBuilder[State, Event]

    returns

    A new, mutable, event handler builder

    Attributes
    protected
    Definition Classes
    EventSourcedBehavior
  29. final def newSignalHandlerBuilder(): SignalHandlerBuilder[State]

    returns

    A new, mutable signal handler builder

    Attributes
    protected
    Definition Classes
    EventSourcedBehavior
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. val persistenceId: PersistenceId
    Definition Classes
    EventSourcedBehavior
  33. def recovery: Recovery

    Override to change the strategy for recovery of snapshots and events.

    Override to change the strategy for recovery of snapshots and events. By default, snapshots and events are recovered.

    Definition Classes
    EventSourcedBehavior
  34. 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
  35. 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 with shouldSnapshot. Such deletes are only triggered by snapshots matching the numberOfEvents in the RetentionCriteria.

    returns

    true if snapshot should be saved at the given state, event and sequenceNr when the event has been successfully persisted

    Definition Classes
    EventSourcedBehavior
  36. 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
  37. def snapshotAdapter(): SnapshotAdapter[State]

    Transform the state into another type before giving it to and from the journal.

    Transform the state into another type before giving it to and from the journal. Can be used to migrate from different state types e.g. when migration from PersistentFSM to Typed EventSourcedBehavior.

    Definition Classes
    EventSourcedBehavior
  38. 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
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def tagsFor(event: Event): Set[String]

    The tagger function should give event tags, which will be used in persistence query

    The tagger function should give event tags, which will be used in persistence query

    Definition Classes
    EventSourcedBehavior
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def transformMessages[Outer](matcher: PartialFunction[Outer, Command])(implicit arg0: ClassTag[Outer]): Behavior[Outer]

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: 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.

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: 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:

    val b: Behavior[Number] =
      Behaviors
        .receive[String] { (ctx, msg) =>
          println(msg)
          Behaviors.same
        }
        .transformMessages[Number] {
          case b: BigDecimal => s"BigDecimal($b)"
          case i: BigInt     => s"BigInteger($i)"
          // all other kinds of Number will be `unhandled`
        }

    The ClassTag for Outer ensures that only messages of this class or a subclass thereof will be intercepted. Other message types (e.g. a private protocol) will bypass the interceptor and be continue to the inner behavior untouched.

    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toBehaviorDecorators[Command] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. def withEventPublishing: Boolean

    Override and return false to disable events being published to the system event stream as akka.persistence.typed.PublishedEvent after they have been persisted.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. 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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.5) override recovery instead

  3. def [B](y: B): (ReplicatedEventSourcedBehavior[Command, Event, State], B)
    Implicit
    This member is added by an implicit conversion from ReplicatedEventSourcedBehavior[Command, Event, State] toArrowAssoc[ReplicatedEventSourcedBehavior[Command, Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from EventSourcedBehavior[Command, Event, State]

Inherited from DeferredBehavior[Command]

Inherited from Behavior[Command]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BehaviorDecorators fromReplicatedEventSourcedBehavior[Command, Event, State] to BehaviorDecorators[Command]

Inherited by implicit conversion any2stringadd fromReplicatedEventSourcedBehavior[Command, Event, State] to any2stringadd[ReplicatedEventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion StringFormat fromReplicatedEventSourcedBehavior[Command, Event, State] to StringFormat[ReplicatedEventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion Ensuring fromReplicatedEventSourcedBehavior[Command, Event, State] to Ensuring[ReplicatedEventSourcedBehavior[Command, Event, State]]

Inherited by implicit conversion ArrowAssoc fromReplicatedEventSourcedBehavior[Command, Event, State] to ArrowAssoc[ReplicatedEventSourcedBehavior[Command, Event, State]]

Ungrouped