akka.cluster.sharding

Class PersistentShard

java.lang.Object

akka.cluster.sharding.Shard

akka.cluster.sharding.PersistentShard

All Implemented Interfaces:

Actor, ActorLogging, Stash, StashFactory, StashSupport, UnrestrictedStash, RequiresMessageQueue<DequeBasedMessageQueueSemantics>, Eventsourced, PersistenceIdentity, PersistenceRecovery, PersistenceStash, PersistentActor, Snapshotter

public class PersistentShard
extends Shard
implements PersistentActor, ActorLogging

INTERNAL API

This actor creates children entity actors on demand that it is told to be responsible for. It is used when rememberEntities is enabled.

See Also:

ClusterSharding extension

Nested Class Summary

Nested classes/interfaces inherited from class akka.cluster.sharding.Shard

Shard.CurrentShardState, Shard.CurrentShardState$, Shard.EntityStarted, Shard.EntityStarted$, Shard.EntityStopped, Shard.EntityStopped$, Shard.GetCurrentShardState$, Shard.GetShardStats$, Shard.RestartEntities, Shard.RestartEntities$, Shard.RestartEntity, Shard.RestartEntity$, Shard.ShardCommand, Shard.ShardQuery, Shard.ShardStats, Shard.ShardStats$, Shard.State, Shard.State$, Shard.StateChange

Nested classes/interfaces inherited from interface akka.persistence.Eventsourced

Eventsourced.AsyncHandlerInvocation, Eventsourced.AsyncHandlerInvocation$, Eventsourced.PendingHandlerInvocation, Eventsourced.RecoveryTick, Eventsourced.RecoveryTick$, Eventsourced.StashingHandlerInvocation, Eventsourced.StashingHandlerInvocation$, Eventsourced.State

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
PersistentShard(java.lang.String typeName, java.lang.String shardId, Props entityProps, ClusterShardingSettings settings, scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId, scala.Function1<java.lang.Object,java.lang.String> extractShardId, java.lang.Object handOffStopMessage)

Method Summary

Modifier and Type	Method and Description
void	deliverTo(java.lang.String id, java.lang.Object msg, java.lang.Object payload, ActorRef snd)
void	entityTerminated(ActorRef ref)
void	initialized()
protected ActorRef	journal()
java.lang.String	journalPluginId() Configuration id of the journal plugin servicing this persistent actor or view.
DequeBasedMessageQueueSemantics	mailbox()
java.lang.String	persistenceId() Id of the persistent entity for which messages should be replayed.
<A> void	processChange(A event, scala.Function1<A,scala.runtime.BoxedUnit> handler)
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveCommand() Command handler.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveRecover() Recovery handler that receives persisted events during recovery.
EntityRecoveryStrategy	rememberedEntitiesRecoveryStrategy()
void	saveSnapshotWhenNeeded()
java.lang.String	snapshotPluginId() Configuration id of the snapshot plugin servicing this persistent actor or view.
protected ActorRef	snapshotStore() Snapshot store plugin actor.

Methods inherited from class akka.cluster.sharding.Shard

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, akka$actor$ActorLogging$$_log_$eq, akka$actor$ActorLogging$$_log, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, deliverMessage, getEntity, handOff, handOffStopper, idByRef, log, messageBuffers, passivate, passivateCompleted, passivating, postRestart, postStop, preRestart, preStart, props, receiveCoordinatorMessage, receiveShardCommand, receiveShardQuery, receiveShardRegionCommand, receiveTerminated, refById, self, sender, sendMsgBuffer, state, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.persistence.Eventsourced

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, changeState, deferAsync, deleteMessages, flushBatch, flushJournalBatch, lastSequenceNr, log, nextSequenceNr, onPersistFailure, onPersistRejected, onRecoveryFailure, onReplaySuccess, peekApplyHandler, persist, persist, persistAll, persistAllAsync, persistAsync, persistAsync, recovering, recoveryFinished, recoveryRunning, recoveryStarted, requestRecoveryPermit, setLastSequenceNr, snapshotSequenceNr, snapshotterId, startRecovery, stashInternally, unhandled, unstashAll, unstashInternally, updateLastSequenceNr, waitingRecoveryPermit

