t

akka.persistence.journal

ReadEventAdapter

trait ReadEventAdapter 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"
  • manually converting to the Journals storage format, such as JSON, BSON or any specialised binary format
  • adapting incoming events from a "data model" to the "domain model"
Source
EventAdapter.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
EventAdapter, IdentityEventAdapter
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadEventAdapter
  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

Abstract Value Members

  1. abstract def fromJournal(event: Any, manifest: String): EventSeq

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

    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 akka.persistence.PersistentActor. Use the specialised akka.persistence.journal.EventSeq#single method to emit exactly one event, or akka.persistence.journal.EventSeq#empty in case the adapter is not handling this event. Multiple EventAdapter instances are applied in order as defined in configuration and their emitted event seqs are concatenated and delivered in order to the PersistentActor.

    event

    event to be adapted before delivering to the PersistentActor

    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 PersistentActor

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ReadEventAdapter to any2stringadd[ReadEventAdapter]

Inherited by implicit conversion StringFormat from ReadEventAdapter to StringFormat[ReadEventAdapter]

Inherited by implicit conversion Ensuring from ReadEventAdapter to Ensuring[ReadEventAdapter]

Inherited by implicit conversion ArrowAssoc from ReadEventAdapter to ArrowAssoc[ReadEventAdapter]

Ungrouped