Package org.apache.pekko.cluster.sharding.typed.javadsl

Class EntityContext<M>

java.lang.Object

org.apache.pekko.cluster.sharding.typed.javadsl.EntityContext<M>

public final class EntityContext<M>
extends Object

Parameter to createBehavior function in Entity.of.

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

 PersistenceId.of(entityContext.getEntityTypeKey().name(), entityContext.getEntityId())
 

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, String entityId, ActorRef<ClusterSharding.ShardCommand> shard)

Method Summary

Modifier and Type	Method	Description
String	getEntityId()
EntityTypeKey<M>	getEntityTypeKey()
ActorRef<ClusterSharding.ShardCommand>	getShard()

Methods inherited from class java.lang.Object

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

Constructor Details

EntityContext

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

Method Details

getEntityId

public String getEntityId()

getEntityTypeKey

public EntityTypeKey<M> getEntityTypeKey()

getShard

public ActorRef<ClusterSharding.ShardCommand> getShard()