akka.persistence

Interface Snapshotter

All Superinterfaces:

Actor

All Known Subinterfaces:

AtLeastOnceDelivery, AtLeastOnceDeliveryLike, Eventsourced, PersistentActor, PersistentFSM<S,D,E>, PersistentView

All Known Implementing Classes:

AbstractPersistentActor, AbstractPersistentActorWithAtLeastOnceDelivery, AbstractPersistentFSM, AbstractPersistentLoggingFSM, AbstractPersistentView, JournalPerfSpec.BenchActor, PersistentShard, PersistentShardCoordinator, RemoveInternalClusterShardingData.RemoveOnePersistenceId, UntypedPersistentActor, UntypedPersistentActorWithAtLeastOnceDelivery, UntypedPersistentView

public interface Snapshotter
extends Actor

Snapshot API on top of the internal snapshot protocol.

Nested Class Summary

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Method Summary

Modifier and Type	Method and Description
void	deleteSnapshot(long sequenceNr) Deletes the snapshot identified by sequenceNr.
void	deleteSnapshots(SnapshotSelectionCriteria criteria) Deletes all snapshots matching criteria.
void	loadSnapshot(java.lang.String persistenceId, SnapshotSelectionCriteria criteria, long toSequenceNr) Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.
void	saveSnapshot(java.lang.Object snapshot) Saves a snapshot of this snapshotter's state.
long	snapshotSequenceNr() Sequence number to use when taking a snapshot.
ActorRef	snapshotStore() Snapshot store plugin actor.
java.lang.String	snapshotterId() Snapshotter id.

Methods inherited from interface akka.actor.Actor

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

Method Detail

snapshotStore

ActorRef snapshotStore()

Snapshot store plugin actor.

snapshotterId

java.lang.String snapshotterId()

Snapshotter id.

Returns:

(undocumented)

snapshotSequenceNr

long snapshotSequenceNr()

Sequence number to use when taking a snapshot.

Returns:

(undocumented)

loadSnapshot

void loadSnapshot(java.lang.String persistenceId,
                  SnapshotSelectionCriteria criteria,
                  long toSequenceNr)

Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

Parameters:

persistenceId - (undocumented)

criteria - (undocumented)

toSequenceNr - (undocumented)

saveSnapshot

void saveSnapshot(java.lang.Object snapshot)

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.

Parameters:

snapshot - (undocumented)

deleteSnapshot

void deleteSnapshot(long sequenceNr)

Deletes the snapshot identified by sequenceNr.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

Parameters:

sequenceNr - (undocumented)

deleteSnapshots

void deleteSnapshots(SnapshotSelectionCriteria criteria)

Deletes all snapshots matching criteria.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

Parameters:

criteria - (undocumented)