akka.persistence.multidc.internal

Class InternalReplicatedEntity<Command,Event,State>

java.lang.Object

akka.persistence.multidc.internal.InternalReplicatedEntity<Command,Event,State>

Direct Known Subclasses:

ReplicatedEntity, ReplicatedEntity

public abstract class InternalReplicatedEntity<Command,Event,State>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InternalReplicatedEntity()

Method Summary

Modifier and Type	Method and Description
protected scala.collection.immutable.Set<java.lang.String>	allDcs() All data centers
long	currentTimeMillis() Called to create the timestamp when an event is persisted.
protected java.lang.String	entityId() The id of the current entity
protected java.lang.String	getEntityId() The id of the current entity
akka.actor.ActorRef	getSelf() The 'self' field holds the ActorRef for this actor.
protected java.lang.String	getSelfDc() Java API: Name of the data-center in which this entity is running
abstract State	initialState() Abstract method that must be implemented by concrete subclass to define the initial state of the entity.
abstract State	internalApplyEvent(State state, Event event) INTERNAL API: Apply the event to the state.
abstract CommandHandlerImpl<Command,Event,State>	internalCommandHandler() INTERNAL API: Abstract method that must be implemented by concrete subclass to define the command handlers of the entity.
abstract EffectImpl<Event,State>	internalEventTrigger(EventTriggerContextImpl ctx, State state, Event event)
abstract EffectImpl<Event,State>	internalRecoveryCompleted(ReplicatedActorContextImpl ctx, State state) INTERNAL API: This method is called to notify the entity that the recovery process is finished.
void	internalSetEntityId(java.lang.String id) INTERNAL API
void	internalSetLogger(ReplicatedEntityLoggingAdapter l) INTERNAL API
void	internalSetSelf(akka.actor.ActorRef s) INTERNAL API
void	internalSetSelfDc(java.lang.String id, scala.collection.immutable.Set<java.lang.String> all) INTERNAL API
abstract scala.collection.immutable.Set<java.lang.String>	internalTagsFor(EventTaggingContextImpl ctx, Event event) INTERNAL API: Allows "tagging" certain events with any number of tags.
ReplicatedEntityLoggingAdapter	log() Special LoggingAdapter which adds the enclosing replicated entity persistenceId to each log statement.
protected scala.collection.immutable.Set<java.lang.String>	otherDcs() Other data centers, allDcs without selfDc
java.lang.String	persistenceId(java.lang.String persistenceIdPrefix, java.lang.String entityId, java.lang.String dc) When migrating from PersistenceActor you need to define the exact format of the persistenceId to match the old identifiers in one of the data centers, which hosts the old data which are stored with persistence ids that don't include the data center suffix.
void	postStop() User overridable callback.
State	replicatedEventHandler(ReplicatedEventContext ctx, State state, Event event) Apply the event that was persisted by another data center to the given state.
akka.actor.ActorRef	self() The 'self' field holds the ActorRef for this actor.
protected java.lang.String	selfDc() Name of the data-center in which this entity is running
State	selfEventHandler(SelfEventContext ctx, State state, Event event) Apply the event that was persisted by this data center to the given state.
State	snapshotMigration(java.lang.Object oldSnapshot) When migrating from PersistentActor to Replicated entity this method is called to be able to convert old snapshots to the new State if needed.
akka.actor.SupervisorStrategy	supervisorStrategy() User overridable definition the strategy to use for supervising child actors.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalReplicatedEntity

public InternalReplicatedEntity()

Method Detail

allDcs

protected final scala.collection.immutable.Set<java.lang.String> allDcs()

All data centers

Returns:

(undocumented)

currentTimeMillis

public long currentTimeMillis()

Called to create the timestamp when an event is persisted. May be overridden if you want to use another clock source, or for testing purposes.

Returns:

(undocumented)

entityId

protected final java.lang.String entityId()

The id of the current entity

getEntityId

protected final java.lang.String getEntityId()

The id of the current entity

getSelf

public akka.actor.ActorRef getSelf()

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Used as the implicit sender for !

Returns:

(undocumented)

getSelfDc

protected final java.lang.String getSelfDc()

Java API: Name of the data-center in which this entity is running

initialState

public abstract State initialState()

Abstract method that must be implemented by concrete subclass to define the initial state of the entity.

Returns:

(undocumented)

internalApplyEvent

public abstract State internalApplyEvent(State state,
                                         Event event)

INTERNAL API: Apply the event to the state. Return the new State.

Parameters:

state - (undocumented)

event - (undocumented)

Returns:

(undocumented)

internalCommandHandler

public abstract CommandHandlerImpl<Command,Event,State> internalCommandHandler()

