akka.cluster.sharding

Class RemoveInternalClusterShardingData.RemoveOnePersistenceId

java.lang.Object

akka.cluster.sharding.RemoveInternalClusterShardingData.RemoveOnePersistenceId

All Implemented Interfaces:

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

Enclosing class:

RemoveInternalClusterShardingData

public static class RemoveInternalClusterShardingData.RemoveOnePersistenceId
extends java.lang.Object
implements PersistentActor

INTERNAL API: Remove all events and snapshots for one specific persistenceId. It will reply with RemoveOnePersistenceId.Result when done.

Nested Class Summary

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
RemoveOnePersistenceId(java.lang.String journalPluginId, java.lang.String persistenceId, ActorRef replyTo)

Method Summary

Modifier and Type	Method and Description
ActorContext	context() Stores the context for this actor, including self, and sender.
void	done()
void	failure(java.lang.Throwable cause)
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	handleFailure()
boolean	hasSnapshots()
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.
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.
ActorRef	self() The 'self' field holds the ActorRef for this actor.
protected ActorRef	snapshotStore() Snapshot store plugin actor.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	waitDeleteMessagesSuccess()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	waitDeleteSnapshotsSuccess()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.persistence.PersistentActor

receive

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

postRestart, preStart, sender, supervisorStrategy

Methods inherited from interface akka.actor.StashSupport

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

Methods inherited from interface akka.actor.StashFactory

createStash

Methods inherited from interface akka.persistence.PersistenceIdentity

snapshotPluginId

Methods inherited from interface akka.persistence.PersistenceRecovery

recovery

Constructor Detail

RemoveOnePersistenceId

public RemoveOnePersistenceId(java.lang.String journalPluginId,
                              java.lang.String persistenceId,
                              ActorRef replyTo)

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

context

public ActorContext context()

Description copied from interface: Actor

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!

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

Specified by:

context in interface Actor

Specified by:

context in interface StashSupport

Returns:

(undocumented)

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

Specified by:

self in interface StashSupport

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)

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)

hasSnapshots

public boolean hasSnapshots()

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

Returns:

(undocumented)

waitDeleteSnapshotsSuccess

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

waitDeleteMessagesSuccess

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

handleFailure

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

done

public void done()

failure

public void failure(java.lang.Throwable cause)