Class

no.nextgentel.oss.akkatools.aggregate

GeneralAggregateBase

Related Doc: package aggregate

Permalink

abstract class GeneralAggregateBase[E, S <: AggregateStateBase[E, S]] extends EnhancedPersistentShardingActor[E, AggregateError]

Dispatcher - When sending something to an ES, use its dispatcher Command - Dispatchable message - When sent to the dispatcher, it will be sent to the correct ES.

Event - Represents a change of state for an ES

State is immutable. Represents the full state of the entity. based on its state it can accept or reject an event. Has with method transition(event) - if ok, it returns new state. If not, an error is thrown.

Can be used to try an event (since it is mutable)

DurableMessage: method of sending a message which with retry-mechanism until confirm() is called.

GeneralAggregate pseudocode:

for each received cmd: convert it to event try the event (by calling state.transition() ) if it failed: maybe do something if it works: persist event generate and send DurableMessages change our current state (by calling state.transition() and keeping the result )

E

Superclass/trait representing your events

S

The type representing your state

Linear Supertypes
EnhancedPersistentShardingActor[E, AggregateError], EnhancedPersistentActor[E, AggregateError], MdcSupport[E], BeforeAndAfterEventAndCommand[E], DiagnosticActorLogging, AtLeastOnceDelivery, AtLeastOnceDeliveryLike, PersistentActor, Eventsourced, PersistenceRecovery, PersistenceIdentity, PersistenceStash, StashFactory, Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, Snapshotter, Actor, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralAggregateBase
  2. EnhancedPersistentShardingActor
  3. EnhancedPersistentActor
  4. MdcSupport
  5. BeforeAndAfterEventAndCommand
  6. DiagnosticActorLogging
  7. AtLeastOnceDelivery
  8. AtLeastOnceDeliveryLike
  9. PersistentActor
  10. Eventsourced
  11. PersistenceRecovery
  12. PersistenceIdentity
  13. PersistenceStash
  14. StashFactory
  15. Stash
  16. RequiresMessageQueue
  17. UnrestrictedStash
  18. StashSupport
  19. Snapshotter
  20. Actor
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GeneralAggregateBase(dmSelf: ActorPath)(implicit arg0: ClassTag[E], arg1: ClassTag[S])

    Permalink

    dmSelf

    dmSelf is used as the address where the DM-confirmation-messages should be sent. In a sharding environment, this has to be our dispatcher which knows how to reach the sharding mechanism. If null, we'll fallback to self - useful when testing

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def cmdToEvent: PartialFunction[AggregateCmd, ResultingEvent[E]]

    Permalink
  2. abstract def generateDMs(event: E, previousState: S): ResultingDMs

    Permalink
  3. abstract def persistenceIdBase(): String

    Permalink
  4. abstract val state: S

    Permalink

