com.hazelcast.internal.config

Class ConfigValidator

java.lang.Object

com.hazelcast.internal.config.ConfigValidator

public final class ConfigValidator
extends Object

Validates a Hazelcast configuration in a specific context like OS vs. EE or client vs. member nodes.

Method Summary

Modifier and Type	Method and Description
static void	checkBasicConfig(AbstractBasicConfig basicConfig) Validates the given AbstractBasicConfig.
static void	checkCacheConfig(CacheSimpleConfig cacheSimpleConfig) Validates the given CacheSimpleConfig.
static void	checkCacheConfig(InMemoryFormat inMemoryFormat, EvictionConfig evictionConfig, boolean isStatisticsEnabled, String mergePolicy) Validates the given parameters in the context of a ICache config.
static void	checkCollectionConfig(CollectionConfig collectionConfig) Validates the given CollectionConfig.
static void	checkEvictionConfig(EvictionConfig evictionConfig, boolean isNearCache) Checks if a EvictionConfig is valid in its context.
static void	checkEvictionConfig(EvictionPolicy evictionPolicy, String comparatorClassName, Object comparator, boolean isNearCache) Checks if parameters for an EvictionConfig are valid in their context.
static void	checkLocalUpdatePolicy(String mapName, NearCacheConfig.LocalUpdatePolicy localUpdatePolicy) Checks IMaps' supported Near Cache local update policy configuration.
static void	checkMapConfig(MapConfig mapConfig) Checks preconditions to create a map proxy.
static void	checkMergePolicy(boolean isStatisticsEnabled, String mergePolicy) Throws IllegalArgumentException if the supplied merge policy needs statistics to be enabled.
static boolean	checkMergePolicySupportsInMemoryFormat(String name, String mergePolicy, InMemoryFormat inMemoryFormat, Version clusterVersion, boolean failFast, ILogger logger) Returns true if supplied inMemoryFormat can be merged with the supplied mergePolicy, otherwise returns false.
static void	checkMultiMapConfig(MultiMapConfig multiMapConfig) Validates the given MultiMapConfig.
static void	checkNearCacheConfig(String mapName, NearCacheConfig nearCacheConfig, NativeMemoryConfig nativeMemoryConfig, boolean isClient) Checks preconditions to create a map proxy with Near Cache.
static void	checkQueueConfig(QueueConfig queueConfig) Validates the given QueueConfig.
static void	checkReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig) Validates the given ReplicatedMapConfig.
static void	checkRingbufferConfig(RingbufferConfig ringbufferConfig) Validates the given RingbufferConfig.
static void	checkScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig) Validates the given ScheduledExecutorConfig.

Methods inherited from class java.lang.Object

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

Method Detail

checkMapConfig

public static void checkMapConfig(MapConfig mapConfig)

Checks preconditions to create a map proxy.

Parameters:

mapConfig - the MapConfig

checkNearCacheConfig

public static void checkNearCacheConfig(String mapName,
                                        NearCacheConfig nearCacheConfig,
                                        NativeMemoryConfig nativeMemoryConfig,
                                        boolean isClient)

Checks preconditions to create a map proxy with Near Cache.

Parameters:

mapName - name of the map that Near Cache will be created for

nearCacheConfig - the NearCacheConfig to be checked

isClient - true if the config is for a Hazelcast client, false otherwise

checkLocalUpdatePolicy

public static void checkLocalUpdatePolicy(String mapName,
                                          NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)

Checks IMaps' supported Near Cache local update policy configuration.

Parameters:

mapName - name of the map that Near Cache will be created for

localUpdatePolicy - local update policy

checkEvictionConfig

public static void checkEvictionConfig(EvictionConfig evictionConfig,
                                       boolean isNearCache)

Checks if a EvictionConfig is valid in its context.

Parameters:

evictionConfig - the EvictionConfig

isNearCache - true if the config is for a Near Cache, false otherwise

checkEvictionConfig

public static void checkEvictionConfig(EvictionPolicy evictionPolicy,
                                       String comparatorClassName,
                                       Object comparator,
                                       boolean isNearCache)

Checks if parameters for an EvictionConfig are valid in their context.

Parameters:

evictionPolicy - the EvictionPolicy for the EvictionConfig

comparatorClassName - the comparator class name for the EvictionConfig

comparator - the comparator implementation for the EvictionConfig

isNearCache - true if the config is for a Near Cache, false otherwise

checkCacheConfig

public static void checkCacheConfig(CacheSimpleConfig cacheSimpleConfig)

Validates the given CacheSimpleConfig.

Parameters:

cacheSimpleConfig - the CacheSimpleConfig to check

checkCacheConfig

public static void checkCacheConfig(InMemoryFormat inMemoryFormat,
                                    EvictionConfig evictionConfig,
                                    boolean isStatisticsEnabled,
                                    String mergePolicy)

Validates the given parameters in the context of a ICache config.

Parameters:

inMemoryFormat - the in-memory format the Cache is configured with

evictionConfig - eviction configuration of Cache

isStatisticsEnabled - true if statistics are enabled, false otherwise

mergePolicy - the configured merge policy

checkMergePolicySupportsInMemoryFormat

public static boolean checkMergePolicySupportsInMemoryFormat(String name,
                                                             String mergePolicy,
                                                             InMemoryFormat inMemoryFormat,
                                                             Version clusterVersion,
                                                             boolean failFast,
                                                             ILogger logger)

Returns true if supplied inMemoryFormat can be merged with the supplied mergePolicy, otherwise returns false.

When there is a wrong policy detected, it does one of two things: if fail-fast option is true and cluster version is 3.10 or later, it throws IllegalArgumentException otherwise prints a warning log.

checkReplicatedMapConfig

public static void checkReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)

Validates the given ReplicatedMapConfig.

Parameters:

replicatedMapConfig - the ReplicatedMapConfig to check

checkMultiMapConfig

public static void checkMultiMapConfig(MultiMapConfig multiMapConfig)

Validates the given MultiMapConfig.

Parameters:

multiMapConfig - the MultiMapConfig to check

checkQueueConfig

public static void checkQueueConfig(QueueConfig queueConfig)

Validates the given QueueConfig.

Parameters:

queueConfig - the QueueConfig to check

checkCollectionConfig

public static void checkCollectionConfig(CollectionConfig collectionConfig)

Validates the given CollectionConfig.

Parameters:

collectionConfig - the CollectionConfig to check

checkRingbufferConfig

public static void checkRingbufferConfig(RingbufferConfig ringbufferConfig)

Validates the given RingbufferConfig.

Parameters:

ringbufferConfig - the RingbufferConfig to check

checkBasicConfig

public static void checkBasicConfig(AbstractBasicConfig basicConfig)

Validates the given AbstractBasicConfig.

Parameters:

basicConfig - the AbstractBasicConfig to check

checkScheduledExecutorConfig

public static void checkScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)

Validates the given ScheduledExecutorConfig.

Parameters:

scheduledExecutorConfig - the ScheduledExecutorConfig to check

checkMergePolicy

public static void checkMergePolicy(boolean isStatisticsEnabled,
                                    String mergePolicy)

Throws IllegalArgumentException if the supplied merge policy needs statistics to be enabled.

Parameters:

isStatisticsEnabled - true if statistics are enabled, false otherwise

mergePolicy - the configured merge policy