c

akka.persistence.typed

EventAdapter

abstract class EventAdapter[E, P] extends AnyRef

Facility to convert from and to specialised data models, as may be required by specialized persistence Journals. Typical use cases include (but are not limited to):

  • extracting events from "envelopes"
  • adapting events from a "domain model" to the "data model", e.g. converting to the Journals storage format, such as JSON, BSON or any specialised binary format
  • adapting events from a "data model" to the "domain model"
  • adding metadata that is understood by the journal
  • migration by splitting up events into sequences of other events
  • migration filtering out unused events, or replacing an event with another
Source
EventAdapter.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventAdapter
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EventAdapter()

Abstract Value Members

  1. abstract def fromJournal(p: P, manifest: String): EventSeq[E]

    Transform the event on recovery from the journal.

    Transform the event on recovery from the journal. Note that this is not called in any read side so will need to be applied manually when using Query.

    Convert a event from its journal model to the applications domain model.

    One event may be adapter into multiple (or none) events which should be delivered to the EventSourcedBehavior. Use the specialised EventSeq.single method to emit exactly one event, or EventSeq.empty in case the adapter is not handling this event.

    p

    event to be adapted before delivering to the EventSourcedBehavior

    manifest

    optionally provided manifest (type hint) in case the Adapter has stored one for this event, "" if none

    returns

    sequence containing the adapted events (possibly zero) which will be delivered to the EventSourcedBehavior

  2. abstract def manifest(event: E): String

    Return the manifest (type hint) that will be provided in the fromJournal method.

    Return the manifest (type hint) that will be provided in the fromJournal method. Use "" if manifest is not needed.

  3. abstract def toJournal(e: E): P

    Convert domain event to journal event type.

    Convert domain event to journal event type.

    Some journal may require a specific type to be returned to them, for example if a primary key has to be associated with each event then a journal may require adapters to return com.example.myjournal.EventWithPrimaryKey(event, key).

    The toJournal adaptation must be an 1-to-1 transformation. It is not allowed to drop incoming events during the toJournal adaptation.

    e

    the application-side domain event to be adapted to the journal model

    returns

    the adapted event object, possibly the same object if no adaptation was performed

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 EventAdapter[E, P] to any2stringadd[EventAdapter[E, P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EventAdapter[E, P], B)
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to ArrowAssoc[EventAdapter[E, P]] 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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (EventAdapter[E, P]) ⇒ Boolean, msg: ⇒ Any): EventAdapter[E, P]
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to Ensuring[EventAdapter[E, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EventAdapter[E, P]) ⇒ Boolean): EventAdapter[E, P]
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to Ensuring[EventAdapter[E, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): EventAdapter[E, P]
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to Ensuring[EventAdapter[E, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EventAdapter[E, P]
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to Ensuring[EventAdapter[E, P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to StringFormat[EventAdapter[E, P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (EventAdapter[E, P], B)
    Implicit
    This member is added by an implicit conversion from EventAdapter[E, P] to ArrowAssoc[EventAdapter[E, P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EventAdapter[E, P] to any2stringadd[EventAdapter[E, P]]

Inherited by implicit conversion StringFormat from EventAdapter[E, P] to StringFormat[EventAdapter[E, P]]

Inherited by implicit conversion Ensuring from EventAdapter[E, P] to Ensuring[EventAdapter[E, P]]

Inherited by implicit conversion ArrowAssoc from EventAdapter[E, P] to ArrowAssoc[EventAdapter[E, P]]

Ungrouped