pekko/akka-persistence/src/main/scala/akka/persistence/snapshot/SnapshotStore.scala

/**
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 * Copyright (C) 2012-2013 Eligotech BV.
 */

package akka.persistence.snapshot

import scala.concurrent.Future

import akka.actor._
import akka.pattern.pipe
import akka.persistence._

/**
 * Abstract snapshot store.
 */
trait SnapshotStore extends Actor {
  import SnapshotProtocol._
  import context.dispatcher

  private val extension = Persistence(context.system)

  final def receive = {
    case LoadSnapshot(processorId, criteria, toSequenceNr) ⇒
      val p = sender
      loadAsync(processorId, criteria.limit(toSequenceNr)) map {
        sso ⇒ LoadSnapshotResult(sso, toSequenceNr)
      } recover {
        case e ⇒ LoadSnapshotResult(None, toSequenceNr)
      } pipeTo (p)
    case SaveSnapshot(metadata, snapshot) ⇒
      val p = sender
      val md = metadata.copy(timestamp = System.currentTimeMillis)
      saveAsync(md, snapshot) map {
        _ ⇒ SaveSnapshotSuccess(md)
      } recover {
        case e ⇒ SaveSnapshotFailure(metadata, e)
      } to (self, p)
    case evt @ SaveSnapshotSuccess(metadata) ⇒
      saved(metadata)
      sender ! evt // sender is processor
    case evt @ SaveSnapshotFailure(metadata, _) ⇒
      delete(metadata)
      sender ! evt // sender is processor
    case d @ DeleteSnapshot(metadata) ⇒
      delete(metadata)
      if (extension.publishPluginCommands) context.system.eventStream.publish(d)
    case d @ DeleteSnapshots(processorId, criteria) ⇒
      delete(processorId, criteria)
      if (extension.publishPluginCommands) context.system.eventStream.publish(d)
  }

  //#snapshot-store-plugin-api
  /**
   * Plugin API: asynchronously loads a snapshot.
   *
   * @param processorId processor id.
   * @param criteria selection criteria for loading.
   */
  def loadAsync(processorId: String, criteria: SnapshotSelectionCriteria): Future[Option[SelectedSnapshot]]

  /**
   * Plugin API: asynchronously saves a snapshot.
   *
   * @param metadata snapshot metadata.
   * @param snapshot snapshot.
   */
  def saveAsync(metadata: SnapshotMetadata, snapshot: Any): Future[Unit]

  /**
   * Plugin API: called after successful saving of a snapshot.
   *
   * @param metadata snapshot metadata.
   */
  def saved(metadata: SnapshotMetadata)

  /**
   * Plugin API: deletes the snapshot identified by `metadata`.
   *
   * @param metadata snapshot metadata.
   */

  def delete(metadata: SnapshotMetadata)

  /**
   * Plugin API: deletes all snapshots matching `criteria`.
   *
   * @param processorId processor id.
   * @param criteria selection criteria for deleting.
   */
  def delete(processorId: String, criteria: SnapshotSelectionCriteria)
  //#snapshot-store-plugin-api
}