t

akka.persistence.journal

WriteEventAdapter

trait WriteEventAdapter extends AnyRef

Facility to convert to specialised data models, as may be required by specialized persistence Journals.

Typical use cases include (but are not limited to):

  • adding metadata, a.k.a. "tagging" - by wrapping objects into tagged counterparts
  • manually converting to the Journals storage format, such as JSON, BSON or any specialised binary format
  • splitting up large events into sequences of smaller ones
Source
EventAdapter.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteEventAdapter
  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. Protected

Abstract Value Members

  1. abstract def manifest(event: Any): 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.

  2. abstract def toJournal(event: Any): Any

    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.

    event

    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 WriteEventAdapter toany2stringadd[WriteEventAdapter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WriteEventAdapter, B)
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toArrowAssoc[WriteEventAdapter] 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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (WriteEventAdapter) => Boolean, msg: => Any): WriteEventAdapter
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toEnsuring[WriteEventAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (WriteEventAdapter) => Boolean): WriteEventAdapter
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toEnsuring[WriteEventAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): WriteEventAdapter
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toEnsuring[WriteEventAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): WriteEventAdapter
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toEnsuring[WriteEventAdapter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toStringFormat[WriteEventAdapter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (WriteEventAdapter, B)
    Implicit
    This member is added by an implicit conversion from WriteEventAdapter toArrowAssoc[WriteEventAdapter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWriteEventAdapter to any2stringadd[WriteEventAdapter]

Inherited by implicit conversion StringFormat fromWriteEventAdapter to StringFormat[WriteEventAdapter]

Inherited by implicit conversion Ensuring fromWriteEventAdapter to Ensuring[WriteEventAdapter]

Inherited by implicit conversion ArrowAssoc fromWriteEventAdapter to ArrowAssoc[WriteEventAdapter]

Ungrouped