akka.persistence.snapshot.japi
Class SnapshotStore

java.lang.Object
  extended by akka.persistence.snapshot.japi.SnapshotStore
All Implemented Interfaces:
Actor, SnapshotStore

public abstract class SnapshotStore
extends java.lang.Object
implements SnapshotStore

Java API: abstract snapshot store.


Nested Class Summary
 
Nested classes/interfaces inherited from interface akka.actor.Actor
Actor.emptyBehavior$
 
Constructor Summary
SnapshotStore()
           
 
Method Summary
 void delete(SnapshotMetadata metadata)
          Plugin API: deletes the snapshot identified by metadata.
 void delete(java.lang.String persistenceId, SnapshotSelectionCriteria criteria)
          Plugin API: deletes all snapshots matching criteria.
 void doDelete(SnapshotMetadata metadata)
          Java API, Plugin API: deletes the snapshot identified by `metadata`.
 void doDelete(java.lang.String persistenceId, SnapshotSelectionCriteria criteria)
          Java API, Plugin API: deletes all snapshots matching `criteria`.
 scala.concurrent.Future<Option<SelectedSnapshot>> doLoadAsync(java.lang.String persistenceId, SnapshotSelectionCriteria criteria)
          Java API, Plugin API: asynchronously loads a snapshot.
 scala.concurrent.Future<java.lang.Void> doSaveAsync(SnapshotMetadata metadata, java.lang.Object snapshot)
          Java API, Plugin API: asynchronously saves a snapshot.
 scala.concurrent.Future<scala.Option<SelectedSnapshot>> loadAsync(java.lang.String persistenceId, SnapshotSelectionCriteria criteria)
          Plugin API: asynchronously loads a snapshot.
 void onSaved(SnapshotMetadata metadata)
          Java API, Plugin API: called after successful saving of a snapshot.
 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface akka.persistence.snapshot.SnapshotStore
extension, publish, receive
 
Methods inherited from interface akka.actor.Actor
aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, postRestart, postStop, preRestart, preStart, self, sender, supervisorStrategy, unhandled
 

Constructor Detail

SnapshotStore

public SnapshotStore()
Method Detail

loadAsync

public final scala.concurrent.Future<scala.Option<SelectedSnapshot>> loadAsync(java.lang.String persistenceId,
                                                                               SnapshotSelectionCriteria criteria)
Description copied from interface: SnapshotStore
Plugin API: asynchronously loads a snapshot.

Specified by:
loadAsync in interface SnapshotStore
Parameters:
persistenceId - processor id.
criteria - selection criteria for loading.
Returns:
(undocumented)

saveAsync

public final scala.concurrent.Future<scala.runtime.BoxedUnit> saveAsync(SnapshotMetadata metadata,
                                                                        java.lang.Object snapshot)
Description copied from interface: SnapshotStore
Plugin API: asynchronously saves a snapshot.

Specified by:
saveAsync in interface SnapshotStore
Parameters:
metadata - snapshot metadata.
snapshot - snapshot.
Returns:
(undocumented)

saved

public final void saved(SnapshotMetadata metadata)
Description copied from interface: SnapshotStore
Plugin API: called after successful saving of a snapshot.

Specified by:
saved in interface SnapshotStore
Parameters:
metadata - snapshot metadata.

delete

public final void delete(SnapshotMetadata metadata)
Description copied from interface: SnapshotStore
Plugin API: deletes the snapshot identified by metadata.

Specified by:
delete in interface SnapshotStore
Parameters:
metadata - snapshot metadata.

delete

public final void delete(java.lang.String persistenceId,
                         SnapshotSelectionCriteria criteria)
Description copied from interface: SnapshotStore
Plugin API: deletes all snapshots matching criteria.

Specified by:
delete in interface SnapshotStore
Parameters:
persistenceId - processor id.
criteria - selection criteria for deleting.

doLoadAsync

public scala.concurrent.Future<Option<SelectedSnapshot>> doLoadAsync(java.lang.String persistenceId,
                                                                     SnapshotSelectionCriteria criteria)
Java API, Plugin API: asynchronously loads a snapshot.

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

doSaveAsync

public scala.concurrent.Future<java.lang.Void> doSaveAsync(SnapshotMetadata metadata,
                                                           java.lang.Object snapshot)
Java API, Plugin API: asynchronously saves a snapshot.

Parameters:
metadata - snapshot metadata.
snapshot - snapshot.

onSaved

public void onSaved(SnapshotMetadata metadata)
             throws java.lang.Exception
Java API, Plugin API: called after successful saving of a snapshot.

Parameters:
metadata - snapshot metadata.
Throws:
java.lang.Exception

doDelete

public void doDelete(SnapshotMetadata metadata)
              throws java.lang.Exception
Java API, Plugin API: deletes the snapshot identified by `metadata`.

Parameters:
metadata - snapshot metadata.
Throws:
java.lang.Exception

doDelete

public void doDelete(java.lang.String persistenceId,
                     SnapshotSelectionCriteria criteria)
              throws java.lang.Exception
Java API, Plugin API: deletes all snapshots matching `criteria`.

Parameters:
persistenceId - processor id.
criteria - selection criteria for deleting.
Throws:
java.lang.Exception