Akka/Scala example source code file (SnapshotStorePlugin.java)

This example Akka source code file (SnapshotStorePlugin.java) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Akka and Scala source code examples by using tags.

All credit for the original source code belongs to akka.io; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Akka tags/keywords

akka, concurrent, exception, future, japi, object, persistence, snapshot, snapshotselectioncriteria, snapshotstoreplugin

The SnapshotStorePlugin.java Akka example source code

/**
 * Copyright (C) 2009-2014 Typesafe Inc. <http://www.typesafe.com>
 */

package akka.persistence.snapshot.japi;

import scala.concurrent.Future;

import akka.japi.Option;
import akka.persistence.*;

interface SnapshotStorePlugin {
    //#snapshot-store-plugin-api
    /**
     * Java API, Plugin API: asynchronously loads a snapshot.
     *
     * @param persistenceId processor id.
     * @param criteria selection criteria for loading.
     */
    Future<Option<SelectedSnapshot>> doLoadAsync(String persistenceId, SnapshotSelectionCriteria criteria);

    /**
     * Java API, Plugin API: asynchronously saves a snapshot.
     *
     * @param metadata snapshot metadata.
     * @param snapshot snapshot.
     */
    Future<Void> doSaveAsync(SnapshotMetadata metadata, Object snapshot);

    /**
     * Java API, Plugin API: called after successful saving of a snapshot.
     *
     * @param metadata snapshot metadata.
     */
    void onSaved(SnapshotMetadata metadata) throws Exception;

    /**
     * Java API, Plugin API: deletes the snapshot identified by `metadata`.
     *
     * @param metadata snapshot metadata.
     */
    void doDelete(SnapshotMetadata metadata) throws Exception;

    /**
     * Java API, Plugin API: deletes all snapshots matching `criteria`.
     *
     * @param persistenceId processor id.
     * @param criteria selection criteria for deleting.
     */
    void doDelete(String persistenceId, SnapshotSelectionCriteria criteria) throws Exception;
    //#snapshot-store-plugin-api
}