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