Class

com.lightbend.lagom.internal.javadsl.persistence

AbstractPersistentEntityRegistry

Related Doc: package persistence

Permalink

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, injector: Injector)

    Permalink

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[Pair[Event, Offset], 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 Offset#NONE, 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. def finalize(): Unit

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

  16. 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()

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. val journalPluginId: String

    Permalink
    Attributes
    protected

  21. 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

  22. val name: Optional[String]

    Permalink
    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. val queryPluginId: Optional[String]

    Permalink
    Attributes
    protected

  27. def refFor[C](entityClass: Class[_ <: PersistentEntity[C, _, _]], entityId: String): PersistentEntityRef[C]

    Permalink

    Retrieve a PersistentEntityRef for a given PersistentEntity class and identifier.

    Retrieve a PersistentEntityRef for a given PersistentEntity class and identifier. Commands are sent to a PersistentEntity using a PersistentEntityRef.

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry

  28. def register[C, E, S](entityClass: Class[_ <: PersistentEntity[C, E, S]]): Unit

    Permalink

    At system startup all PersistentEntity classes must be registered with this method.

    At system startup all PersistentEntity classes must be registered with this method.

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry

  29. val snapshotPluginId: String

    Permalink
    Attributes
    protected

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

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

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

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

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

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

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

  35. 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

Deprecated Value Members

  1. def eventStream[Event <: AggregateEvent[Event]](aggregateTag: AggregateEventTag[Event], fromOffset: Optional[UUID]): Source[Pair[Event, UUID], 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.

    This method will only work with journals that support UUID offsets. Journals that produce sequence offsets will fail during stream handling.

    Definition Classes
    PersistentEntityRegistry
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2.0) Use eventStream(AggregateEventTag, Offset) instead

  2. def gracefulShutdown(timeout: FiniteDuration): CompletionStage[Done]

    Permalink

    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 CompletionStage

    Definition Classes
    AbstractPersistentEntityRegistry → PersistentEntityRegistry
    Deprecated

    As of Lagom 1.4, this method has no effect and no longer needs to be called

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