akka.persistence.fsm

Interface PersistentFSM<S extends PersistentFSM.FSMState,D,E>

All Superinterfaces:

Actor, ActorLogging, Eventsourced, Listeners, PersistenceIdentity, PersistenceRecovery, PersistenceStash, PersistentActor, PersistentFSMBase<S,D,E>, RequiresMessageQueue<DequeBasedMessageQueueSemantics>, Snapshotter, Stash, StashFactory, StashSupport, UnrestrictedStash

All Known Implementing Classes:

AbstractPersistentFSM, AbstractPersistentLoggingFSM

public interface PersistentFSM<S extends PersistentFSM.FSMState,D,E>
extends PersistentActor, PersistentFSMBase<S,D,E>, ActorLogging

A FSM implementation with persistent state.

Supports the usual FSM functionality with additional persistence features. PersistentFSM is identified by 'persistenceId' value. State changes are persisted atomically together with domain events, which means that either both succeed or both fail, i.e. a state transition event will not be stored if persistence of an event related to that change fails. Persistence execution order is: persist -&gt; wait for ack -&gt; apply state. Incoming messages are deferred until the state is applied. State Data is constructed based on domain events, according to user's implementation of applyEvent function.

This is an EXPERIMENTAL feature and is subject to change until it has received more real world testing.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PersistentFSM.$minus$greater$ This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
static class	PersistentFSM.CurrentState<S> Message type which is sent directly to the subscribed actor in FSM.SubscribeTransitionCallBack before sending any FSM.Transition messages.
static class	PersistentFSM.CurrentState$
static class	PersistentFSM.Event<D> All messages sent to the FSM will be wrapped inside an Event, which allows pattern matching to extract both state and data.
static class	PersistentFSM.Event$
static class	PersistentFSM.Failure Signifies that the FSM is shutting itself down because of an error, e.g.
static class	PersistentFSM.Failure$
static interface	PersistentFSM.FSMState FSMState base trait, makes possible for simple default serialization by conversion to String
static class	PersistentFSM.LogEntry<S,D> Log Entry of the LoggingFSM, can be obtained by calling getLog.
static class	PersistentFSM.LogEntry$
static class	PersistentFSM.Normal$ Default reason if calling stop().
static class	PersistentFSM.NullFunction$ A partial function value which does not match anything and can be used to &ldquo;reset&rdquo; whenUnhandled and onTermination handlers.
static interface	PersistentFSM.PersistentFsmEvent Base persistent event class
static class	PersistentFSM.PersistentFSMSnapshot<D> FSM state and data snapshot
static class	PersistentFSM.PersistentFSMSnapshot$
static interface	PersistentFSM.Reason Reason why this FSM is shutting down.
static class	PersistentFSM.Shutdown$ Reason given when someone was calling system.stop(fsm) from outside; also applies to Stop supervision directive.
static class	PersistentFSM.State<S,D,E> This captures all of the managed state of the FSM: the state name, the state data, possibly custom timeout, stop reason, replies accumulated while processing the last message, possibly domain event and handler to be executed after FSM moves to the new state (also triggered when staying in the same state)
static class	PersistentFSM.State$
static class	PersistentFSM.StateChangeEvent Persisted on state change
static class	PersistentFSM.StateChangeEvent$
static class	PersistentFSM.StateTimeout$ This case object is received in case of a state timeout.
static class	PersistentFSM.StopEvent<S,D> Case class representing the state of the FSM whithin the onTermination block.
static class	PersistentFSM.StopEvent$
static class	PersistentFSM.SubscribeTransitionCallBack Send this to an FSM to request first the PersistentFSM.CurrentState and then a series of PersistentFSM.Transition updates.
static class	PersistentFSM.SubscribeTransitionCallBack$
static class	PersistentFSM.TimeoutMarker INTERNAL API
static class	PersistentFSM.TimeoutMarker$
static class	PersistentFSM.Timer INTERNAL API
static class	PersistentFSM.Timer$
static class	PersistentFSM.Transition<S> Message type which is used to communicate transitions between states to all subscribed listeners (use FSM.SubscribeTransitionCallBack).
static class	PersistentFSM.Transition$
static class	PersistentFSM.UnsubscribeTransitionCallBack Unsubscribe from FSM.Transition notifications which was effected by sending the corresponding FSM.SubscribeTransitionCallBack.
static class	PersistentFSM.UnsubscribeTransitionCallBack$

Nested classes/interfaces inherited from interface akka.persistence.Eventsourced

Eventsourced.AsyncHandlerInvocation, Eventsourced.AsyncHandlerInvocation$, Eventsourced.PendingHandlerInvocation, Eventsourced.RecoveryTick, Eventsourced.RecoveryTick$, Eventsourced.StashingHandlerInvocation, Eventsourced.StashingHandlerInvocation$

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Nested classes/interfaces inherited from interface akka.persistence.fsm.PersistentFSMBase

PersistentFSMBase.TransformHelper

Method Summary

Modifier and Type	Method and Description
D	applyEvent(E domainEvent, D currentData) Override this handler to define the action on Domain Event
void	applyState(PersistentFSM.State<S,D,E> nextState) Persist FSM State and FSM State Data
scala.reflect.ClassTag<E>	domainEventClassTag() Enables to pass a ClassTag of a domain event base type from the implementing class
scala.reflect.ClassTag<E>	domainEventTag() Domain event's ClassTag Used for identifying domain events during recovery
void	onRecoveryCompleted() Override this handler to define the action on recovery completion
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveCommand() After recovery events are handled as in usual FSM actor
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveRecover() Discover the latest recorded state
void	saveStateSnapshot() Save the current state as a snapshot
scala.collection.immutable.Map<java.lang.String,S>	statesMap() Map from state identifier to state instance

Methods inherited from interface akka.persistence.PersistentActor

receive

Methods inherited from interface akka.persistence.Eventsourced

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, changeState, deferAsync, deleteMessages, flushBatch, flushJournalBatch, journal, lastSequenceNr, log, nextSequenceNr, onPersistFailure, onPersistRejected, onRecoveryFailure, onReplaySuccess, peekApplyHandler, persist, persist, persistAll, persistAllAsync, persistAsync, persistAsync, recovering, recoveryFinished, recoveryRunning, recoveryStarted, requestRecoveryPermit, setLastSequenceNr, snapshotSequenceNr, snapshotStore, snapshotterId, startRecovery, stashInternally, unhandled, unstashAll, unstashInternally, updateLastSequenceNr, waitingRecoveryPermit

Methods inherited from interface akka.persistence.Snapshotter

deleteSnapshot, deleteSnapshots, loadSnapshot, saveSnapshot

Methods inherited from interface akka.persistence.PersistenceStash

internalStashOverflowStrategy

Methods inherited from interface akka.actor.Actor

context, postRestart, preStart, self, sender, supervisorStrategy

Methods inherited from interface akka.actor.StashSupport

actorCell, clearStash, context, enqueueFirst, mailbox, prepend, self, stash, unstash, unstashAll

Methods inherited from interface akka.actor.StashFactory

createStash

Methods inherited from interface akka.persistence.PersistenceIdentity

journalPluginId, persistenceId, snapshotPluginId

Methods inherited from interface akka.persistence.PersistenceRecovery

recovery

Methods inherited from interface akka.persistence.fsm.PersistentFSMBase

cancelTimer, debugEvent, Event, handleTransition, initialize, isStateTimerActive, isTimerActive, logTermination, makeTransition, nextStateData, onTermination, onTransition, postStop, processEvent, processMsg, receive, register, setStateTimeout, setTimer, startWith, stateData, stateName, stateNames, StateTimeout, stay, stop, stop, stop, StopEvent, terminate, total2pf, transform, when, whenUnhandled

Methods inherited from interface akka.routing.Listeners

gossip, listenerManagement, listeners

Methods inherited from interface akka.actor.ActorLogging

log

Method Detail

domainEventClassTag

scala.reflect.ClassTag<E> domainEventClassTag()

Enables to pass a ClassTag of a domain event base type from the implementing class

Returns:

ClassTag of domain event base type

domainEventTag

scala.reflect.ClassTag<E> domainEventTag()

Domain event's ClassTag Used for identifying domain events during recovery

Returns:

(undocumented)

statesMap

scala.collection.immutable.Map<java.lang.String,S> statesMap()

Map from state identifier to state instance

Returns:

(undocumented)

applyEvent

D applyEvent(E domainEvent,
             D currentData)

Override this handler to define the action on Domain Event

Parameters:

domainEvent - domain event to apply

currentData - state data of the previous state

Returns:

updated state data

onRecoveryCompleted

void onRecoveryCompleted()

Override this handler to define the action on recovery completion

saveStateSnapshot

void saveStateSnapshot()

Save the current state as a snapshot

receiveCommand

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveCommand()

After recovery events are handled as in usual FSM actor

Specified by:

receiveCommand in interface Eventsourced

Returns:

(undocumented)

receiveRecover

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveRecover()

Discover the latest recorded state

Specified by:

receiveRecover in interface Eventsourced

Returns:

(undocumented)

See Also:

Recovery

applyState

void applyState(PersistentFSM.State<S,D,E> nextState)

Persist FSM State and FSM State Data

Specified by:

applyState in interface PersistentFSMBase<S extends PersistentFSM.FSMState,D,E>

Parameters:

nextState - (undocumented)