INTERNAL API: Abstract method that must be implemented by concrete subclass to define the command handlers of the entity. CommandHandler defines command handlers and optional functions for other signals, e.g. Termination messages if watch is used.

Note that you can have different handlers based on current state by using CommandHandlerImpl#byState.

Returns:

(undocumented)

internalEventTrigger

public abstract EffectImpl<Event,State> internalEventTrigger(EventTriggerContextImpl ctx,
                                                             State state,
                                                             Event event)

internalRecoveryCompleted

public abstract EffectImpl<Event,State> internalRecoveryCompleted(ReplicatedActorContextImpl ctx,
                                                                  State state)

INTERNAL API: This method is called to notify the entity that the recovery process is finished.

Parameters:

ctx - (undocumented)

state - (undocumented)

Returns:

(undocumented)

internalSetEntityId

public void internalSetEntityId(java.lang.String id)

INTERNAL API

internalSetLogger

public void internalSetLogger(ReplicatedEntityLoggingAdapter l)

INTERNAL API

internalSetSelf

public void internalSetSelf(akka.actor.ActorRef s)

INTERNAL API

Parameters:

s - (undocumented)

internalSetSelfDc

public void internalSetSelfDc(java.lang.String id,
                              scala.collection.immutable.Set<java.lang.String> all)

INTERNAL API

internalTagsFor

public abstract scala.collection.immutable.Set<java.lang.String> internalTagsFor(EventTaggingContextImpl ctx,
                                                                                 Event event)

INTERNAL API: Allows "tagging" certain events with any number of tags.

Parameters:

ctx - (undocumented)

event - (undocumented)

Returns:

(undocumented)

log

public ReplicatedEntityLoggingAdapter log()

Special LoggingAdapter which adds the enclosing replicated entity persistenceId to each log statement. Configure how it should add such metadata under the akka.persistence.multi-datacenter.logging config section.

WARNING: The logger may only be used after construction of the ReplicatedEntity has completed, i.e. not in its constructor.

WARNING: When using the MDC features of this logger, and NOT using Lightbend Monitoring's automatic MDC propagation, be awere that the MDC context would be lost if the logger were to be invoked from a Future.

Returns:

(undocumented)

otherDcs

protected final scala.collection.immutable.Set<java.lang.String> otherDcs()

Other data centers, allDcs without selfDc

Returns:

(undocumented)

persistenceId

public java.lang.String persistenceId(java.lang.String persistenceIdPrefix,
                                      java.lang.String entityId,
                                      java.lang.String dc)

When migrating from PersistenceActor you need to define the exact format of the persistenceId to match the old identifiers in one of the data centers, which hosts the old data which are stored with persistence ids that don't include the data center suffix. The prefix and separator is probably also different for old persistenceId.

The persistenceId is by default the concatenation of persistenceIdPrefix, entityId and the data center identifier, separated with |.

Parameters:

persistenceIdPrefix - (undocumented)

entityId - (undocumented)

dc - (undocumented)

Returns:

(undocumented)

postStop

public void postStop()
              throws java.lang.Exception

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Throws:

java.lang.Exception

replicatedEventHandler

public State replicatedEventHandler(ReplicatedEventContext ctx,
                                    State state,
                                    Event event)

Apply the event that was persisted by another data center to the given state. Return the new State. By default this invokes eventHandler but in case more context of the event is needed this can be overridden instead. See also selfEventHandler(akka.persistence.multidc.SelfEventContext, State, Event).

Parameters:

ctx - (undocumented)

state - (undocumented)

event - (undocumented)

Returns:

(undocumented)

self

public akka.actor.ActorRef self()

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Used as the implicit sender for !

Returns:

(undocumented)

selfDc

protected final java.lang.String selfDc()

Name of the data-center in which this entity is running

selfEventHandler

public State selfEventHandler(SelfEventContext ctx,
                              State state,
                              Event event)

Apply the event that was persisted by this data center to the given state. Return the new State. By default this invokes eventHandler but in case more context of the event is needed this can be overridden instead. See also replicatedEventHandler(akka.persistence.multidc.ReplicatedEventContext, State, Event).

Parameters:

ctx - (undocumented)

state - (undocumented)

event - (undocumented)

Returns:

(undocumented)

snapshotMigration

public State snapshotMigration(java.lang.Object oldSnapshot)

When migrating from PersistentActor to Replicated entity this method is called to be able to convert old snapshots to the new State if needed. By default it tries to cast the oldSnapshot to State.

Parameters:

oldSnapshot - (undocumented)

Returns:

(undocumented)

supervisorStrategy

public akka.actor.SupervisorStrategy supervisorStrategy()

User overridable definition the strategy to use for supervising child actors.

Returns:

(undocumented)