ClusterWideConfigurationService (Hazelcast Root 3.9-EA API)

java.lang.Object
- com.hazelcast.internal.dynamicconfig.ClusterWideConfigurationService

All Implemented Interfaces:: ClusterVersionListener, ConfigurationService, CoreService, ManagedService, MigrationAwareService, SplitBrainHandlerService

public class ClusterWideConfigurationService
extends Object
implements MigrationAwareService, CoreService, ClusterVersionListener, ManagedService, ConfigurationService, SplitBrainHandlerService

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ClusterWideConfigurationService.Merger

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterWideConfigurationService.Merger`

Field Summary

Fields
Modifier and Type Field and Description

static int CONFIG_PUBLISH_MAX_ATTEMPT_COUNT

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static int`	`CONFIG_PUBLISH_MAX_ATTEMPT_COUNT`
`static String`	`SERVICE_NAME`

Constructor Summary

Constructors
Constructor and Description

ClusterWideConfigurationService(NodeEngine nodeEngine, DynamicConfigListener dynamicConfigListener)

Constructors
Constructor and Description
`ClusterWideConfigurationService(NodeEngine nodeEngine, DynamicConfigListener dynamicConfigListener)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beforeMigration(PartitionMigrationEvent event)` Called before migration process starts, on both source and destination members.
`void`	`broadcastConfig(IdentifiedDataSerializable config)` Register a dynamic configurations to all cluster members.
`void`	`commitMigration(PartitionMigrationEvent event)` Commits the migration process for this service, on both source and destination members.
`EventJournalConfig`	`findCacheEventJournalConfig(String name)`
`CacheSimpleConfig`	`findCacheSimpleConfig(String name)` Find existing Cache Config
`CardinalityEstimatorConfig`	`findCardinalityEstimatorConfig(String name)` Find existing Cardinality Estimator Config
`DurableExecutorConfig`	`findDurableExecutorConfig(String name)` Find existing Durable Executor Config
`ExecutorConfig`	`findExecutorConfig(String name)` Find existing Executor Config
`ListConfig`	`findListConfig(String name)` Find existing List Config
`LockConfig`	`findLockConfig(String name)` Find existing Lock Config
`MapConfig`	`findMapConfig(String name)` Find existing Map Config
`EventJournalConfig`	`findMapEventJournalConfig(String name)`
`MultiMapConfig`	`findMultiMapConfig(String name)` Find existing Multimap Config
`QueueConfig`	`findQueueConfig(String name)` Find existing Queue Config
`ReliableTopicConfig`	`findReliableTopicConfig(String name)` Find existing Reliable Topic Config
`ReplicatedMapConfig`	`findReplicatedMapConfig(String name)` Find existing Replicated Map Config
`RingbufferConfig`	`findRingbufferConfig(String name)` Find existing Ringbuffer Config
`ScheduledExecutorConfig`	`findScheduledExecutorConfig(String name)` Find existing Scheduled Executor Config
`SemaphoreConfig`	`findSemaphoreConfig(String name)` Find existing Semaphore Config
`SetConfig`	`findSetConfig(String name)` Find existing Set Config
`TopicConfig`	`findTopicConfig(String name)` Find existing Topic Config
`Map<String,EventJournalConfig>`	`getCacheEventJournalConfigs()`
`Map<String,CacheSimpleConfig>`	`getCacheSimpleConfigs()` Return all registered cache configurations.
`ConcurrentMap<String,CardinalityEstimatorConfig>`	`getCardinalityEstimatorConfigs()` Return all registered cardinality estimator configurations.
`ConcurrentMap<String,DurableExecutorConfig>`	`getDurableExecutorConfigs()` Return all registered durable executor configurations.
`ConcurrentMap<String,ExecutorConfig>`	`getExecutorConfigs()` Return all registered executor configurations.
`ConcurrentMap<String,ListConfig>`	`getListConfigs()` Return all registered list configurations.
`Map<String,LockConfig>`	`getLockConfigs()` Return all registered lock configurations.
`Map<String,MapConfig>`	`getMapConfigs()` Return all registered map configurations.
`Map<String,EventJournalConfig>`	`getMapEventJournalConfigs()`
`ConcurrentMap<String,MultiMapConfig>`	`getMultiMapConfigs()` Return all registered multimap configurations.
`Map<String,QueueConfig>`	`getQueueConfigs()` Return all registered queue configurations.
`ConcurrentMap<String,ReliableTopicConfig>`	`getReliableTopicConfigs()` Return all registered reliable topic configurations.
`ConcurrentMap<String,ReplicatedMapConfig>`	`getReplicatedMapConfigs()` Return all registered replicated map configurations.
`ConcurrentMap<String,RingbufferConfig>`	`getRingbufferConfigs()` Return all registered ringbuffer configurations.
`ConcurrentMap<String,ScheduledExecutorConfig>`	`getScheduledExecutorConfigs()` Return all registered scheduled executor configurations.
`ConcurrentMap<String,SemaphoreConfig>`	`getSemaphoreConfigs()` Return all registered semaphore configurations.
`ConcurrentMap<String,SetConfig>`	`getSetConfigs()` Return all registered set configurations.
`ConcurrentMap<String,TopicConfig>`	`getTopicConfigs()` Return all registered topic configurations.
`void`	`init(NodeEngine nodeEngine, Properties properties)` Initializes this ManagedService
`void`	`onClusterVersionChange(Version newVersion)` Invoked on registered listeners after the new cluster version has been applied.
`Runnable`	`prepareMergeRunnable()` When the 2 separate clusters merge (resolve a split brain), this method is called to return a Runnable that will merge the clusters.
`Operation`	`prepareReplicationOperation(PartitionReplicationEvent event)` Returns an operation to replicate service data and/or state for a specific partition replica on another cluster member.
`void`	`registerConfigLocally(IdentifiedDataSerializable newConfig, ConfigCheckMode configCheckMode)` Register a dynamic configuration in a local member.
`void`	`reset()` reset this ManagedService back to initial state.
`void`	`rollbackMigration(PartitionMigrationEvent event)` Rollback the migration process for this service, on both source and destination members.
`void`	`shutdown(boolean terminate)` Shuts down this ManagedService.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - CONFIG_PUBLISH_MAX_ATTEMPT_COUNT
```
public static final int CONFIG_PUBLISH_MAX_ATTEMPT_COUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClusterWideConfigurationService
```
public ClusterWideConfigurationService(NodeEngine nodeEngine,
                                       DynamicConfigListener dynamicConfigListener)
```
- Method Detail
  - prepareReplicationOperation
```
public Operation prepareReplicationOperation(PartitionReplicationEvent event)
```
    Description copied from interface: MigrationAwareService
    
    Returns an operation to replicate service data and/or state for a specific partition replica on another cluster member.
    This method will be called on source member whenever partitioning system requires to copy/replicate a partition replica. Returned operation will be executed on destination member. If operation fails by throwing exception, migration process will fail and will be rolled back.
    Returning null is allowed and means service does not have anything to replicate.
    
    Specified by:
    
    prepareReplicationOperation in interface MigrationAwareService
    
    Parameters:
    
    event - replication
    
    Returns:
    
    replication operation or null if nothing will be replicated
  - beforeMigration
```
public void beforeMigration(PartitionMigrationEvent event)
```
    Description copied from interface: MigrationAwareService
    
    Called before migration process starts, on both source and destination members.
    Service can take actions required before migration. Migration process will block until this method returns. If this method fails by throwing an exception, migration process for specific partition will fail and will be rolled back.
    
    Specified by:
    
    beforeMigration in interface MigrationAwareService
    
    Parameters:
    
    event - migration event
  - commitMigration
```
public void commitMigration(PartitionMigrationEvent event)
```
    Description copied from interface: MigrationAwareService
    
    Commits the migration process for this service, on both source and destination members. This method will be called after all replication operations are executed successfully on destination and master member receives success response from all participants.
    Commit is not expected to fail at this point, all exceptions will be suppressed and logged.
    
    Specified by:
    
    commitMigration in interface MigrationAwareService
    
    Parameters:
    
    event - migration event
  - rollbackMigration
```
public void rollbackMigration(PartitionMigrationEvent event)
```
    Description copied from interface: MigrationAwareService
    
    Rollback the migration process for this service, on both source and destination members. This method will be called when migration process fails at any moment. Reasons for failure may be an exception thrown on any migration step or failure(s) of any of the migration participants; either master or source or destination.
    Rollback is not expected to fail at this point, all exceptions will be suppressed and logged.
    
    Specified by:
    
    rollbackMigration in interface MigrationAwareService
    
    Parameters:
    
    event - migration event
  - onClusterVersionChange
```
public void onClusterVersionChange(Version newVersion)
```
    Description copied from interface: ClusterVersionListener
    
    Invoked on registered listeners after the new cluster version has been applied. Listeners are executed synchronously immediately after ClusterStateManager#version has been updated and while the cluster service lock ClusterServiceImpl#lock is still locked, as part of the commit phase of the transaction changing the cluster version. Unhandled exceptions from listeners implementation will break the new version commit and a slow implementation will stall the system and may cause a transaction timeout. If new cluster version is null and property GroupProperty.INIT_CLUSTER_VERSION is set, the version set by this property will be provided as argument to the listener. If neither are set, running node's codebase version will be used.
    
    Specified by:
    
    onClusterVersionChange in interface ClusterVersionListener
    
    Parameters:
    
    newVersion - the new version
  - init
```
public void init(NodeEngine nodeEngine,
                 Properties properties)
```
    Description copied from interface: ManagedService
    
    Initializes this ManagedService
    
    Specified by:
    
    init in interface ManagedService
    
    Parameters:
    
    nodeEngine - the NodeEngine that this ManagedService belongs to.
    
    properties - the Properties. Can be used to pass settings to the service.
  - reset
```
public void reset()
```
    Description copied from interface: ManagedService
    
    reset this ManagedService back to initial state. todo: what is the purpose of reset
    
    Specified by:
    
    reset in interface ManagedService
  - shutdown
```
public void shutdown(boolean terminate)
```
    Description copied from interface: ManagedService
    
    Shuts down this ManagedService. todo: what is the purpose of the terminate variable.
    
    Specified by:
    
    shutdown in interface ManagedService
    
    Parameters:
    
    terminate - true to shut down the ManagedService
  - broadcastConfig
```
public void broadcastConfig(IdentifiedDataSerializable config)
```
    Description copied from interface: ConfigurationService
    
    Register a dynamic configurations to all cluster members.
    
    Specified by:
    
    broadcastConfig in interface ConfigurationService
    
    Parameters:
    
    config - Configuration to register
  - registerConfigLocally
```
public void registerConfigLocally(IdentifiedDataSerializable newConfig,
                                  ConfigCheckMode configCheckMode)
```
    Register a dynamic configuration in a local member. When a dynamic configuration with the same name already exists then this call has no effect.
    
    Parameters:
    
    newConfig - Configuration to register.
    
    configCheckMode - behaviour when a config is detected
    
    Throws:
    
    UnsupportedOperationException - when given configuration type is not supported
    
    ConfigurationException - when conflict is detected and configCheckMode is on THROW_EXCEPTION
  - findMultiMapConfig
```
public MultiMapConfig findMultiMapConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Multimap Config
    
    Specified by:
    
    findMultiMapConfig in interface ConfigurationService
    
    Returns:
    
    Multimap Config or null when requested MultiMap configuration does not exist
  - getMultiMapConfigs
```
public ConcurrentMap<String,MultiMapConfig> getMultiMapConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered multimap configurations.
    
    Specified by:
    
    getMultiMapConfigs in interface ConfigurationService
    
    Returns:
    
    registered multimap configurations
  - findMapConfig
```
public MapConfig findMapConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Map Config
    
    Specified by:
    
    findMapConfig in interface ConfigurationService
    
    Returns:
    
    Map Config or null when requested Map configuration does not exist
  - getMapConfigs
```
public Map<String,MapConfig> getMapConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered map configurations.
    
    Specified by:
    
    getMapConfigs in interface ConfigurationService
    
    Returns:
    
    registered map configurations
  - findTopicConfig
```
public TopicConfig findTopicConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Topic Config
    
    Specified by:
    
    findTopicConfig in interface ConfigurationService
    
    Returns:
    
    Topic Config or null when requested Topic configuration does not exist
  - getTopicConfigs
```
public ConcurrentMap<String,TopicConfig> getTopicConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered topic configurations.
    
    Specified by:
    
    getTopicConfigs in interface ConfigurationService
    
    Returns:
    
    registered topic configurations
  - findCardinalityEstimatorConfig
```
public CardinalityEstimatorConfig findCardinalityEstimatorConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Cardinality Estimator Config
    
    Specified by:
    
    findCardinalityEstimatorConfig in interface ConfigurationService
    
    Returns:
    
    Cardinality Estimator Config or null when requested Cardinality Estimator configuration does not exist
  - getCardinalityEstimatorConfigs
```
public ConcurrentMap<String,CardinalityEstimatorConfig> getCardinalityEstimatorConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered cardinality estimator configurations.
    
    Specified by:
    
    getCardinalityEstimatorConfigs in interface ConfigurationService
    
    Returns:
    
    registered cardinality estimator configurations
  - findExecutorConfig
```
public ExecutorConfig findExecutorConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Executor Config
    
    Specified by:
    
    findExecutorConfig in interface ConfigurationService
    
    Returns:
    
    Executor Config or null when requested Executor configuration does not exist
  - getExecutorConfigs
```
public ConcurrentMap<String,ExecutorConfig> getExecutorConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered executor configurations.
    
    Specified by:
    
    getExecutorConfigs in interface ConfigurationService
    
    Returns:
    
    registered executor configurations
  - findScheduledExecutorConfig
```
public ScheduledExecutorConfig findScheduledExecutorConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Scheduled Executor Config
    
    Specified by:
    
    findScheduledExecutorConfig in interface ConfigurationService
    
    Returns:
    
    Scheduled Executor Config or null when requested Scheduled Executor configuration does not exist
  - getScheduledExecutorConfigs
```
public ConcurrentMap<String,ScheduledExecutorConfig> getScheduledExecutorConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered scheduled executor configurations.
    
    Specified by:
    
    getScheduledExecutorConfigs in interface ConfigurationService
    
    Returns:
    
    registered scheduled executor configurations
  - findDurableExecutorConfig
```
public DurableExecutorConfig findDurableExecutorConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Durable Executor Config
    
    Specified by:
    
    findDurableExecutorConfig in interface ConfigurationService
    
    Returns:
    
    Durable Executor Config or null when requested Durable Executor configuration does not exist
  - getDurableExecutorConfigs
```
public ConcurrentMap<String,DurableExecutorConfig> getDurableExecutorConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered durable executor configurations.
    
    Specified by:
    
    getDurableExecutorConfigs in interface ConfigurationService
    
    Returns:
    
    registered durable executor configurations
  - findSemaphoreConfig
```
public SemaphoreConfig findSemaphoreConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Semaphore Config
    
    Specified by:
    
    findSemaphoreConfig in interface ConfigurationService
    
    Returns:
    
    Semaphore Config or null when requested Semaphore configuration does not exist
  - getSemaphoreConfigs
```
public ConcurrentMap<String,SemaphoreConfig> getSemaphoreConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered semaphore configurations.
    
    Specified by:
    
    getSemaphoreConfigs in interface ConfigurationService
    
    Returns:
    
    registered semaphore configurations
  - findRingbufferConfig
```
public RingbufferConfig findRingbufferConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Ringbuffer Config
    
    Specified by:
    
    findRingbufferConfig in interface ConfigurationService
    
    Returns:
    
    Ringbuffer Config or null when requested Ringbuffer configuration does not exist
  - getRingbufferConfigs
```
public ConcurrentMap<String,RingbufferConfig> getRingbufferConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered ringbuffer configurations.
    
    Specified by:
    
    getRingbufferConfigs in interface ConfigurationService
    
    Returns:
    
    registered ringbuffer configurations
  - findLockConfig
```
public LockConfig findLockConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Lock Config
    
    Specified by:
    
    findLockConfig in interface ConfigurationService
    
    Returns:
    
    Lock Config or null when requested Lock configuration does not exist
  - getLockConfigs
```
public Map<String,LockConfig> getLockConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered lock configurations.
    
    Specified by:
    
    getLockConfigs in interface ConfigurationService
    
    Returns:
    
    registered lock configurations
  - findListConfig
```
public ListConfig findListConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing List Config
    
    Specified by:
    
    findListConfig in interface ConfigurationService
    
    Returns:
    
    MaListp Config or null when requested List configuration does not exist
  - getListConfigs
```
public ConcurrentMap<String,ListConfig> getListConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered list configurations.
    
    Specified by:
    
    getListConfigs in interface ConfigurationService
    
    Returns:
    
    registered list configurations
  - findQueueConfig
```
public QueueConfig findQueueConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Queue Config
    
    Specified by:
    
    findQueueConfig in interface ConfigurationService
    
    Returns:
    
    Queue Config or null when requested Queue configuration does not exist
  - getQueueConfigs
```
public Map<String,QueueConfig> getQueueConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered queue configurations.
    
    Specified by:
    
    getQueueConfigs in interface ConfigurationService
    
    Returns:
    
    registered queue configurations
  - findSetConfig
```
public SetConfig findSetConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Set Config
    
    Specified by:
    
    findSetConfig in interface ConfigurationService
    
    Returns:
    
    Set Config or null when requested Set configuration does not exist
  - getSetConfigs
```
public ConcurrentMap<String,SetConfig> getSetConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered set configurations.
    
    Specified by:
    
    getSetConfigs in interface ConfigurationService
    
    Returns:
    
    registered set configurations
  - findReplicatedMapConfig
```
public ReplicatedMapConfig findReplicatedMapConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Replicated Map Config
    
    Specified by:
    
    findReplicatedMapConfig in interface ConfigurationService
    
    Returns:
    
    Replicated Map Config or null when requested Replicated Map configuration does not exist
  - getReplicatedMapConfigs
```
public ConcurrentMap<String,ReplicatedMapConfig> getReplicatedMapConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered replicated map configurations.
    
    Specified by:
    
    getReplicatedMapConfigs in interface ConfigurationService
    
    Returns:
    
    registered replicated map configurations
  - findReliableTopicConfig
```
public ReliableTopicConfig findReliableTopicConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Reliable Topic Config
    
    Specified by:
    
    findReliableTopicConfig in interface ConfigurationService
    
    Returns:
    
    Reliable Topic Config or null when requested Reliable Topic configuration does not exist
  - getReliableTopicConfigs
```
public ConcurrentMap<String,ReliableTopicConfig> getReliableTopicConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered reliable topic configurations.
    
    Specified by:
    
    getReliableTopicConfigs in interface ConfigurationService
    
    Returns:
    
    registered reliable topic configurations
  - findCacheSimpleConfig
```
public CacheSimpleConfig findCacheSimpleConfig(String name)
```
    Description copied from interface: ConfigurationService
    
    Find existing Cache Config
    
    Specified by:
    
    findCacheSimpleConfig in interface ConfigurationService
    
    Returns:
    
    Cache Config or null when requested Cache configuration does not exist
  - getCacheSimpleConfigs
```
public Map<String,CacheSimpleConfig> getCacheSimpleConfigs()
```
    Description copied from interface: ConfigurationService
    
    Return all registered cache configurations.
    
    Specified by:
    
    getCacheSimpleConfigs in interface ConfigurationService
    
    Returns:
    
    registered cache configurations
  - findCacheEventJournalConfig
```
public EventJournalConfig findCacheEventJournalConfig(String name)
```
    Specified by:
    
    findCacheEventJournalConfig in interface ConfigurationService
  - getCacheEventJournalConfigs
```
public Map<String,EventJournalConfig> getCacheEventJournalConfigs()
```
    Specified by:
    
    getCacheEventJournalConfigs in interface ConfigurationService
  - findMapEventJournalConfig
```
public EventJournalConfig findMapEventJournalConfig(String name)
```
    Specified by:
    
    findMapEventJournalConfig in interface ConfigurationService
  - getMapEventJournalConfigs
```
public Map<String,EventJournalConfig> getMapEventJournalConfigs()
```
    Specified by:
    
    getMapEventJournalConfigs in interface ConfigurationService
  - prepareMergeRunnable
```
public Runnable prepareMergeRunnable()
```
    Description copied from interface: SplitBrainHandlerService
    
    When the 2 separate clusters merge (resolve a split brain), this method is called to return a Runnable that will merge the clusters.
    
    Specified by:
    
    prepareMergeRunnable in interface SplitBrainHandlerService
    
    Returns:
    
    a Runnable that will merge the clusters

Class ClusterWideConfigurationService

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE_NAME

CONFIG_PUBLISH_MAX_ATTEMPT_COUNT

Constructor Detail

ClusterWideConfigurationService

Method Detail

prepareReplicationOperation

beforeMigration

commitMigration

rollbackMigration

onClusterVersionChange

init

reset

shutdown

broadcastConfig

registerConfigLocally

findMultiMapConfig

getMultiMapConfigs

findMapConfig

getMapConfigs

findTopicConfig

getTopicConfigs

findCardinalityEstimatorConfig

getCardinalityEstimatorConfigs

findExecutorConfig

getExecutorConfigs

findScheduledExecutorConfig

getScheduledExecutorConfigs

findDurableExecutorConfig

getDurableExecutorConfigs

findSemaphoreConfig

getSemaphoreConfigs

findRingbufferConfig

getRingbufferConfigs

findLockConfig

getLockConfigs

findListConfig

getListConfigs

findQueueConfig

getQueueConfigs

findSetConfig

getSetConfigs

findReplicatedMapConfig

getReplicatedMapConfigs

findReliableTopicConfig

getReliableTopicConfigs

findCacheSimpleConfig

getCacheSimpleConfigs

findCacheEventJournalConfig

getCacheEventJournalConfigs

findMapEventJournalConfig

getMapEventJournalConfigs

prepareMergeRunnable