Class

com.lightbend.lagom.internal.scaladsl.persistence

AbstractPersistentEntityRegistry

Related Doc: package persistence

Permalink

abstract class AbstractPersistentEntityRegistry extends PersistentEntityRegistry

Provides shared functionality for implementing a persistent entity registry.

Akka persistence plugins can extend this to implement a custom registry.

Source
AbstractPersistentEntityRegistry.scala
Linear Supertypes
PersistentEntityRegistry, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractPersistentEntityRegistry
  2. PersistentEntityRegistry
  3. AnyRef
  4. 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 AbstractPersistentEntityRegistry(system: ActorSystem)

    Permalink

Abstract Value Members

  1. abstract val journalId: String

    Permalink

    The ID of the journal.

    The ID of the journal.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to any2stringadd[AbstractPersistentEntityRegistry] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (AbstractPersistentEntityRegistry, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to ArrowAssoc[AbstractPersistentEntityRegistry] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (AbstractPersistentEntityRegistry) ⇒ Boolean, msg: ⇒ Any): AbstractPersistentEntityRegistry

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to Ensuring[AbstractPersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (AbstractPersistentEntityRegistry) ⇒ Boolean): AbstractPersistentEntityRegistry

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to Ensuring[AbstractPersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractPersistentEntityRegistry

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to Ensuring[AbstractPersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): AbstractPersistentEntityRegistry

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to Ensuring[AbstractPersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def eventStream[Event <: AggregateEvent[Event]](aggregateTag: AggregateEventTag[Event], fromOffset: Offset): Source[EventStreamElement[Event], NotUsed]

    Permalink

    A stream of the persistent events that have the given aggregateTag, e.g.

    A stream of the persistent events that have the given aggregateTag, e.g. all persistent events of all Order entities.

    The type of the offset is journal dependent, some journals use time-based UUID offsets, while others use sequence numbers. The passed in fromOffset must either be akka.persistence.query.NoOffset, or an offset that has previously been produced by this journal.

    The stream will begin with events starting after fromOffset. To resume an event stream, store the Offset corresponding to the most recently processed Event, and pass that back as the value for fromOffset to start the stream from events following that one.

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry
    Exceptions thrown

    IllegalArgumentException If the fromOffset type is not supported by this journal.

  15. val eventsByTagQuery: Option[EventsByTagQuery2]

    Permalink

    The events by tag query.

    The events by tag query. Necessary for implementing read sides and the eventStream query.

    Attributes
    protected

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to StringFormat[AbstractPersistentEntityRegistry] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def gracefulShutdown(timeout: FiniteDuration): Future[Done]

    Permalink

    Gracefully stop the persistent entities and leave the cluster.

    Gracefully stop the persistent entities and leave the cluster. The persistent entities will be started on another node when new messages are sent to them.

    returns

    the Future is completed when the node has been removed from the cluster

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def mapStartingOffset(storedOffset: Offset): Offset

    Permalink

    Converts a stored event journal offset into the argument to an eventsByTag query.

    Converts a stored event journal offset into the argument to an eventsByTag query.

    Different Akka Persistence back ends interpret the offset parameter to eventsByTag differently. Some return events starting after the given offset, others start with the event at that offset. In Lagom, we shield end users from this difference, and always want to return unprocessed events. Subclasses can override this method as necessary to convert a stored offset into a starting offset that ensures no stored values will be repeated in the stream.

    storedOffset

    the most recently seen offset

    returns

    an offset that can be provided to the eventsByTag query to retrieve only unseen events

    Attributes
    protected

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. def refFor[P <: PersistentEntity](entityId: String)(implicit arg0: ClassTag[P]): PersistentEntityRef[refFor.P.Command]

    Permalink

    Retrieve a com.lightbend.lagom.scaladsl.persistence.PersistentEntityRef for a given com.lightbend.lagom.scaladsl.persistence.PersistentEntity class and identifier.

    Retrieve a com.lightbend.lagom.scaladsl.persistence.PersistentEntityRef for a given com.lightbend.lagom.scaladsl.persistence.PersistentEntity class and identifier. Commands are sent to a PersistentEntity using a PersistentEntityRef.

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry

  27. def register(entityFactory: ⇒ PersistentEntity): Unit

    Permalink

    At system startup all com.lightbend.lagom.scaladsl.persistence.PersistentEntity classes must be registered with this method.

    At system startup all com.lightbend.lagom.scaladsl.persistence.PersistentEntity classes must be registered with this method.

    The entityFactory will be called when a new entity instance is to be created. That will happen in another thread, so the entityFactory must be thread-safe, e.g. not close over shared mutable state that is not thread-safe.

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def →[B](y: B): (AbstractPersistentEntityRegistry, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractPersistentEntityRegistry to ArrowAssoc[AbstractPersistentEntityRegistry] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from PersistentEntityRegistry

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped