akka.persistence.snapshot

Class NoSnapshotStore

java.lang.Object

akka.persistence.snapshot.NoSnapshotStore

All Implemented Interfaces:

Actor, ActorLogging, SnapshotStore

public final class NoSnapshotStore
extends java.lang.Object
implements SnapshotStore

Used as default snapshot-store in case no other store was configured.

If a PersistentActor calls the Snapshotter.saveSnapshot(java.lang.Object) method, and at the same time does not configure a specific snapshot-store to be used *and* no default snapshot-store is available, then the NoSnapshotStore will be used to signal a snapshot store failure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NoSnapshotStore.NoSnapshotStoreException

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
NoSnapshotStore()

Method Summary

Modifier and Type	Method and Description
ActorContext	context() Stores the context for this actor, including self, and sender.
scala.concurrent.Future<scala.runtime.BoxedUnit>	deleteAsync(SnapshotMetadata metadata) Plugin API: deletes the snapshot identified by metadata.
scala.concurrent.Future<scala.runtime.BoxedUnit>	deleteAsync(java.lang.String persistenceId, SnapshotSelectionCriteria criteria) Plugin API: deletes all snapshots matching criteria.
scala.concurrent.Future<scala.Option<SelectedSnapshot>>	loadAsync(java.lang.String persistenceId, SnapshotSelectionCriteria criteria) Plugin API: asynchronously loads a snapshot.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveSnapshotStore()
scala.concurrent.Future<scala.runtime.BoxedUnit>	saveAsync(SnapshotMetadata metadata, java.lang.Object snapshot) Plugin API: asynchronously saves a snapshot.
ActorRef	self() The 'self' field holds the ActorRef for this actor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.persistence.snapshot.SnapshotStore

receive, receivePluginInternal, senderPersistentActor, tryReceivePluginInternal

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, postStop, preRestart, preStart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

NoSnapshotStore

public NoSnapshotStore()

Method Detail

receiveSnapshotStore

public final scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveSnapshotStore()

Specified by:

receiveSnapshotStore in interface SnapshotStore

context

public ActorContext context()

Description copied from interface: Actor

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!

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

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

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

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

loadAsync

public scala.concurrent.Future<scala.Option<SelectedSnapshot>> loadAsync(java.lang.String persistenceId,
                                                                         SnapshotSelectionCriteria criteria)

Description copied from interface: SnapshotStore

Plugin API: asynchronously loads a snapshot.

If the future Option is None then all events will be replayed, i.e. there was no snapshot. If snapshot could not be loaded the Future should be completed with failure. That is important because events may have been deleted and just replaying the events might not result in a valid state.

This call is protected with a circuit-breaker.

Specified by:

loadAsync in interface SnapshotStore

Parameters:

persistenceId - id of the persistent actor.

criteria - selection criteria for loading.

Returns:

(undocumented)

saveAsync

public scala.concurrent.Future<scala.runtime.BoxedUnit> saveAsync(SnapshotMetadata metadata,
                                                                  java.lang.Object snapshot)

Description copied from interface: SnapshotStore

Plugin API: asynchronously saves a snapshot.

This call is protected with a circuit-breaker.

Specified by:

saveAsync in interface SnapshotStore

Parameters:

metadata - snapshot metadata.

snapshot - snapshot.

Returns:

(undocumented)

deleteAsync

public scala.concurrent.Future<scala.runtime.BoxedUnit> deleteAsync(SnapshotMetadata metadata)

Description copied from interface: SnapshotStore

Plugin API: deletes the snapshot identified by metadata.

This call is protected with a circuit-breaker.

Specified by:

deleteAsync in interface SnapshotStore

Parameters:

metadata - snapshot metadata.

Returns:

(undocumented)

deleteAsync

public scala.concurrent.Future<scala.runtime.BoxedUnit> deleteAsync(java.lang.String persistenceId,
                                                                    SnapshotSelectionCriteria criteria)

Description copied from interface: SnapshotStore

Plugin API: deletes all snapshots matching criteria.

This call is protected with a circuit-breaker.

Specified by:

deleteAsync in interface SnapshotStore

Parameters:

persistenceId - id of the persistent actor.

criteria - selection criteria for deleting.

Returns:

(undocumented)