akka.persistence

UntypedProcessor

abstract class UntypedProcessor extends UntypedActor with Processor

Java API: an actor that persists (journals) messages of type Persistent. Messages of other types are not persisted.

import akka.persistence.Persistent;
import akka.persistence.Processor;

class MyProcessor extends UntypedProcessor {
    public void onReceive(Object message) throws Exception {
        if (message instanceof Persistent) {
            // message has been written to journal
            Persistent persistent = (Persistent)message;
            Object payload = persistent.payload();
            Long sequenceNr = persistent.sequenceNr();
            // ...
        } else {
            // message has not been written to journal
        }
    }
}

// ...

ActorRef processor = getContext().actorOf(Props.create(MyProcessor.class), "myProcessor");

processor.tell(Persistent.create("foo"), null);
processor.tell("bar", null);

During start and restart, persistent messages are replayed to a processor so that it can recover internal state from these messages. New messages sent to a processor during recovery do not interfere with replayed messages, hence applications don't need to wait for a processor to complete its recovery.

Automated recovery can be turned off or customized by overriding the preStart and preRestart life cycle hooks. If automated recovery is turned off, an application can explicitly recover a processor by sending it a Recover message.

Persistent messages are assigned sequence numbers that are generated on a per-processor basis. A sequence starts at 1L and doesn't contain gaps unless a processor (logically) deletes a message.

During recovery, a processor internally buffers new messages until recovery completes, so that new messages do not interfere with replayed messages. This internal buffer (the processor stash) is isolated from the user stash inherited by akka.actor.Stash. Processor implementation classes can therefore use the user stash for stashing/unstashing both persistent and transient messages.

Processors can also store snapshots of internal state by calling saveSnapshot. During recovery, a saved snapshot is offered to the processor with a SnapshotOffer message, followed by replayed messages, if any, that are younger than the snapshot. Default is to offer the latest saved snapshot.

Annotations
@deprecated
Deprecated

(Since version 2.3.4) UntypedProcessor will be removed. Instead extend akka.persistence.UntypedPersistentActor and use it's persistAsync(command)(callback) method to get equivalent semantics.

Source
Processor.scala
See also

PersistentBatch

Recover

Processor

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UntypedProcessor
  2. Processor
  3. ProcessorImpl
  4. Recovery
  5. StashFactory
  6. Stash
  7. RequiresMessageQueue
  8. UnrestrictedStash
  9. StashSupport
  10. Snapshotter
  11. UntypedActor
  12. Actor
  13. AnyRef
  14. 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 UntypedProcessor()

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] )

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 UntypedProcessor to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (UntypedProcessor, B)

    Implicit information
    This member is added by an implicit conversion from UntypedProcessor to ArrowAssoc[UntypedProcessor] 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

    INTERNAL API.

    INTERNAL API.

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

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    ProcessorImpl → Actor
  11. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    ProcessorImpl → 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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. 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
  16. def deleteMessages(toSequenceNr: Long, permanent: Boolean): Unit

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr. If permanent is set to false, the persistent messages are marked as deleted in the journal, otherwise they permanently deleted from the journal.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
  17. def deleteMessages(toSequenceNr: Long): Unit

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    Definition Classes
    ProcessorImpl
  18. 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
  19. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    Definition Classes
    Snapshotter
  20. def ensuring(cond: (UntypedProcessor) ⇒ Boolean, msg: ⇒ Any): UntypedProcessor

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  29. 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
  30. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Definition Classes
    UntypedActor
  31. 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
  32. def hashCode(): Int

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

    Definition Classes
    Any
  34. 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
  35. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Definition Classes
    Snapshotter
  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 persistenceId: String

    Persistence id.

    Persistence id. Defaults to this persistent-actors's path and can be overridden.

    Definition Classes
    ProcessorRecovery
  40. 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] )
  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
    UnrestrictedStashActor
  42. def preRestart(reason: Throwable, message: Option[Any]): Unit

    User-overridable callback.

    User-overridable callback. Called before a processor is restarted. Default implementation sends a Recover(lastSequenceNr) message to self if message is defined, Recover() otherwise.

    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
    ProcessorImpl → UnrestrictedStashActor
  43. def preRestartDefault(reason: Throwable, message: Option[Any]): Unit

    Calls preRestart and then super.preRestart().

    Calls preRestart and then super.preRestart(). If processor implementation classes want to opt out from stopping child actors, they should override this method and call preRestart only.

    Definition Classes
    ProcessorImpl
  44. def preStart(): Unit

    User-overridable callback.

    User-overridable callback. Called when a processor is started. Default implementation sends a Recover() to self.

    Definition Classes
    ProcessorImpl → Actor
    Annotations
    @throws( classOf[Exception] )
  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 recoveryFinished: Boolean

    Returns true if this processor has successfully finished recovery.

    Returns true if this processor has successfully finished recovery.

    Definition Classes
    ProcessorImpl
  47. def recoveryRunning: Boolean

    Returns true if this processor is currently recovering.

    Returns true if this processor is currently recovering.

    Definition Classes
    ProcessorImpl
  48. 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
  49. 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
  50. 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
  51. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    RecoverySnapshotter
  52. def snapshotterId: String

    Returns persistenceId.

    Returns persistenceId.

    Definition Classes
    ProcessorImpl → Snapshotter
  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
    UntypedActorActor
  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
    ProcessorImpl → 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): (UntypedProcessor, B)

    Implicit information
    This member is added by an implicit conversion from UntypedProcessor to ArrowAssoc[UntypedProcessor] 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 UntypedProcessor 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:
    (untypedProcessor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedProcessor 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:
    (untypedProcessor: 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 deleteMessage(sequenceNr: Long, permanent: Boolean): Unit

    Deletes a persistent message identified by sequenceNr.

    Deletes a persistent message identified by sequenceNr. If permanent is set to false, the persistent message is marked as deleted in the journal, otherwise it is permanently deleted from the journal. A deleted message is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

  3. def deleteMessage(sequenceNr: Long): Unit

    Marks a persistent message, identified by sequenceNr, as deleted.

    Marks a persistent message, identified by sequenceNr, as deleted. A message marked as deleted is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

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

  5. def processorId: String

    Processor id.

    Processor id. Defaults to this processor's path and can be overridden.

    Definition Classes
    ProcessorImpl → Recovery
    Annotations
    @deprecated
    Deprecated

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

  6. def x: UntypedProcessor

    Implicit information
    This member is added by an implicit conversion from UntypedProcessor to ArrowAssoc[UntypedProcessor] 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:
    (untypedProcessor: ArrowAssoc[UntypedProcessor]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  7. def x: UntypedProcessor

    Implicit information
    This member is added by an implicit conversion from UntypedProcessor to Ensuring[UntypedProcessor] 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:
    (untypedProcessor: Ensuring[UntypedProcessor]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Processor

Inherited from ProcessorImpl

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 UntypedProcessor to StringAdd

Inherited by implicit conversion any2stringfmt from UntypedProcessor to StringFormat

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

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

Ungrouped