Class

com.rbmhtechnology.eventuate

AbstractEventsourcedActor

Related Doc: package eventuate

Permalink

abstract class AbstractEventsourcedActor extends AbstractEventsourcedView with EventsourcedActor with ConfirmedDelivery with PersistOnEvent

Java API for actors that implement EventsourcedActor.

See also

EventsourcedActor

AbstractEventsourcedView for a detailed usage of the Java API

Linear Supertypes
PersistOnEvent, ConfirmedDelivery, EventsourcedActor, AbstractEventsourcedView, ConditionalRequests, EventsourcedVersion, EventsourcedView, Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractEventsourcedActor
  2. PersistOnEvent
  3. ConfirmedDelivery
  4. EventsourcedActor
  5. AbstractEventsourcedView
  6. ConditionalRequests
  7. EventsourcedVersion
  8. EventsourcedView
  9. Stash
  10. RequiresMessageQueue
  11. UnrestrictedStash
  12. StashSupport
  13. Actor
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractEventsourcedActor(id: String, eventLog: ActorRef)

    Permalink

Type Members

  1. type Handler[A] = (Try[A]) ⇒ Unit

    Permalink
    Definition Classes
    EventsourcedView
  2. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def aggregateId: Option[String]

    Permalink

    Optional aggregate id.

    Optional aggregate id. It is used for routing DurableEvents to event-sourced destinations which can be EventsourcedViews or EventsourcedActors. By default, an event is routed to an event-sourced destination with an undefined aggregateId. If a destination's aggregateId is defined it will only receive events with a matching aggregate id in DurableEvent#destinationAggregateIds.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
  5. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  6. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  7. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  8. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  9. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def commandContext: BehaviorContext

    Permalink

    Returns the command BehaviorContext.

    Returns the command BehaviorContext.

    Definition Classes
    EventsourcedView
  13. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  14. def deliver(deliveryId: String, message: Any, destination: ActorPath): Unit

    Permalink

    Delivers the given message to a destination.

    Delivers the given message to a destination. The delivery of message is identified by the given deliveryId which must be unique in context of the sending actor. The message is tracked as unconfirmed message until delivery is confirmed by persisting a confirmation event with persistConfirmation, using the same deliveryId.

    Definition Classes
    ConfirmedDelivery
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def eventContext: BehaviorContext

    Permalink

    Returns the event BehaviorContext.

    Returns the event BehaviorContext.

    Definition Classes
    EventsourcedView
  18. val eventLog: ActorRef

    Permalink

    Event log actor.

    Event log actor.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def getAggregateId: Optional[String]

    Permalink

    Java API of aggregateId.

    Java API of aggregateId.

    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def getLastEmitterAggregateId: Optional[String]

    Permalink

    Java API of lastEmitterAggregateId.

  23. final def getUnconfirmed: Set[String]

    Permalink

    Java API of unconfirmed.

    Java API of unconfirmed.

    See also

    ConfirmedDelivery

  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. val id: String

    Permalink

    Global unique actor id.

    Global unique actor id.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
  26. val instanceId: Int

    Permalink
    Definition Classes
    EventsourcedView
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. final def lastEmitterAggregateId: Option[String]

    Permalink

    Emitter aggregate id of the last handled event.

    Emitter aggregate id of the last handled event.

    Definition Classes
    EventsourcedView
  29. final def lastEmitterId: String

    Permalink

    Emitter id of the last handled event.

    Emitter id of the last handled event.

    Definition Classes
    EventsourcedView
  30. final def lastProcessId: String

    Permalink

    Id of the local event log that initially wrote the event.

    Id of the local event log that initially wrote the event.

    Definition Classes
    EventsourcedView
  31. final def lastSequenceNr: Long

    Permalink

    Sequence number of the last handled event.

    Sequence number of the last handled event.

    Definition Classes
    EventsourcedView
  32. final def lastSystemTimestamp: Long

    Permalink

    Wall-clock timestamp of the last handled event.

    Wall-clock timestamp of the last handled event.

    Definition Classes
    EventsourcedView
  33. final def lastVectorTimestamp: VectorTime

    Permalink

    Vector timestamp of the last handled event.

    Vector timestamp of the last handled event.

    Definition Classes
    EventsourcedView
  34. val logger: LoggingAdapter

    Permalink

    This actor's logging adapter.

    This actor's logging adapter.

    Definition Classes
    EventsourcedView
  35. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  36. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. def onCommand: Receive

    Permalink

    Java API of the command handler.

    Java API of the command handler.

    Returns a partial function that defines the actor's command handling behaviour. Use ReceiveBuilder to define the behaviour.

    Takes precedence over setOnCommand.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
    See also

    EventsourcedView

  39. def onEvent: Receive

    Permalink

    Java API of the event handler.

    Java API of the event handler.

    Returns a partial function that defines the actor's event handling behaviour. Use ReceiveBuilder to define the behaviour.

    Takes precedence over setOnEvent.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
    See also

    EventsourcedView

  40. def onRecover: ResultHandler[Unit]

    Permalink

    Java API of the recovery handler.

    Java API of the recovery handler.

    Returns a result handler that defines the actor's recover handling behaviour. Use ResultHandler to define the behaviour.

    Takes precedence over setOnRecover.

    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  41. final def onRecovery: Handler[Unit]

    Permalink

    Recovery completion handler.

    Recovery completion handler. If called with a Failure, the actor will be stopped in any case, regardless of the action taken by the returned handler. The default handler implementation does nothing and can be overridden by implementations.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
  42. def onSnapshot: Receive

    Permalink

    Java API of the snapshot handler.

    Java API of the snapshot handler.

    Returns a partial function that defines the actor's snapshot handling behaviour. Use ReceiveBuilder to define the behaviour.

    Takes precedence over setOnSnapshot.

    Definition Classes
    AbstractEventsourcedViewEventsourcedView
    See also

    EventsourcedView

  43. final def persist[A](event: A, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persist.

    Java API of persist.

    Calls the given handler with the persist result for the event.

    Multiple routing destinations can be defined with the customDestinationAggregateIds.

    See also

    EventsourcedActor

  44. final def persist[A](event: A, handler: ResultHandler[A]): Unit

    Permalink

    Java API of persist.

    Java API of persist.

    Calls the given handler with the persist result for the event.

    See also

    EventsourcedActor

  45. final def persist[A](event: A, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

    Permalink

    Asynchronously persists the given event and calls handler with the persist result.

    Asynchronously persists the given event and calls handler with the persist result. If persistence was successful, onEvent is called with the persisted event before handler is called. Both, onEvent and handler, are called on a dispatcher thread of this actor, hence, it is safe to modify internal state within them. The handler can also obtain a reference to the initial command sender via sender().

    By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

    Definition Classes
    EventsourcedActor
  46. final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistConfirmation.

  47. final def persistConfirmation[A](event: A, deliveryId: String, handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistConfirmation.

  48. final def persistConfirmation[A](event: A, deliveryId: String, customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

    Permalink

    Same semantics as EventsourcedActor.persist plus additional storage of a deliveryId together with the persistent event.

    Same semantics as EventsourcedActor.persist plus additional storage of a deliveryId together with the persistent event.

    Definition Classes
    ConfirmedDelivery
  49. final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistN.

    Java API of persistN.

    Calls the given handler with the persist result for each event in the sequence.

    Accepts an onLast handler that will be called after persisting the last event of the sequence.

    Multiple routing destinations can be defined with the customDestinationAggregateIds.

    See also

    EventsourcedActor

  50. final def persistN[A](events: Iterable[A], customDestinationAggregateIds: Set[String], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistN.

    Java API of persistN.

    Calls the given handler with the persist result for each event in the sequence.

    Multiple routing destinations can be defined with the customDestinationAggregateIds.

    See also

    EventsourcedActor

  51. final def persistN[A](events: Iterable[A], onLast: ResultHandler[A], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistN.

    Java API of persistN.

    Calls the given handler with the persist result for each event in the sequence.

    Accepts an onLast handler that will be called after persisting the last event of the sequence.

    See also

    EventsourcedActor

  52. final def persistN[A](events: Iterable[A], handler: ResultHandler[A]): Unit

    Permalink

    Java API of persistN.

    Java API of persistN.

    Calls the given handler with the persist result for each event in the sequence.

    See also

    EventsourcedActor

  53. final def persistN[A](events: Seq[A], onLast: Handler[A] = (_: Try[A]) => (), customDestinationAggregateIds: Set[String] = Set())(handler: Handler[A]): Unit

    Permalink

    Asynchronously persists a sequence of events and calls handler with the persist result for each event in the sequence.

    Asynchronously persists a sequence of events and calls handler with the persist result for each event in the sequence. If persistence was successful, onEvent is called with a persisted event before handler is called. Both, onEvent and handler, are called on a dispatcher thread of this actor, hence, it is safe to modify internal state within them. The handler can also obtain a reference to the initial command sender via sender(). The onLast handler is additionally called for the last event in the sequence.

    By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

    Definition Classes
    EventsourcedActor
  54. final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String]): Unit

    Permalink

    Java API of persistOnEvent.

    Java API of persistOnEvent.

    Multiple routing destinations can be defined with the customDestinationAggregateIds.

    See also

    PersistOnEvent

  55. final def persistOnEvent[A](event: A): Unit

    Permalink

    Java API of persistOnEvent.

    Java API of persistOnEvent.

    See also

    PersistOnEvent

  56. final def persistOnEvent[A](event: A, customDestinationAggregateIds: Set[String] = Set()): Unit

    Permalink

    Asynchronously persists the given event.

    Asynchronously persists the given event. Applications that want to handle the persisted event should define the event handler at that event. By default, the event is routed to event-sourced destinations with an undefined aggregateId. If this actor's aggregateId is defined it is additionally routed to all actors with the same aggregateId. Further routing destinations can be defined with the customDestinationAggregateIds parameter.

    Definition Classes
    PersistOnEvent
  57. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  58. def postStop(): Unit

    Permalink

    Sets recovering to false before calling super.postStop.

    Sets recovering to false before calling super.postStop.

    Definition Classes
    EventsourcedView → UnrestrictedStash → Actor
  59. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    Sets recovering to false before calling super.preRestart.

    Sets recovering to false before calling super.preRestart.

    Definition Classes
    EventsourcedView → UnrestrictedStash → Actor
  60. def preStart(): Unit

    Permalink

    Initiates recovery.

    Initiates recovery.

    Definition Classes
    EventsourcedView → Actor
  61. final def receive: Receive

    Permalink

    Initialization behavior.

    Initialization behavior.

    Definition Classes
    EventsourcedView → Actor
  62. final def recovering: Boolean

    Permalink

    Returns true if this actor is currently recovering internal state by consuming replayed events from the event log.

    Returns true if this actor is currently recovering internal state by consuming replayed events from the event log. Returns false after recovery completed and the actor switches to consuming live events.

    Definition Classes
    EventsourcedView
  63. def redeliverUnconfirmed(): Unit

    Permalink

    Redelivers all unconfirmed messages.

    Redelivers all unconfirmed messages.

    Definition Classes
    ConfirmedDelivery
  64. def replayBatchSize: Int

    Permalink

    Maximum number of events to be replayed to this actor before replaying is suspended.

    Maximum number of events to be replayed to this actor before replaying is suspended. A suspended replay is resumed automatically after all replayed events haven been handled by this actor's event handler (= backpressure). The default value for the maximum replay batch size is given by configuration item eventuate.log.replay-batch-size. Configured values can be overridden by overriding this method.

    Definition Classes
    EventsourcedView
  65. def replayFromSequenceNr: Option[Long]

    Permalink

    Override to provide an application-defined log sequence number from which event replay will start.

    Override to provide an application-defined log sequence number from which event replay will start.

    If Some(snr) is returned snapshot loading will be skipped and replay will start from the given sequence number snr.

    If None is returned the actor proceeds with the regular snapshot loading procedure.

    Definition Classes
    EventsourcedView
  66. def save(snapshot: Any, handler: ResultHandler[SnapshotMetadata]): Unit

    Permalink

    Java API of save.

    Java API of save.

    Must be supplied with a ResultHandler to process successful or failed results.

    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  67. final def save(snapshot: Any)(handler: Handler[SnapshotMetadata]): Unit

    Permalink

    Asynchronously saves the given snapshot and calls handler with the generated snapshot metadata.

    Asynchronously saves the given snapshot and calls handler with the generated snapshot metadata. The handler can obtain a reference to the initial message sender with sender().

    Definition Classes
    EventsourcedView
  68. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  69. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  70. final def setOnCommand(handler: Receive): Unit

    Permalink

    Java API that sets this actor's command handler.

    Java API that sets this actor's command handler.

    Supplied with a partial function that defines the actor's command handling behaviour. Use ReceiveBuilder to define the behaviour.

    If onCommand is implemented, the supplied behaviour is ignored.

    handler

    a function that defines this actor's command handling behaviour.

    Attributes
    protected
    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  71. final def setOnEvent(handler: Receive): Unit

    Permalink

    Java API that sets this actor's event handler.

    Java API that sets this actor's event handler.

    Supplied with a partial function that defines the actor's event handling behaviour. Use ReceiveBuilder to define the behaviour.

    If onEvent is implemented, the supplied behaviour is ignored.

    handler

    a function that defines this actor's event handling behaviour.

    Attributes
    protected
    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  72. final def setOnRecover(handler: ResultHandler[Unit]): Unit

    Permalink

    Java API that sets this actor's recovery handler.

    Java API that sets this actor's recovery handler.

    Supplied with a result handler that defines the actor's recover handling behaviour. Use ResultHandler to define the behaviour.

    If onRecover is implemented, the supplied behaviour is ignored.

    handler

    a ResultHandler that defines this actor's recover handling behaviour.

    Attributes
    protected
    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  73. final def setOnSnapshot(handler: Receive): Unit

    Permalink

    Java API that sets this actor's snapshot handler.

    Java API that sets this actor's snapshot handler.

    Supplied with a partial function that defines the actor's snapshot handling behaviour. Use ReceiveBuilder to define the behaviour.

    If onSnapshot is implemented, the supplied behaviour is ignored.

    handler

    a function that defines this actor's snapshot handling behaviour.

    Attributes
    protected
    Definition Classes
    AbstractEventsourcedView
    See also

    EventsourcedView

  74. def snapshotContext: BehaviorContext

    Permalink

    Returns the snapshot BehaviorContext.

    Returns the snapshot BehaviorContext.

    Definition Classes
    EventsourcedView
  75. def stash(): Unit

    Permalink

    Adds the current command to the user's command stash.

    Adds the current command to the user's command stash. Must not be used in the event handler or persist handler.

    Definition Classes
    EventsourcedActorEventsourcedView → StashSupport
  76. def stateSync: Boolean

    Permalink

    State synchronization.

    State synchronization. If set to true, commands see internal state that is consistent with the event log. This is achieved by stashing new commands if this actor is currently writing events. If set to false, commands see internal state that is eventually consistent with the event log.

    Definition Classes
    EventsourcedActor
  77. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    Actor
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  79. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  80. def unconfirmed: Set[String]

    Permalink

    Delivery ids of unconfirmed messages.

    Delivery ids of unconfirmed messages.

    Definition Classes
    ConfirmedDelivery
  81. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Actor
  82. def unstashAll(): Unit

    Permalink

    Prepends all stashed commands to the actor's mailbox and then clears the command stash.

    Prepends all stashed commands to the actor's mailbox and then clears the command stash. Has no effect if the actor is recovering i.e. if recovering returns true.

    Definition Classes
    EventsourcedActorEventsourcedView → StashSupport
  83. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PersistOnEvent

Inherited from ConfirmedDelivery

Inherited from EventsourcedActor

Inherited from AbstractEventsourcedView

Inherited from ConditionalRequests

Inherited from EventsourcedVersion

Inherited from EventsourcedView

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped