akka.persistence

UntypedPersistentView

abstract class UntypedPersistentView extends UntypedActor with PersistentView

Java API.

Source
PersistentView.scala
See also

PersistentView

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UntypedPersistentView
  2. PersistentView
  3. Recovery
  4. StashFactory
  5. Stash
  6. RequiresMessageQueue
  7. UnrestrictedStash
  8. StashSupport
  9. Snapshotter
  10. UntypedActor
  11. Actor
  12. AnyRef
  13. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UntypedPersistentView()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. abstract def onReceive(message: Any): Unit

    To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.

    To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.

    Definition Classes
    UntypedActor
    Annotations
    @throws( classOf[Exception] )
  2. 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
    Recovery
  3. 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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (UntypedPersistentView, B)

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to ArrowAssoc[UntypedPersistentView] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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
  9. 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
  10. 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
  11. def aroundPreStart(): Unit

    Can be overridden to intercept calls to preStart.

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

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

    INTERNAL API.

    INTERNAL API.

    receive

    current behavior.

    Attributes
    protected[akka]
    Definition Classes
    RecoveryActor
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. 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
  15. 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
  16. 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
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. 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
  19. def deleteSnapshot(sequenceNr: Long, timestamp: Long): Unit

    Deletes a snapshot identified by sequenceNr and timestamp.

    Deletes a snapshot identified by sequenceNr and timestamp.

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

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    Definition Classes
    Snapshotter
  21. def ensuring(cond: (UntypedPersistentView) ⇒ Boolean, msg: ⇒ Any): UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (UntypedPersistentView) ⇒ Boolean): UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. def getContext(): UntypedActorContext

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

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

    Definition Classes
    UntypedActor
  31. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Definition Classes
    UntypedActor
  32. def getSender(): ActorRef

    The reference sender Actor of the currently processed message.

    The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

    Definition Classes
    UntypedActor
  33. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  35. 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
  36. def lastSequenceNr: Long

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet.

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet. Usually equal to the sequence number of currentPersistentMessage (unless a receiver implementation is about to re-order persistent messages using stash() and unstash()).

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

    Definition Classes
    Snapshotter
  38. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  41. def postRestart(reason: Throwable): Unit

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

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

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

    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
    UntypedActorActor
    Annotations
    @throws( classOf[Exception] )
  42. 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
  43. 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
  44. 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
  45. final def receive: PartialFunction[Any, Unit]

    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
    UntypedActorActor
  46. def saveSnapshot(snapshot: Any): Unit

    Saves a snapshot of this snapshotter's state.

    Saves a snapshot of this snapshotter's state. If saving succeeds, this snapshotter will receive a SaveSnapshotSuccess message, otherwise a SaveSnapshotFailure message.

    Definition Classes
    Snapshotter
  47. 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
  48. 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
  49. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    RecoverySnapshotter
  50. def snapshotterId: String

    Returns viewId.

    Returns viewId.

    Definition Classes
    PersistentViewSnapshotter
  51. 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

  52. 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
    UntypedActorActor
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  54. def toString(): String

    Definition Classes
    AnyRef → Any
  55. def unhandled(message: Any): Unit

    Recommended convention is to call this method if the message isn't handled in #onReceive (e.

    Recommended convention is to call this method if the message isn't handled in #onReceive (e.g. unknown message type). 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
    UntypedActorActor
  56. 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
  57. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def [B](y: B): (UntypedPersistentView, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedPersistentView: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedPersistentView: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. implicit def currentPersistentMessage: Option[Persistent]

    Returns the current persistent message if there is any.

    Returns the current persistent message if there is any.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) currentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  2. def getCurrentPersistentMessage: Persistent

    Java API: returns the current persistent message or null if there is none.

    Java API: returns the current persistent message or null if there is none.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) getCurrentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  3. def processorId: String

    Id of the processor for which messages should be replayed.

    Id of the processor for which messages should be replayed.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) Override persistenceId instead. Processor will be removed.

  4. def x: UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to ArrowAssoc[UntypedPersistentView] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (untypedPersistentView: ArrowAssoc[UntypedPersistentView]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  5. def x: UntypedPersistentView

    Implicit information
    This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (untypedPersistentView: Ensuring[UntypedPersistentView]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from PersistentView

Inherited from Recovery

Inherited from StashFactory

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from UntypedActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UntypedPersistentView to StringAdd

Inherited by implicit conversion any2stringfmt from UntypedPersistentView to StringFormat

Inherited by implicit conversion any2ArrowAssoc from UntypedPersistentView to ArrowAssoc[UntypedPersistentView]

Inherited by implicit conversion any2Ensuring from UntypedPersistentView to Ensuring[UntypedPersistentView]

Ungrouped