Package org.apache.pekko.persistence.testkit

Class PersistenceTestKitSnapshotPlugin

  • All Implemented Interfaces:
    Actor, ActorLogging, SnapshotStore
    public class PersistenceTestKitSnapshotPlugin
extends java.lang.Object
implements SnapshotStore
    INTERNAL API

    Persistence testkit plugin for snapshots.

    • Constructor Detail

      • PersistenceTestKitSnapshotPlugin

        public PersistenceTestKitSnapshotPlugin​(com.typesafe.config.Config cfg,
                                        java.lang.String cfgPath)

    • Method Detail

      • PluginId

        public static java.lang.String PluginId()

      • config

        public static com.typesafe.config.Config config()

      • 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
        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!

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

        Specified by:
        context in interface Actor

      • 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

      • org$apache$pekko$actor$Actor$_setter_$context_$eq

        protected void org$apache$pekko$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!

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

        Specified by:
        org$apache$pekko$actor$Actor$_setter_$context_$eq in interface Actor

      • org$apache$pekko$actor$Actor$_setter_$self_$eq

        protected final void org$apache$pekko$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:
        org$apache$pekko$actor$Actor$_setter_$self_$eq in interface Actor

      • 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.

      • 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.

      • 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.

      • 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.