akka.persistence

Class Persistence

java.lang.Object

akka.persistence.Persistence

All Implemented Interfaces:

Extension

public class Persistence
extends java.lang.Object
implements Extension

Persistence extension.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Persistence.PluginHolder INTERNAL API.
static class	Persistence.PluginHolder$

Constructor Summary

Constructors

Constructor and Description
Persistence(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
EventAdapters	adaptersFor(ActorRef journalPluginActor) INTERNAL API Looks up EventAdapters by journal plugin's ActorRef.
EventAdapters	adaptersFor(java.lang.String journalPluginId) Returns an EventAdapters object which serves as a per-journal collection of bound event adapters.
com.typesafe.config.Config	configFor(ActorRef journalPluginActor) INTERNAL API Looks up the plugin config by plugin's ActorRef.
static Persistence	createExtension(ExtendedActorSystem system)
StashOverflowStrategy	defaultInternalStashOverflowStrategy()
static Persistence	get(ActorSystem system) Java API.
com.typesafe.config.Config	journalConfigFor(java.lang.String journalPluginId) INTERNAL API Returns the plugin config identified by pluginId.
ActorRef	journalFor(java.lang.String journalPluginId) INTERNAL API Returns a journal plugin actor identified by journalPluginId.
static Persistence$	lookup()
java.lang.String	persistenceId(ActorRef persistentActor) Creates a canonical persistent actor id from a persistent actor ref.
ActorRef	recoveryPermitter() INTERNAL API: When starting many persistent actors at the same time the journal its data store is protected from being overloaded by limiting number of recoveries that can be in progress at the same time.
PersistenceSettings	settings()
ActorRef	snapshotStoreFor(java.lang.String snapshotPluginId) INTERNAL API
ExtendedActorSystem	system()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Persistence

public Persistence(ExtendedActorSystem system)

Method Detail

get

public static Persistence get(ActorSystem system)

Java API.

createExtension

public static Persistence createExtension(ExtendedActorSystem system)

lookup

public static Persistence$ lookup()

system

public ExtendedActorSystem system()

recoveryPermitter

public ActorRef recoveryPermitter()

INTERNAL API: When starting many persistent actors at the same time the journal its data store is protected from being overloaded by limiting number of recoveries that can be in progress at the same time.

Returns:

(undocumented)

defaultInternalStashOverflowStrategy

public StashOverflowStrategy defaultInternalStashOverflowStrategy()

settings

public PersistenceSettings settings()

adaptersFor

public final EventAdapters adaptersFor(java.lang.String journalPluginId)

Returns an EventAdapters object which serves as a per-journal collection of bound event adapters. If no adapters are registered for a given journal the EventAdapters object will simply return the identity adapter for each class, otherwise the most specific adapter matching a given class will be returned.

Parameters:

journalPluginId - (undocumented)

Returns:

(undocumented)

adaptersFor

public final EventAdapters adaptersFor(ActorRef journalPluginActor)

INTERNAL API Looks up EventAdapters by journal plugin's ActorRef.

Parameters:

journalPluginActor - (undocumented)

Returns:

(undocumented)

journalConfigFor

public final com.typesafe.config.Config journalConfigFor(java.lang.String journalPluginId)

INTERNAL API Returns the plugin config identified by pluginId. When empty, looks in akka.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry.

Parameters:

journalPluginId - (undocumented)

Returns:

(undocumented)

configFor

public final com.typesafe.config.Config configFor(ActorRef journalPluginActor)

INTERNAL API Looks up the plugin config by plugin's ActorRef.

Parameters:

journalPluginActor - (undocumented)

Returns:

(undocumented)

journalFor

public final ActorRef journalFor(java.lang.String journalPluginId)

INTERNAL API Returns a journal plugin actor identified by journalPluginId. When empty, looks in akka.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

Parameters:

journalPluginId - (undocumented)

Returns:

(undocumented)

snapshotStoreFor

public final ActorRef snapshotStoreFor(java.lang.String snapshotPluginId)

INTERNAL API

Returns a snapshot store plugin actor identified by snapshotPluginId. When empty, looks in akka.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

Parameters:

snapshotPluginId - (undocumented)

Returns:

(undocumented)

persistenceId

public java.lang.String persistenceId(ActorRef persistentActor)

Creates a canonical persistent actor id from a persistent actor ref.