Package akka.cluster.sharding.typed.scaladsl

Class EntityContext<M>

java.lang.Object

akka.cluster.sharding.typed.scaladsl.EntityContext<M>

public final class EntityContext<M>
extends java.lang.Object

Parameter to createBehavior function in Entity.apply.

Cluster Sharding is often used together with EventSourcedBehavior for the entities. See more considerations in PersistenceId. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

 PersistenceId(entityContext.entityTypeKey.name, entityContext.entityId)
 

param: entityTypeKey the key of the entity type param: entityId the business domain identifier of the entity

Constructor Summary

Constructors

Constructor	Description
EntityContext(EntityTypeKey<M> entityTypeKey, java.lang.String entityId, ActorRef<ClusterSharding.ShardCommand> shard)

Method Summary

Modifier and Type	Method	Description
java.lang.String	entityId()
EntityTypeKey<M>	entityTypeKey()
ActorRef<ClusterSharding.ShardCommand>	shard()

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityContext

public EntityContext(EntityTypeKey<M> entityTypeKey,
                     java.lang.String entityId,
                     ActorRef<ClusterSharding.ShardCommand> shard)

Method Detail

entityId

public java.lang.String entityId()

entityTypeKey

public EntityTypeKey<M> entityTypeKey()

shard

public ActorRef<ClusterSharding.ShardCommand> shard()