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	checkAdvancedNetworkConfig(Config config)
static boolean	checkAndLogPropertyDeprecated(HazelcastProperties properties, HazelcastProperty hazelcastProperty) Checks if given group property is defined within given Hazelcast properties.
static <C extends AbstractBasicConfig> void	checkBasicConfig(C basicConfig, SplitBrainMergePolicyProvider mergePolicyProvider) Validates the given AbstractBasicConfig implementation.
static void	checkCacheConfig(CacheConfig cacheConfig, CacheMergePolicyProvider mergePolicyProvider) Validates the given CacheConfig.
static void	checkCacheConfig(CacheSimpleConfig cacheSimpleConfig, CacheMergePolicyProvider mergePolicyProvider) Validates the given CacheSimpleConfig.
static void	checkCacheConfig(InMemoryFormat inMemoryFormat, EvictionConfig evictionConfig, String mergePolicyClassname, SplitBrainMergeTypeProvider mergeTypeProvider, CacheMergePolicyProvider mergePolicyProvider) Validates the given parameters in the context of an ICache config.
static void	checkCollectionConfig(CollectionConfig collectionConfig, SplitBrainMergePolicyProvider mergePolicyProvider) Validates the given CollectionConfig.
static void	checkCPSubsystemConfig(CPSubsystemConfig config)
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	checkMapConfig(MapConfig mapConfig, MergePolicyProvider mergePolicyProvider) Validates the given MapConfig.
static void	checkMultiMapConfig(MultiMapConfig multiMapConfig, SplitBrainMergePolicyProvider mergePolicyProvider) 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, SplitBrainMergePolicyProvider mergePolicyProvider) Validates the given QueueConfig.
static void	checkReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig, MergePolicyProvider mergePolicyProvider) Validates the given ReplicatedMapConfig.
static void	checkRingbufferConfig(RingbufferConfig ringbufferConfig, SplitBrainMergePolicyProvider mergePolicyProvider) Validates the given RingbufferConfig.
static void	checkScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig, SplitBrainMergePolicyProvider mergePolicyProvider) Validates the given ScheduledExecutorConfig.
static void	ensurePropertyNotConfigured(HazelcastProperties properties, HazelcastProperty hazelcastProperty) Throws ConfigurationException if given group property is defined within Hazelcast properties.

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,
                                  MergePolicyProvider mergePolicyProvider)

Validates the given MapConfig.

Parameters:

mapConfig - the MapConfig

mergePolicyProvider - the MergePolicyProvider to resolve merge policy classes

checkAdvancedNetworkConfig

public static void checkAdvancedNetworkConfig(Config config)

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

nativeMemoryConfig - the NativeMemoryConfig of the Hazelcast instance

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

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,
                                    CacheMergePolicyProvider mergePolicyProvider)

Validates the given CacheSimpleConfig.

Parameters:

cacheSimpleConfig - the CacheSimpleConfig to check

mergePolicyProvider - the CacheMergePolicyProvider to resolve merge policy classes

checkCacheConfig

public static void checkCacheConfig(CacheConfig cacheConfig,
                                    CacheMergePolicyProvider mergePolicyProvider)

Validates the given CacheConfig.

Parameters:

cacheConfig - the CacheConfig to check

mergePolicyProvider - the CacheMergePolicyProvider to resolve merge policy classes

checkCacheConfig

public static void checkCacheConfig(InMemoryFormat inMemoryFormat,
                                    EvictionConfig evictionConfig,
                                    String mergePolicyClassname,
                                    SplitBrainMergeTypeProvider mergeTypeProvider,
                                    CacheMergePolicyProvider mergePolicyProvider)

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

Parameters:

inMemoryFormat - the InMemoryFormat of the cache

evictionConfig - the EvictionConfig of the cache

mergePolicyClassname - the configured merge policy of the cache

mergeTypeProvider - the SplitBrainMergeTypeProvider of the cache

mergePolicyProvider - the CacheMergePolicyProvider to resolve merge policy classes

checkReplicatedMapConfig

public static void checkReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig,
                                            MergePolicyProvider mergePolicyProvider)

Validates the given ReplicatedMapConfig.

Parameters:

replicatedMapConfig - the ReplicatedMapConfig to check

mergePolicyProvider - the MergePolicyProvider to resolve merge policy classes

checkMultiMapConfig

public static void checkMultiMapConfig(MultiMapConfig multiMapConfig,
                                       SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given MultiMapConfig.

Parameters:

multiMapConfig - the MultiMapConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkQueueConfig

public static void checkQueueConfig(QueueConfig queueConfig,
                                    SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given QueueConfig.

Parameters:

queueConfig - the QueueConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkCollectionConfig

public static void checkCollectionConfig(CollectionConfig collectionConfig,
                                         SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given CollectionConfig.

Parameters:

collectionConfig - the CollectionConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkRingbufferConfig

public static void checkRingbufferConfig(RingbufferConfig ringbufferConfig,
                                         SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given RingbufferConfig.

Parameters:

ringbufferConfig - the RingbufferConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkBasicConfig

public static <C extends AbstractBasicConfig> void checkBasicConfig(C basicConfig,
                                                                    SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given AbstractBasicConfig implementation.

Type Parameters:

C - type of the AbstractBasicConfig

Parameters:

basicConfig - the AbstractBasicConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkScheduledExecutorConfig

public static void checkScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig,
                                                SplitBrainMergePolicyProvider mergePolicyProvider)

Validates the given ScheduledExecutorConfig.

Parameters:

scheduledExecutorConfig - the ScheduledExecutorConfig to check

mergePolicyProvider - the SplitBrainMergePolicyProvider to resolve merge policy classes

checkCPSubsystemConfig

public static void checkCPSubsystemConfig(CPSubsystemConfig config)

ensurePropertyNotConfigured

public static void ensurePropertyNotConfigured(HazelcastProperties properties,
                                               HazelcastProperty hazelcastProperty)
                                        throws ConfigurationException

Throws ConfigurationException if given group property is defined within Hazelcast properties.

Parameters:

properties - Group properties

hazelcastProperty - property to be checked

Throws:

ConfigurationException

checkAndLogPropertyDeprecated

public static boolean checkAndLogPropertyDeprecated(HazelcastProperties properties,
                                                    HazelcastProperty hazelcastProperty)

Checks if given group property is defined within given Hazelcast properties. Logs a warning when the property is defied.

Returns:

true when the property is defined