Package akka.persistence.snapshot.japi

Class SnapshotStore

java.lang.Object

akka.persistence.snapshot.japi.SnapshotStore

All Implemented Interfaces:

Actor, ActorLogging, 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$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor	Description
SnapshotStore()

Method Summary

Modifier and Type	Method	Description
protected void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)	Scala API: Stores the context for this actor, including self, and sender.
protected void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)	The 'self' field holds the ActorRef for this actor.
protected void	akka$persistence$snapshot$SnapshotStore$_setter_$receiveSnapshotStore_$eq(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> x$1)
ActorContext	context()	Scala API: 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<java.lang.Void>	doDeleteAsync(SnapshotMetadata metadata)	Java API, Plugin API: deletes the snapshot identified by `metadata`.
scala.concurrent.Future<java.lang.Void>	doDeleteAsync(java.lang.String persistenceId, SnapshotSelectionCriteria criteria)	Java API, Plugin API: deletes all snapshots matching `criteria`.
scala.concurrent.Future<java.util.Optional<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.
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.actor.Actor

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

Methods inherited from interface akka.actor.ActorLogging

_log_$eq, log

Methods inherited from interface akka.persistence.snapshot.SnapshotStore

receive, receivePluginInternal, senderPersistentActor, tryReceivePluginInternal

Constructor Detail

SnapshotStore

public SnapshotStore()

Method Detail

akka$actor$Actor$_setter_$context_$eq

protected void akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)

Description copied from interface: Actor

Scala API: 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 AbstractActor.ActorContext, which is the Java API of the actor context.

Specified by:

akka$actor$Actor$_setter_$context_$eq in interface Actor

akka$actor$Actor$_setter_$self_$eq

protected final void akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)

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:

akka$actor$Actor$_setter_$self_$eq in interface Actor

akka$persistence$snapshot$SnapshotStore$_setter_$receiveSnapshotStore_$eq

protected final void akka$persistence$snapshot$SnapshotStore$_setter_$receiveSnapshotStore_$eq(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> x$1)

Specified by:

akka$persistence$snapshot$SnapshotStore$_setter_$receiveSnapshotStore_$eq in interface SnapshotStore

context

public ActorContext context()

Description copied from interface: Actor

Scala API: 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 AbstractActor.ActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

deleteAsync

public final 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.

deleteAsync

public final 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.

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.

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.

receiveSnapshotStore

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

Specified by:

receiveSnapshotStore in interface SnapshotStore

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.

This call is protected with a circuit-breaker.

Specified by:

saveAsync in interface SnapshotStore

Parameters:

metadata - snapshot metadata.

snapshot - snapshot.

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

doLoadAsync

public abstract scala.concurrent.Future<java.util.Optional<SelectedSnapshot>> doLoadAsync(java.lang.String persistenceId,
                                                                                          SnapshotSelectionCriteria criteria)

Java API, Plugin API: asynchronously loads a snapshot.

Parameters:

persistenceId - id of the persistent actor.

criteria - selection criteria for loading.

doSaveAsync

public abstract 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.

doDeleteAsync

public abstract scala.concurrent.Future<java.lang.Void> doDeleteAsync(SnapshotMetadata metadata)

Java API, Plugin API: deletes the snapshot identified by `metadata`.

Parameters:

metadata - snapshot metadata.

doDeleteAsync

public abstract scala.concurrent.Future<java.lang.Void> doDeleteAsync(java.lang.String persistenceId,
                                                                      SnapshotSelectionCriteria criteria)

Java API, Plugin API: deletes all snapshots matching `criteria`.

Parameters:

persistenceId - id of the persistent actor.

criteria - selection criteria for deleting.