com.lightbend.lagom.javadsl.persistence

Class PersistentEntityRef<Command>

Object

com.lightbend.lagom.javadsl.persistence.PersistentEntityRef<Command>

All Implemented Interfaces:

akka.actor.NoSerializationVerificationNeeded

public final class PersistentEntityRef<Command>
extends Object
implements akka.actor.NoSerializationVerificationNeeded

Commands are sent to a PersistentEntity using a PersistentEntityRef. It is retrieved with PersistentEntityRegistry.refFor(java.lang.Class<? extends com.lightbend.lagom.javadsl.persistence.PersistentEntity<C, ?, ?>>, java.lang.String).

Constructor Summary

Constructors

Constructor and Description
PersistentEntityRef(String entityId, akka.actor.ActorRef region, akka.actor.ActorSystem system, scala.concurrent.duration.FiniteDuration askTimeout)

Method Summary

Modifier and Type	Method and Description
<Reply,Cmd extends Command> CompletionStage<Reply>	ask(Cmd command) Send the command to the PersistentEntity.
String	entityId()
String	toString()
PersistentEntityRef<Command>	withAskTimeout(scala.concurrent.duration.FiniteDuration timeout) The timeout for ask(Cmd).

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PersistentEntityRef

public PersistentEntityRef(String entityId,
                           akka.actor.ActorRef region,
                           akka.actor.ActorSystem system,
                           scala.concurrent.duration.FiniteDuration askTimeout)

Method Detail

entityId

public String entityId()

ask

public <Reply,Cmd extends Command> CompletionStage<Reply> ask(Cmd command)

Send the command to the PersistentEntity. The returned CompletionStage will be completed with the reply from the PersistentEntity. The type of the reply is defined by the command (see PersistentEntity.ReplyType).

The CompletionStage may also be completed with failure, sent by the PersistentEntity or a akka.pattern.AskTimeoutException if there is no reply within a timeout. The timeout can defined in configuration or overridden using withAskTimeout(scala.concurrent.duration.FiniteDuration).

withAskTimeout

public PersistentEntityRef<Command> withAskTimeout(scala.concurrent.duration.FiniteDuration timeout)

The timeout for ask(Cmd). The timeout is by default defined in configuration but it can be adjusted for a specific PersistentEntityRef using this method. Note that this returns a new PersistentEntityRef instance with the given timeout (PersistentEntityRef is immutable).

toString

public String toString()

Overrides:

toString in class Object