ReadEventAdapter

org.apache.pekko.persistence.journal.ReadEventAdapter

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"

Attributes

Source
EventAdapter.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

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 org.apache.pekko.persistence.PersistentActor. Use the specialised org.apache.pekko.persistence.journal.EventSeq#single method to emit exactly one event, or org.apache.pekko.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.

Value parameters

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

Attributes

Returns

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

Source
EventAdapter.scala