abstract class UntypedPersistentView extends UntypedActor with PersistentView
Java API.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) use Persistence Query instead
- Source
- PersistentView.scala
- See also
- Alphabetic
- By Inheritance
- UntypedPersistentView
- PersistentView
- ActorLogging
- PersistenceRecovery
- PersistenceIdentity
- StashFactory
- Stash
- RequiresMessageQueue
- UnrestrictedStash
- StashSupport
- Snapshotter
- UntypedActor
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new UntypedPersistentView()
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Abstract Value Members
-
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[Throwable] )
-
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
-
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
thanpersistenceId
, 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to any2stringadd[UntypedPersistentView] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (UntypedPersistentView, B)
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to ArrowAssoc[UntypedPersistentView] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
aroundPostRestart(reason: Throwable): Unit
Can be overridden to intercept calls to
postRestart
. -
def
aroundPostStop(): Unit
Can be overridden to intercept calls to
postStop
. -
def
aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
Can be overridden to intercept calls to
preRestart
. -
def
aroundPreStart(): Unit
INTERNAL API.
INTERNAL API.
- Attributes
- protected[akka]
- Definition Classes
- PersistentView → Actor
-
def
aroundReceive(receive: Receive, message: Any): Unit
INTERNAL API.
INTERNAL API.
- receive
current behavior.
- Attributes
- protected[akka]
- Definition Classes
- PersistentView → Actor
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
autoUpdate: Boolean
If
true
, this view automatically updates itself with an interval specified byautoUpdateInterval
.If
true
, this view automatically updates itself with an interval specified byautoUpdateInterval
. Iffalse
, applications must explicitly update this view by sending Update requests. The default value can be configured with theakka.persistence.view.auto-update
configuration key. This method can be overridden by implementation classes to return non-default values.- Definition Classes
- PersistentView
-
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
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
-
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
-
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
-
def
ensuring(cond: (UntypedPersistentView) ⇒ Boolean, msg: ⇒ Any): UntypedPersistentView
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (UntypedPersistentView) ⇒ Boolean): UntypedPersistentView
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): UntypedPersistentView
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): UntypedPersistentView
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to Ensuring[UntypedPersistentView] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to StringFormat[UntypedPersistentView] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
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
-
def
getSelf(): ActorRef
Returns the ActorRef for this actor.
Returns the ActorRef for this actor.
- Definition Classes
- UntypedActor
-
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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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). Iffalse
, the currently processed message comes from another actor (from "user-land").- Definition Classes
- PersistentView
-
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, usesjournalPluginId
as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such asclass
. Seesrc/main/resources/reference.conf
.- Definition Classes
- PersistenceIdentity
-
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
-
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
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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
-
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
- UntypedActor → Actor
- Annotations
- @throws( classOf[Exception] )
-
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
- PersistentView → UnrestrictedStash → Actor
-
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
- PersistentView → UnrestrictedStash → Actor
-
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
- PersistentView → Actor
-
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
- UntypedActor → Actor
-
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
- PersistentView → PersistenceRecovery
-
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
-
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
-
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
-
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, usessnapshotPluginId
as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such asclass
. Seesrc/main/resources/reference.conf
.- Definition Classes
- PersistenceIdentity
-
def
snapshotSequenceNr: Long
Returns
lastSequenceNr
.Returns
lastSequenceNr
.- Definition Classes
- PersistentView → Snapshotter
-
def
snapshotterId: String
Returns
viewId
.Returns
viewId
.- Definition Classes
- PersistentView → Snapshotter
-
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 onceStashOverflowException
in case of a stash capacity violation
-
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
- UntypedActor → Actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unhandled(message: Any): Unit
Recommended convention is to call this method if the message isn't handled in #onReceive (e.g.
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
- UntypedActor → Actor
-
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
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (UntypedPersistentView, B)
- Implicit
- This member is added by an implicit conversion from UntypedPersistentView to ArrowAssoc[UntypedPersistentView] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc