c

akka.persistence

AbstractPersistentView

abstract class AbstractPersistentView extends AbstractActor with PersistentView

Java API: compatible with lambda expressions (to be used with akka.japi.pf.ReceiveBuilder)

Annotations
@deprecated
Deprecated

(Since version 2.4) use Persistence Query instead

Source
PersistentView.scala
See also

PersistentView

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractPersistentView
  2. PersistentView
  3. ActorLogging
  4. PersistenceRecovery
  5. PersistenceIdentity
  6. StashFactory
  7. Stash
  8. RequiresMessageQueue
  9. UnrestrictedStash
  10. StashSupport
  11. Snapshotter
  12. AbstractActor
  13. Actor
  14. AnyRef
  15. 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 AbstractPersistentView()

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def persistenceId: String

    Id of the persistent entity for which messages should be replayed.

    Id of the persistent entity for which messages should be replayed.

    Definition Classes
    PersistenceIdentity
  2. abstract def viewId: String

    View id is used as identifier for snapshots performed by this PersistentView.

    View id is used as identifier for snapshots performed by this PersistentView. This allows the View to keep separate snapshots of data than the PersistentActor originating the message stream.

    The usual case is to have a *different* id set as viewId than persistenceId, although it is possible to share the same id with an PersistentActor - for example to decide about snapshots based on some average or sum, calculated by this view.

    Example:

    class SummingView extends PersistentView {
      override def persistenceId = "count-123"
      override def viewId        = "count-123-sum" // this view is performing summing,
                                                   // so this view's snapshots reside under the "-sum" suffixed id
    
      // ...
    }
    Definition Classes
    PersistentView

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 AbstractPersistentView to any2stringadd[AbstractPersistentView] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractPersistentView, B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to ArrowAssoc[AbstractPersistentView] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  7. def aroundPostStop(): Unit

    Can be overridden to intercept calls to postStop.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Can be overridden to intercept calls to preRestart.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  9. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    PersistentViewActor
  10. def aroundReceive(receive: Receive, message: Any): Unit

    INTERNAL API.

    INTERNAL API.

    receive

    current behavior.

    Attributes
    protected[akka]
    Definition Classes
    PersistentViewActor
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def autoUpdate: Boolean

    If true, this view automatically updates itself with an interval specified by autoUpdateInterval.

    If true, this view automatically updates itself with an interval specified by autoUpdateInterval. If false, applications must explicitly update this view by sending Update requests. The default value can be configured with the akka.persistence.view.auto-update configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    PersistentView
  13. def autoUpdateInterval: FiniteDuration

    The interval for automated updates.

    The interval for automated updates. The default value can be configured with the akka.persistence.view.auto-update-interval configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    PersistentView
  14. def autoUpdateReplayMax: Long

    The maximum number of messages to replay per update.

    The maximum number of messages to replay per update. The default value can be configured with the akka.persistence.view.auto-update-replay-max configuration key. This method can be overridden by implementation classes to return non-default values.

    Definition Classes
    PersistentView
  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. implicit val context: ActorContext

    Stores the context for this actor, including self, and sender.

    Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  17. def deleteSnapshot(sequenceNr: Long): Unit

    Deletes the snapshot identified by sequenceNr.

    Deletes the snapshot identified by sequenceNr.

    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

    Definition Classes
    Snapshotter
  18. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

    Definition Classes
    Snapshotter
  19. def ensuring(cond: (AbstractPersistentView) ⇒ Boolean, msg: ⇒ Any): AbstractPersistentView
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to Ensuring[AbstractPersistentView] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (AbstractPersistentView) ⇒ Boolean): AbstractPersistentView
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to Ensuring[AbstractPersistentView] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractPersistentView
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to Ensuring[AbstractPersistentView] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): AbstractPersistentView
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to Ensuring[AbstractPersistentView] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to StringFormat[AbstractPersistentView] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  28. def getContext(): AbstractActorContext

    Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Definition Classes
    AbstractActor
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isPersistent: Boolean

    If true, the currently processed message was persisted (is sent from the Journal).

    If true, the currently processed message was persisted (is sent from the Journal). If false, the currently processed message comes from another actor (from "user-land").

    Definition Classes
    PersistentView
  32. def journalPluginId: String

    Configuration id of the journal plugin servicing this persistent actor or view.

    Configuration id of the journal plugin servicing this persistent actor or view. When empty, looks in akka.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

    Definition Classes
    PersistenceIdentity
  33. def lastSequenceNr: Long

    Highest received sequence number so far or 0L if this actor hasn't replayed any persistent events yet.

    Highest received sequence number so far or 0L if this actor hasn't replayed any persistent events yet.

    Definition Classes
    PersistentView
  34. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

    Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

    Definition Classes
    Snapshotter
  35. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  39. def onReplayError(cause: Throwable): Unit

    Called whenever a message replay fails.

    Called whenever a message replay fails. By default it logs the error. Subclass may override to customize logging. The PersistentView will not stop or throw exception due to this. It will try again on next update.

    Attributes
    protected
    Definition Classes
    PersistentView
  40. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  41. def postStop(): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.

    Definition Classes
    PersistentViewUnrestrictedStashActor
  42. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    PersistentViewUnrestrictedStashActor
  43. def preStart(): Unit

    Triggers an initial recovery, starting form a snapshot, if any, and replaying at most autoUpdateReplayMax messages (following that snapshot).

    Triggers an initial recovery, starting form a snapshot, if any, and replaying at most autoUpdateReplayMax messages (following that snapshot).

    Definition Classes
    PersistentViewActor
  44. def receive: actor.Actor.Receive

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    AbstractActorActor
  45. def receive(receive: Receive): Unit

    Set up the initial receive behavior of the Actor.

    Set up the initial receive behavior of the Actor.

    receive

    The receive behavior.

    Attributes
    protected
    Definition Classes
    AbstractActor
    Annotations
    @throws( classOf[IllegalActorStateException] )
  46. def recovery: Recovery

    Called when the persistent actor is started for the first time.

    Called when the persistent actor is started for the first time. The returned Recovery object defines how the Actor will recover its persistent state before handling the first incoming message.

    To skip recovery completely return Recovery.none.

    Definition Classes
    PersistentViewPersistenceRecovery
  47. def saveSnapshot(snapshot: Any): Unit

    Saves a snapshot of this snapshotter's state.

    Saves a snapshot of this snapshotter's state.

    The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.

    Definition Classes
    Snapshotter
  48. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself:

    self ! message
    

    Definition Classes
    Actor
  49. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  50. def snapshotPluginId: String

    Configuration id of the snapshot plugin servicing this persistent actor or view.

    Configuration id of the snapshot plugin servicing this persistent actor or view. When empty, looks in akka.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

    Definition Classes
    PersistenceIdentity
  51. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    PersistentViewSnapshotter
  52. def snapshotterId: String

    Returns viewId.

    Returns viewId.

    Definition Classes
    PersistentViewSnapshotter
  53. def stash(): Unit

    Adds the current message (the message that the actor received last) to the actor's stash.

    Adds the current message (the message that the actor received last) to the actor's stash.

    Definition Classes
    StashSupport
    Exceptions thrown

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  54. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    Actor
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Actor
  58. def unstashAll(): Unit

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.

    The stash is guaranteed to be empty after calling unstashAll().

    Definition Classes
    StashSupport
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. def [B](y: B): (AbstractPersistentView, B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentView to ArrowAssoc[AbstractPersistentView] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from PersistentView

Inherited from ActorLogging

Inherited from PersistenceRecovery

Inherited from PersistenceIdentity

Inherited from StashFactory

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from AbstractActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped