akka.cluster.sharding

Class ClusterShardingSettings

java.lang.Object

akka.cluster.sharding.ClusterShardingSettings

All Implemented Interfaces:

NoSerializationVerificationNeeded

public final class ClusterShardingSettings
extends java.lang.Object
implements NoSerializationVerificationNeeded

param: role specifies that this entity type requires cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used. param: rememberEntities true if active entity actors shall be automatically restarted upon Shard restart. i.e. if the Shard is started on a different ShardRegion due to rebalance or crash. param: journalPluginId Absolute path to the journal plugin configuration entity that is to be used for the internal persistence of ClusterSharding. If not defined the default journal plugin is used. Note that this is not related to persistence used by the entity actors. param: snapshotPluginId Absolute path to the snapshot plugin configuration entity that is to be used for the internal persistence of ClusterSharding. If not defined the default snapshot plugin is used. Note that this is not related to persistence used by the entity actors. param: tuningParameters additional tuning parameters, see descriptions in reference.conf

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterShardingSettings.TuningParameters

Constructor Summary

Constructors

Constructor and Description
ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)

Method Summary

Modifier and Type	Method and Description
static ClusterShardingSettings	apply(ActorSystem system) Create settings from the default configuration akka.cluster.sharding.
static ClusterShardingSettings	apply(com.typesafe.config.Config config) Create settings from a configuration with the same layout as the default configuration akka.cluster.sharding.
ClusterSingletonManagerSettings	coordinatorSingletonSettings()
static ClusterShardingSettings	create(ActorSystem system) Java API: Create settings from the default configuration akka.cluster.sharding.
static ClusterShardingSettings	create(com.typesafe.config.Config config) Java API: Create settings from a configuration with the same layout as the default configuration akka.cluster.sharding.
java.lang.String	journalPluginId()
boolean	rememberEntities()
scala.Option<java.lang.String>	role()
static scala.Option<java.lang.String>	roleOption(java.lang.String role) INTERNAL API
java.lang.String	snapshotPluginId()
java.lang.String	stateStoreMode()
ClusterShardingSettings.TuningParameters	tuningParameters()
ClusterShardingSettings	withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings) The role of the ClusterSingletonManagerSettings is not used.
ClusterShardingSettings	withJournalPluginId(java.lang.String journalPluginId)
ClusterShardingSettings	withRememberEntities(boolean rememberEntities)
ClusterShardingSettings	withRole(scala.Option<java.lang.String> role)
ClusterShardingSettings	withRole(java.lang.String role)
ClusterShardingSettings	withSnapshotPluginId(java.lang.String snapshotPluginId)
ClusterShardingSettings	withStateStoreMode(java.lang.String stateStoreMode)
ClusterShardingSettings	withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterShardingSettings

public ClusterShardingSettings(scala.Option<java.lang.String> role,
                               boolean rememberEntities,
                               java.lang.String journalPluginId,
                               java.lang.String snapshotPluginId,
                               java.lang.String stateStoreMode,
                               ClusterShardingSettings.TuningParameters tuningParameters,
                               ClusterSingletonManagerSettings coordinatorSingletonSettings)

Method Detail

apply

public static ClusterShardingSettings apply(ActorSystem system)

Create settings from the default configuration akka.cluster.sharding.

Parameters:

system - (undocumented)

Returns:

(undocumented)

apply

public static ClusterShardingSettings apply(com.typesafe.config.Config config)

Create settings from a configuration with the same layout as the default configuration akka.cluster.sharding.

Parameters:

config - (undocumented)

Returns:

(undocumented)

create

public static ClusterShardingSettings create(ActorSystem system)

Java API: Create settings from the default configuration akka.cluster.sharding.

Parameters:

system - (undocumented)

Returns:

(undocumented)

create

public static ClusterShardingSettings create(com.typesafe.config.Config config)

Java API: Create settings from a configuration with the same layout as the default configuration akka.cluster.sharding.

Parameters:

config - (undocumented)

Returns:

(undocumented)

roleOption

public static scala.Option<java.lang.String> roleOption(java.lang.String role)

INTERNAL API

Parameters:

role - (undocumented)

Returns:

(undocumented)

role

public scala.Option<java.lang.String> role()

rememberEntities

public boolean rememberEntities()

journalPluginId

public java.lang.String journalPluginId()

snapshotPluginId

public java.lang.String snapshotPluginId()

stateStoreMode

public java.lang.String stateStoreMode()

tuningParameters

public ClusterShardingSettings.TuningParameters tuningParameters()

coordinatorSingletonSettings

public ClusterSingletonManagerSettings coordinatorSingletonSettings()

withRole

public ClusterShardingSettings withRole(java.lang.String role)

withRole

public ClusterShardingSettings withRole(scala.Option<java.lang.String> role)

withRememberEntities

public ClusterShardingSettings withRememberEntities(boolean rememberEntities)

withJournalPluginId

public ClusterShardingSettings withJournalPluginId(java.lang.String journalPluginId)

withSnapshotPluginId

public ClusterShardingSettings withSnapshotPluginId(java.lang.String snapshotPluginId)

withTuningParameters

public ClusterShardingSettings withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)

withStateStoreMode

public ClusterShardingSettings withStateStoreMode(java.lang.String stateStoreMode)

withCoordinatorSingletonSettings

public ClusterShardingSettings withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)

The role of the ClusterSingletonManagerSettings is not used. The role of the coordinator singleton will be the same as the role of ClusterShardingSettings.

Parameters:

coordinatorSingletonSettings - (undocumented)

Returns:

(undocumented)