Methods inherited from interface akka.persistence.Snapshotter

deleteSnapshot, deleteSnapshots, loadSnapshot, saveSnapshot

Methods inherited from interface akka.persistence.PersistenceStash

internalStashOverflowStrategy

Methods inherited from interface akka.actor.Actor

context, postRestart, preStart, self, sender, supervisorStrategy

Methods inherited from interface akka.actor.StashSupport

actorCell, clearStash, context, enqueueFirst, prepend, self, stash, unstash, unstashAll

Methods inherited from interface akka.actor.StashFactory

createStash

Methods inherited from interface akka.persistence.PersistenceRecovery

recovery

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

PersistentShard

public PersistentShard(java.lang.String typeName,
                       java.lang.String shardId,
                       Props entityProps,
                       ClusterShardingSettings settings,
                       scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId,
                       scala.Function1<java.lang.Object,java.lang.String> extractShardId,
                       java.lang.Object handOffStopMessage)

Method Detail

journal

protected ActorRef journal()

Specified by:

journal in interface Eventsourced

snapshotStore

protected ActorRef snapshotStore()

Description copied from interface: Snapshotter

Snapshot store plugin actor.

Specified by:

snapshotStore in interface Eventsourced

Specified by:

snapshotStore in interface Snapshotter

mailbox

public DequeBasedMessageQueueSemantics mailbox()

Specified by:

mailbox in interface StashSupport

rememberedEntitiesRecoveryStrategy

public EntityRecoveryStrategy rememberedEntitiesRecoveryStrategy()

persistenceId

public java.lang.String persistenceId()

Description copied from interface: PersistenceIdentity

Id of the persistent entity for which messages should be replayed.

Specified by:

persistenceId in interface PersistenceIdentity

Returns:

(undocumented)

journalPluginId

public java.lang.String journalPluginId()

Description copied from interface: PersistenceIdentity

Configuration id of the journal plugin servicing this persistent actor or view. 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.

Specified by:

journalPluginId in interface PersistenceIdentity

Returns:

(undocumented)

snapshotPluginId

public java.lang.String snapshotPluginId()

Description copied from interface: PersistenceIdentity

Configuration id of the snapshot plugin servicing this persistent actor or view. 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.

Specified by:

snapshotPluginId in interface PersistenceIdentity

Returns:

(undocumented)

initialized

public void initialized()

Overrides:

initialized in class Shard

receive

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

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Specified by:

receive in interface PersistentActor

Overrides:

receive in class Shard

Returns:

(undocumented)

processChange

public <A> void processChange(A event,
                              scala.Function1<A,scala.runtime.BoxedUnit> handler)

Overrides:

processChange in class Shard

saveSnapshotWhenNeeded

public void saveSnapshotWhenNeeded()

receiveRecover

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

Description copied from interface: Eventsourced

Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than the offered snapshot.

This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.

If there is a problem with recovering the state of the actor from the journal, the error will be logged and the actor will be stopped.

Specified by:

receiveRecover in interface Eventsourced

Returns:

(undocumented)

See Also:

Recovery

receiveCommand

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

Description copied from interface: Eventsourced

Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist.

Specified by:

receiveCommand in interface Eventsourced

Overrides:

receiveCommand in class Shard

Returns:

(undocumented)

entityTerminated

public void entityTerminated(ActorRef ref)

Overrides:

entityTerminated in class Shard

deliverTo

public void deliverTo(java.lang.String id,
                      java.lang.Object msg,
                      java.lang.Object payload,
                      ActorRef snd)

Overrides:

deliverTo in class Shard