akka.persistence.snapshot
Interface SnapshotStore

All Superinterfaces:
Actor
All Known Implementing Classes:
SnapshotStore

public interface SnapshotStore
extends Actor

Abstract snapshot store.


Nested Class Summary
 
Nested classes/interfaces inherited from interface akka.actor.Actor
Actor.emptyBehavior$
 
Method Summary
 void delete(SnapshotMetadata metadata)
          Plugin API: deletes the snapshot identified by metadata.
 void delete(java.lang.String processorId, SnapshotSelectionCriteria criteria)
          Plugin API: deletes all snapshots matching criteria.
 Persistence extension()
           
 scala.concurrent.Future<scala.Option<SelectedSnapshot>> loadAsync(java.lang.String processorId, SnapshotSelectionCriteria criteria)
          Plugin API: asynchronously loads a snapshot.
 boolean publish()
           
 scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
          This defines the initial actor behavior, it must return a partial function with the actor logic.
 scala.concurrent.Future<scala.runtime.BoxedUnit> saveAsync(SnapshotMetadata metadata, java.lang.Object snapshot)
          Plugin API: asynchronously saves a snapshot.
 void saved(SnapshotMetadata metadata)
          Plugin API: called after successful saving of a snapshot.
 
Methods inherited from interface akka.actor.Actor
aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, noSender, postRestart, postStop, preRestart, preStart, self, sender, supervisorStrategy, unhandled
 

Method Detail

extension

Persistence extension()

publish

boolean publish()

receive

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
Description copied from interface: Actor
This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:
receive in interface Actor

loadAsync

scala.concurrent.Future<scala.Option<SelectedSnapshot>> loadAsync(java.lang.String processorId,
                                                                  SnapshotSelectionCriteria criteria)
Plugin API: asynchronously loads a snapshot.

Parameters:
processorId - processor id.
criteria - selection criteria for loading.

saveAsync

scala.concurrent.Future<scala.runtime.BoxedUnit> saveAsync(SnapshotMetadata metadata,
                                                           java.lang.Object snapshot)
Plugin API: asynchronously saves a snapshot.

Parameters:
metadata - snapshot metadata.
snapshot - snapshot.

saved

void saved(SnapshotMetadata metadata)
Plugin API: called after successful saving of a snapshot.

Parameters:
metadata - snapshot metadata.

delete

void delete(SnapshotMetadata metadata)
Plugin API: deletes the snapshot identified by metadata.

Parameters:
metadata - snapshot metadata.

delete

void delete(java.lang.String processorId,
            SnapshotSelectionCriteria criteria)
Plugin API: deletes all snapshots matching criteria.

Parameters:
processorId - processor id.
criteria - selection criteria for deleting.