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

Class ReplicatedEntityProvider<M>

java.lang.Object

org.apache.pekko.cluster.sharding.typed.ReplicatedEntityProvider<M>

Type Parameters:

M - The type of messages the replicated entity accepts

public final class ReplicatedEntityProvider<M>
extends Object

Constructor Summary

Constructors

Constructor	Description
ReplicatedEntityProvider()

Method Summary

Modifier and Type	Method	Description
static <M> ReplicatedEntityProvider<M>	apply(String typeName, scala.collection.immutable.Set<ReplicaId> allReplicaIds, scala.Function2<EntityTypeKey<M>,ReplicaId,ReplicatedEntity<M>> settingsPerReplicaFactory, scala.reflect.ClassTag<M> evidence$1)	Scala API:
static <M> ReplicatedEntityProvider<M>	create(Class<M> messageClass, String typeName, Set<ReplicaId> allReplicaIds, Function2<EntityTypeKey<M>,ReplicaId,ReplicatedEntity<M>> settingsPerReplicaFactory)	Java API:
static <M> ReplicatedEntityProvider<M>	createPerDataCenter(Class<M> messageClass, String typeName, Set<ReplicaId> allReplicaIds, Function<ReplicationId,Behavior<M>> createBehavior)	Java API
static <M> ReplicatedEntityProvider<M>	createPerRole(Class<M> messageClass, String typeName, Set<ReplicaId> allReplicaIds, Function<ReplicationId,Behavior<M>> createBehavior)	Java API
boolean	directReplication()
static <M, E> ReplicatedEntityProvider<M>	perDataCenter(String typeName, scala.collection.immutable.Set<ReplicaId> allReplicaIds, scala.Function1<ReplicationId,Behavior<M>> create, scala.reflect.ClassTag<M> evidence$2)	Scala API
static <M, E> ReplicatedEntityProvider<M>	perRole(String typeName, scala.collection.immutable.Set<ReplicaId> allReplicaIds, scala.Function1<ReplicationId,Behavior<M>> create, scala.reflect.ClassTag<M> evidence$3)	Scala API
scala.collection.immutable.Seq<scala.Tuple2<ReplicatedEntity<M>,String>>	replicas()
ReplicatedEntityProvider<M>	withDirectReplication(boolean enabled)	Start direct replication over sharding when replicated sharding starts up, requires the entities to also have it enabled through pekko.persistence.typed.scaladsl.EventSourcedBehavior.withEventPublishing or pekko.persistence.typed.javadsl.ReplicatedEventSourcedBehavior.withEventPublishing to work.

Methods inherited from class java.lang.Object

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

Constructor Details

ReplicatedEntityProvider

public ReplicatedEntityProvider()

Method Details

create

public static <M> ReplicatedEntityProvider<M> create(Class<M> messageClass,
 String typeName,
 Set<ReplicaId> allReplicaIds,
 Function2<EntityTypeKey<M>,ReplicaId,ReplicatedEntity<M>> settingsPerReplicaFactory)

Java API:

Provides full control over the ReplicatedEntity and the javadsl.Entity Most use cases can use the <M>createPerDataCenter(java.lang.Class<M>,java.lang.String,java.util.Set<org.apache.pekko.persistence.typed.ReplicaId>,java.util.function.Function<org.apache.pekko.persistence.typed.ReplicationId,org.apache.pekko.actor.typed.Behavior<M>>) and <M>createPerRole(java.lang.Class<M>,java.lang.String,java.util.Set<org.apache.pekko.persistence.typed.ReplicaId>,org.apache.pekko.japi.function.Function<org.apache.pekko.persistence.typed.ReplicationId,org.apache.pekko.actor.typed.Behavior<M>>)

apply

public static <M> ReplicatedEntityProvider<M> apply(String typeName,
 scala.collection.immutable.Set<ReplicaId> allReplicaIds,
 scala.Function2<EntityTypeKey<M>,ReplicaId,ReplicatedEntity<M>> settingsPerReplicaFactory,
 scala.reflect.ClassTag<M> evidence$1)

Scala API:

Provides full control over the ReplicatedEntity and the scaladsl.Entity Most use cases can use the <M,E>perDataCenter(java.lang.String,scala.collection.immutable.Set<org.apache.pekko.persistence.typed.ReplicaId>,scala.Function1<org.apache.pekko.persistence.typed.ReplicationId,org.apache.pekko.actor.typed.Behavior<M>>,scala.reflect.ClassTag<M>) and <M,E>perRole(java.lang.String,scala.collection.immutable.Set<org.apache.pekko.persistence.typed.ReplicaId>,scala.Function1<org.apache.pekko.persistence.typed.ReplicationId,org.apache.pekko.actor.typed.Behavior<M>>,scala.reflect.ClassTag<M>)

Parameters:

typeName - The type name used in the scaladsl.EntityTypeKey

perDataCenter

public static <M,
E> ReplicatedEntityProvider<M> perDataCenter(String typeName,
 scala.collection.immutable.Set<ReplicaId> allReplicaIds,
 scala.Function1<ReplicationId,Behavior<M>> create,
 scala.reflect.ClassTag<M> evidence$2)

Scala API

Create a ReplicatedEntityProvider that uses the defaults for scaladsl.Entity when running in ClusterSharding. A replica will be run per data center.

perRole

public static <M,
E> ReplicatedEntityProvider<M> perRole(String typeName,
 scala.collection.immutable.Set<ReplicaId> allReplicaIds,
 scala.Function1<ReplicationId,Behavior<M>> create,
 scala.reflect.ClassTag<M> evidence$3)

Scala API

Create a ReplicatedEntityProvider that uses the defaults for scaladsl.Entity when running in ClusterSharding. The replicas in allReplicaIds should be roles used by nodes. A replica for each entity will run on each role.

createPerDataCenter

public static <M> ReplicatedEntityProvider<M> createPerDataCenter(Class<M> messageClass,
 String typeName,
 Set<ReplicaId> allReplicaIds,
 Function<ReplicationId,Behavior<M>> createBehavior)

Java API

Create a ReplicatedEntityProvider that uses the defaults for scaladsl.Entity when running in ClusterSharding. A replica will be run per data center.

createPerRole

public static <M> ReplicatedEntityProvider<M> createPerRole(Class<M> messageClass,
 String typeName,
 Set<ReplicaId> allReplicaIds,
 Function<ReplicationId,Behavior<M>> createBehavior)

Java API

Create a ReplicatedEntityProvider that uses the defaults for scaladsl.Entity when running in ClusterSharding.

Map replicas to roles and then there will be a replica per role e.g. to match to availability zones/racks

replicas

public scala.collection.immutable.Seq<scala.Tuple2<ReplicatedEntity<M>,String>> replicas()

directReplication

public boolean directReplication()

withDirectReplication

public ReplicatedEntityProvider<M> withDirectReplication(boolean enabled)

Start direct replication over sharding when replicated sharding starts up, requires the entities to also have it enabled through pekko.persistence.typed.scaladsl.EventSourcedBehavior.withEventPublishing or pekko.persistence.typed.javadsl.ReplicatedEventSourcedBehavior.withEventPublishing to work.