Concrete 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. def afterOnEvent(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BeforeAndAfterEventAndCommand
  5. def afterTryCommand(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BeforeAndAfterEventAndCommand
  6. def aroundPostRestart(reason: Throwable): Unit

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

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

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    AtLeastOnceDeliveryLike → Eventsourced → Actor
  9. def aroundPreStart(): Unit

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

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    DiagnosticActorLogging → Actor
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def beforeOnEvent(event: E): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    MdcSupportBeforeAndAfterEventAndCommand
  13. def beforeTryCommand(cmd: AnyRef): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    MdcSupportBeforeAndAfterEventAndCommand
  14. def canSendAsDM(): Boolean

    Permalink
    Definition Classes
    EnhancedPersistentActor
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def confirmDelivery(deliveryId: Long): Boolean

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  17. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  18. var currentLogLevelInfo: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  19. def defaultMdc(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    MdcSupport
  20. def defaultTimeToWaitAfterMaxRedeliverAttemptsBeforeTimeout(): FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  21. def defer[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  22. def deferAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  23. def deleteMessages(toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Eventsourced
  24. def deleteSnapshot(sequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  25. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Permalink
    Definition Classes
    Snapshotter
  26. def deliver(destination: ActorSelection)(deliveryIdToMessage: (Long) ⇒ Any): Unit

    Permalink
    Definition Classes
    AtLeastOnceDelivery
  27. def deliver(destination: ActorPath)(deliveryIdToMessage: (Long) ⇒ Any): Unit

    Permalink
    Definition Classes
    AtLeastOnceDelivery
  28. lazy val dispatchId: String

    Permalink
  29. def doUnconfirmedWarningProcessing(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  30. def durableMessageNotDeliveredHandler(originalPayload: Any, errorMsg: String): Unit

    Permalink

    If doUnconfirmedWarningProcessing is turned on, then override this method to try to do something useful before we give up

    If doUnconfirmedWarningProcessing is turned on, then override this method to try to do something useful before we give up

    Attributes
    protected
    Definition Classes
    GeneralAggregateBaseEnhancedPersistentActor
  31. implicit val ec: ExecutionContextExecutor

    Permalink
    Definition Classes
    EnhancedPersistentActor
  32. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  34. def extractMdc(eventOrCmd: AnyRef): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    MdcSupport
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def generateEventsForFailedDurableMessage(originalPayload: Any, errorMsg: String): Seq[E]

    Permalink

    Override this to decide if the failed outbound durableMessage should result in a persisted event.

    Override this to decide if the failed outbound durableMessage should result in a persisted event. If so, return these events. When these have been persisted, generateDMs() will be called as usual enabling you to perform some outbound action.

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. def getDMGeneratingVersion: Int

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  39. def getDMSelf(): ActorPath

    Permalink
  40. def getDeliverySnapshot: AtLeastOnceDeliverySnapshot

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. def idleTimeout(): FiniteDuration

    Permalink
    Definition Classes
    EnhancedPersistentActor
  43. lazy val idleTimeoutValueToUse: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  44. def internalProcessUnconfirmedWarning(unconfirmedWarning: UnconfirmedWarning): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    GeneralAggregateBaseEnhancedPersistentActor
  45. def internalStashOverflowStrategy: StashOverflowStrategy

    Permalink
    Definition Classes
    PersistenceStash
  46. def isExpectedError(e: Exception): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  47. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  48. def journalPluginId: String

    Permalink
    Definition Classes
    PersistenceIdentity
  49. def lastSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced
  50. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  51. val log: DiagnosticLoggingAdapter

    Permalink
    Definition Classes
    DiagnosticActorLogging
  52. def logMessage(message: String): Unit

    Permalink
    Definition Classes
    EnhancedPersistentActor
  53. def maxUnconfirmedMessages: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  54. def mdc(currentMessage: Any): MDC

    Permalink
    Definition Classes
    MdcSupport → DiagnosticActorLogging
  55. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  58. def numberOfUnconfirmed: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  59. def onAlreadyProcessedCmdViaDMReceivedAgain(cmd: AnyRef): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    GeneralAggregateBaseEnhancedPersistentActor
  60. def onApplyingLiveEvent(event: E): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  61. def onEvent: PartialFunction[E, Unit]

    Permalink
  62. def onInactiveTimeout(): Unit

    Permalink

    Called when actor has been idle for too long..

    Called when actor has been idle for too long..

    If running in sharding, you should stop like this:

    getContext().parent().tell(new ShardRegion.Passivate(PoisonPill.getInstance()), self());

    Attributes
    protected
    Definition Classes
    EnhancedPersistentShardingActorEnhancedPersistentActor
  63. def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  64. def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  65. def onReceiveRecover(event: E): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  66. def onRecoveryCompleted(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  67. def onRecoveryFailure(cause: Throwable, event: Option[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
  68. def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  69. def persistAll[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  70. def persistAllAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  71. def persistAndApplyEvent(event: E, successHandler: () ⇒ Unit): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  72. def persistAndApplyEvent(event: E): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  73. def persistAndApplyEvents(events: List[E], successHandler: () ⇒ Unit): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  74. def persistAndApplyEvents(events: List[E]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  75. def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  76. def persistenceId: String

    Permalink
    Definition Classes
    EnhancedPersistentShardingActor → PersistenceIdentity
  77. def postRestart(reason: Throwable): Unit

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

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

    Permalink
    Definition Classes
    UnrestrictedStash → Actor
  80. def preStart(): Unit

    Permalink
    Definition Classes
    EnhancedPersistentActor → Actor
  81. def receive: Receive

    Permalink
    Definition Classes
    PersistentActor → Actor
  82. def receiveCommand: Receive

    Permalink
    Definition Classes
    EnhancedPersistentActor → Eventsourced
  83. def receiveRecover: Receive

    Permalink
    Definition Classes
    EnhancedPersistentActor → Eventsourced
  84. def recovery: Recovery

    Permalink
    Definition Classes
    PersistenceRecovery
  85. def recoveryFinished: Boolean

    Permalink
    Definition Classes
    Eventsourced
  86. def recoveryRunning: Boolean

    Permalink
    Definition Classes
    Eventsourced
  87. def redeliverInterval: FiniteDuration

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  88. def redeliveryBurstLimit: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  89. def saveSnapshot(snapshot: Any): Unit

    Permalink
    Definition Classes
    Snapshotter
  90. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  91. def sendAsDM(sendAsDM: SendAsDM): Unit

    Permalink
  92. def sendAsDM(payload: AnyRef, destinationActor: ActorPath): Unit

    Permalink
  93. def sendAsDM(payload: AnyRef, destinationActor: ActorPath, confirmationRoutingInfo: AnyRef): Unit

    Permalink
    Definition Classes
    EnhancedPersistentActor
  94. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  95. def setDeliverySnapshot(snapshot: AtLeastOnceDeliverySnapshot): Unit

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike
  96. def setLogLevels(eventLogLevelInfo: Boolean, recoveringEventLogLevelInfo: Boolean, cmdLogLevelInfo: Boolean): Unit

    Permalink

    eventLogLevelInfo

    Used when processing events live - not recovering

    recoveringEventLogLevelInfo

    Used when recovering events

    cmdLogLevelInfo

    Used when processing commands

    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  97. def setMdcValue(name: String, value: String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    MdcSupport
  98. def snapshotPluginId: String

    Permalink
    Definition Classes
    PersistenceIdentity
  99. def snapshotSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  100. def snapshotterId: String

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  101. def stash(): Unit

    Permalink
    Definition Classes
    Eventsourced → StashSupport
  102. def stateInfo(): String

    Permalink
    Attributes
    protected
    Definition Classes
    GeneralAggregateBaseEnhancedPersistentActor
  103. def supervisorStrategy: SupervisorStrategy

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  106. def toStringForLogging[T](o: T): String

    Permalink
    Attributes
    protected
    Definition Classes
    EnhancedPersistentActor
  107. final def tryCommand: PartialFunction[AnyRef, Unit]

    Permalink
  108. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Eventsourced → Actor
  109. def unstashAll(): Unit

    Permalink
    Definition Classes
    Eventsourced → StashSupport
  110. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. def warnAfterNumberOfUnconfirmedAttempts: Int

    Permalink
    Definition Classes
    AtLeastOnceDeliveryLike

Inherited from MdcSupport[E]

Inherited from BeforeAndAfterEventAndCommand[E]

Inherited from DiagnosticActorLogging

Inherited from AtLeastOnceDelivery

Inherited from AtLeastOnceDeliveryLike

Inherited from PersistentActor

Inherited from Eventsourced

Inherited from PersistenceRecovery

Inherited from PersistenceIdentity

Inherited from PersistenceStash

Inherited from StashFactory

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped