t

com.lightbend.lagom.scaladsl.persistence

PersistentEntityRegistry

trait PersistentEntityRegistry extends AnyRef

At system startup all PersistentEntity classes must be registered here with PersistentEntityRegistry#register.

Later, com.lightbend.lagom.scaladsl.persistence.PersistentEntityRef can be retrieved with PersistentEntityRegistry#refFor. Commands are sent to a com.lightbend.lagom.scaladsl.persistence.PersistentEntity using a PersistentEntityRef.

Source
PersistentEntityRegistry.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentEntityRegistry
  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 eventStream[Event <: AggregateEvent[Event]](aggregateTag: AggregateEventTag[Event], fromOffset: Offset): Source[EventStreamElement[Event], NotUsed]

    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.

    Exceptions thrown

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

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

    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.

  3. abstract def register(entityFactory: ⇒ PersistentEntity): Unit

    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.

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

    No-op method that exists only for backward-compatibility reasons.

    No-op method that exists only for backward-compatibility reasons. Lagom now uses Akka's CoordinatedShutdown to gracefully shut down all sharded entities, including Persistent Entities.

    returns

    a completed Future

    Annotations
    @deprecated
    Deprecated

    (Since version 1.4.0) This method has no effect and no longer needs to be called

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 PersistentEntityRegistry to any2stringadd[PersistentEntityRegistry] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PersistentEntityRegistry, B)
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to ArrowAssoc[PersistentEntityRegistry] 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( ... ) @native()
  8. def ensuring(cond: (PersistentEntityRegistry) ⇒ Boolean, msg: ⇒ Any): PersistentEntityRegistry
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to Ensuring[PersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (PersistentEntityRegistry) ⇒ Boolean): PersistentEntityRegistry
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to Ensuring[PersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): PersistentEntityRegistry
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to Ensuring[PersistentEntityRegistry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): PersistentEntityRegistry
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to Ensuring[PersistentEntityRegistry] 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[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 PersistentEntityRegistry to StringFormat[PersistentEntityRegistry] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  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( ... ) @native()
  27. def →[B](y: B): (PersistentEntityRegistry, B)
    Implicit
    This member is added by an implicit conversion from PersistentEntityRegistry to ArrowAssoc[PersistentEntityRegistry] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped