Class Config
- Direct Known Subclasses:
ClasspathXmlConfig
,ClasspathYamlConfig
,FileSystemXmlConfig
,FileSystemYamlConfig
,InMemoryXmlConfig
,InMemoryYamlConfig
,UrlXmlConfig
,UrlYamlConfig
public class Config extends Object
HazelcastInstance
. A Config can be created
programmatically, but can also be configured using XML, see
XmlConfigBuilder
.
Config instances can be shared between threads, but should not be modified after they are used to create HazelcastInstances.
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_CLUSTER_NAME
Default cluster name. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description Config
addCacheConfig(CacheSimpleConfig cacheConfig)
Adds the cache configuration.Config
addCardinalityEstimatorConfig(CardinalityEstimatorConfig cardinalityEstimatorConfig)
Adds the cardinality estimator configuration.Config
addDurableExecutorConfig(DurableExecutorConfig durableExecutorConfig)
Adds the durable executor configuration.Config
addExecutorConfig(ExecutorConfig executorConfig)
Adds the executor configuration.Config
addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig config)
Adds a flake ID generator configuration.Config
addListConfig(ListConfig listConfig)
Adds the list configuration.Config
addListenerConfig(ListenerConfig listenerConfig)
Adds a configuration for anEventListener
.Config
addMapConfig(MapConfig mapConfig)
Adds the map configuration.Config
addMultiMapConfig(MultiMapConfig multiMapConfig)
Adds the multimap configuration.Config
addPNCounterConfig(PNCounterConfig pnCounterConfig)
Adds the PN counter configuration.Config
addQueueConfig(QueueConfig queueConfig)
Adds the queue configuration.Config
addReliableTopicConfig(ReliableTopicConfig topicConfig)
Adds the reliable topic configuration.Config
addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)
Adds the replicated map configuration.Config
addRingBufferConfig(RingbufferConfig ringbufferConfig)
Adds the ringbuffer configuration.Config
addScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)
Adds the scheduled executor configuration.Config
addSetConfig(SetConfig setConfig)
Adds the set configuration.Config
addSplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
Adds the split-brain protection configuration.Config
addTopicConfig(TopicConfig topicConfig)
Adds the topic configuration.Config
addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)
Adds the WAN replication config under the name defined byWanReplicationConfig.getName()
.CacheSimpleConfig
findCacheConfig(String name)
Returns a read-onlyCacheSimpleConfig
configuration for the given name.CacheSimpleConfig
findCacheConfigOrNull(String name)
Returns the cache config with the given name ornull
if there is none.CardinalityEstimatorConfig
findCardinalityEstimatorConfig(String name)
Returns a read-onlyCardinalityEstimator
configuration for the given name.DurableExecutorConfig
findDurableExecutorConfig(String name)
Returns a read-only durable executor configuration for the given name.ExecutorConfig
findExecutorConfig(String name)
Returns a read-only executor configuration for the given name.FlakeIdGeneratorConfig
findFlakeIdGeneratorConfig(String name)
Returns aFlakeIdGeneratorConfig
configuration for the given flake ID generator name.ListConfig
findListConfig(String name)
Returns a read-onlyIList
configuration for the given name.MapConfig
findMapConfig(String name)
Returns a read-onlyIMap
configuration for the given name.MultiMapConfig
findMultiMapConfig(String name)
Returns a read-onlyMultiMap
configuration for the given name.PNCounterConfig
findPNCounterConfig(String name)
Returns a read-onlyPNCounterConfig
configuration for the given name.QueueConfig
findQueueConfig(String name)
Returns a read-onlyIQueue
configuration for the given name.ReliableTopicConfig
findReliableTopicConfig(String name)
Returns a read-only reliable topic configuration for the given name.ReplicatedMapConfig
findReplicatedMapConfig(String name)
Returns a read-onlyReplicatedMap
configuration for the given name.RingbufferConfig
findRingbufferConfig(String name)
Returns a read-onlyRingbuffer
configuration for the given name.ScheduledExecutorConfig
findScheduledExecutorConfig(String name)
Returns a read-only scheduled executor configuration for the given name.SetConfig
findSetConfig(String name)
Returns a read-onlyISet
configuration for the given name.SplitBrainProtectionConfig
findSplitBrainProtectionConfig(String name)
Returns a read-only split-brain protection configuration for the given name.TopicConfig
findTopicConfig(String name)
Returns a read-onlyITopic
configuration for the given name.AdvancedNetworkConfig
getAdvancedNetworkConfig()
AuditlogConfig
getAuditlogConfig()
CacheSimpleConfig
getCacheConfig(String name)
Returns the CacheSimpleConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,CacheSimpleConfig>
getCacheConfigs()
Returns the map of cache configurations, mapped by config name.CardinalityEstimatorConfig
getCardinalityEstimatorConfig(String name)
Returns the CardinalityEstimatorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,CardinalityEstimatorConfig>
getCardinalityEstimatorConfigs()
Returns the map of cardinality estimator configurations, mapped by config name.ClassLoader
getClassLoader()
Returns the class-loader that will be used in serialization.String
getClusterName()
Returns the cluster name uniquely identifying the hazelcast cluster.ConfigPatternMatcher
getConfigPatternMatcher()
Returns the pattern matcher which is used to match item names to configuration objects.File
getConfigurationFile()
URL
getConfigurationUrl()
CPSubsystemConfig
getCPSubsystemConfig()
Get current configuration for the CP subsystemCRDTReplicationConfig
getCRDTReplicationConfig()
DurableExecutorConfig
getDurableExecutorConfig(String name)
Returns the DurableExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,DurableExecutorConfig>
getDurableExecutorConfigs()
Returns the map of durable executor configurations, mapped by config name.ExecutorConfig
getExecutorConfig(String name)
Returns the ExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,ExecutorConfig>
getExecutorConfigs()
Returns the map of executor configurations, mapped by config name.FlakeIdGeneratorConfig
getFlakeIdGeneratorConfig(String name)
Returns theFlakeIdGeneratorConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,FlakeIdGeneratorConfig>
getFlakeIdGeneratorConfigs()
Returns the map ofFlakeIdGenerator
configurations, mapped by config name.HotRestartPersistenceConfig
getHotRestartPersistenceConfig()
Returns the Hot Restart configuration for this hazelcast instanceString
getInstanceName()
Returns the instance name uniquely identifying the hazelcast instance created by this configuration.InstanceTrackingConfig
getInstanceTrackingConfig()
Returns the configuration for tracking use of this Hazelcast instance.String
getLicenseKey()
Returns the license key for this hazelcast instance.ListConfig
getListConfig(String name)
Returns the ListConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,ListConfig>
getListConfigs()
Returns the map ofIList
configurations, mapped by config name.List<ListenerConfig>
getListenerConfigs()
Returns the list ofEventListener
configurations.ManagedContext
getManagedContext()
Returns the external managed context.ManagementCenterConfig
getManagementCenterConfig()
Returns the management center configuration for this hazelcast instance.MapConfig
getMapConfig(String name)
Returns the MapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.MapConfig
getMapConfigOrNull(String name)
Returns the map config with the given name ornull
if there is none.Map<String,MapConfig>
getMapConfigs()
Returns the map ofIMap
configurations, mapped by config name.MemberAttributeConfig
getMemberAttributeConfig()
Returns the member attribute configuration.MetricsConfig
getMetricsConfig()
Returns the metrics collection config.MultiMapConfig
getMultiMapConfig(String name)
Returns the MultiMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,MultiMapConfig>
getMultiMapConfigs()
Returns the map ofMultiMap
configurations, mapped by config name.NativeMemoryConfig
getNativeMemoryConfig()
Returns the native memory configuration for this hazelcast instance.NetworkConfig
getNetworkConfig()
Returns the network configuration for this hazelcast instance.PartitionGroupConfig
getPartitionGroupConfig()
Returns the partition group configuration for this hazelcast instance.PNCounterConfig
getPNCounterConfig(String name)
Returns thePNCounterConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,PNCounterConfig>
getPNCounterConfigs()
Returns the map of PN counter configurations, mapped by config name.Properties
getProperties()
Returns the properties set on this config instance.String
getProperty(String name)
Returns the value for a named property.QueueConfig
getQueueConfig(String name)
Returns the QueueConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,QueueConfig>
getQueueConfigs()
Returns the map ofIQueue
configurations, mapped by config name.ReliableTopicConfig
getReliableTopicConfig(String name)
Returns the ReliableTopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,ReliableTopicConfig>
getReliableTopicConfigs()
Returns the map of reliable topic configurations, mapped by config name.ReplicatedMapConfig
getReplicatedMapConfig(String name)
Returns the ReplicatedMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,ReplicatedMapConfig>
getReplicatedMapConfigs()
Returns the map ofReplicatedMap
configurations, mapped by config name.RingbufferConfig
getRingbufferConfig(String name)
Returns the RingbufferConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,RingbufferConfig>
getRingbufferConfigs()
Returns the map ofRingbuffer
configurations, mapped by config name.ScheduledExecutorConfig
getScheduledExecutorConfig(String name)
Returns the ScheduledExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,ScheduledExecutorConfig>
getScheduledExecutorConfigs()
Returns the map of scheduled executor configurations, mapped by config name.SecurityConfig
getSecurityConfig()
Returns the security configuration for this hazelcast instance.SerializationConfig
getSerializationConfig()
Returns the serialization configuration for this hazelcast instance.protected com.hazelcast.internal.config.ServicesConfig
getServicesConfig()
Returns the configuration for the user services managed by this hazelcast instance.SetConfig
getSetConfig(String name)
Returns the SetConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,SetConfig>
getSetConfigs()
Returns the map ofISet
configurations, mapped by config name.SplitBrainProtectionConfig
getSplitBrainProtectionConfig(String name)
Returns theSplitBrainProtectionConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,SplitBrainProtectionConfig>
getSplitBrainProtectionConfigs()
Returns the map of split brain protection configurations, mapped by config name.SqlConfig
getSqlConfig()
TopicConfig
getTopicConfig(String name)
Returns the TopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Map<String,TopicConfig>
getTopicConfigs()
Returns the map of reliable topic configurations, mapped by config name.UserCodeDeploymentConfig
getUserCodeDeploymentConfig()
Get current configuration of User Code Deployment.ConcurrentMap<String,Object>
getUserContext()
Returns the user supplied context.WanReplicationConfig
getWanReplicationConfig(String name)
Returns the WAN replication configuration with the givenname
.Map<String,WanReplicationConfig>
getWanReplicationConfigs()
Returns the map of WAN replication configurations, mapped by config name.boolean
isLiteMember()
Returnstrue
if this member is a lite member.static Config
load()
Populates HazelcastConfig
object from an external configuration file.Config
setAdvancedNetworkConfig(AdvancedNetworkConfig advancedNetworkConfig)
Config
setAuditlogConfig(AuditlogConfig auditlogConfig)
Config
setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)
Sets the map of cache configurations, mapped by config name.Config
setCardinalityEstimatorConfigs(Map<String,CardinalityEstimatorConfig> cardinalityEstimatorConfigs)
Sets the map of cardinality estimator configurations, mapped by config name.Config
setClassLoader(ClassLoader classLoader)
Sets the class-loader to be used during de-serialization and as context class-loader of Hazelcast internal threads.Config
setClusterName(String clusterName)
Sets the cluster name uniquely identifying the hazelcast cluster.Config
setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
Sets the pattern matcher which is used to match item names to configuration objects.Config
setConfigurationFile(File configurationFile)
Sets theFile
from which this configuration has been retrieved and created.Config
setConfigurationUrl(URL configurationUrl)
Sets theURL
from which this configuration has been retrieved and created.Config
setCPSubsystemConfig(CPSubsystemConfig cpSubsystemConfig)
Set CP subsystem configurationConfig
setCRDTReplicationConfig(CRDTReplicationConfig crdtReplicationConfig)
Sets the replication configuration forCRDT
implementations.Config
setDurableExecutorConfigs(Map<String,DurableExecutorConfig> durableExecutorConfigs)
Sets the map of durable executor configurations, mapped by config name.Config
setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)
Sets the map of executor configurations, mapped by config name.Config
setFlakeIdGeneratorConfigs(Map<String,FlakeIdGeneratorConfig> map)
Sets the map ofFlakeIdGenerator
configurations, mapped by config name.Config
setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
Sets the Hot Restart configuration.Config
setInstanceName(String instanceName)
Sets the instance name uniquely identifying the hazelcast instance created by this configuration.Config
setInstanceTrackingConfig(InstanceTrackingConfig instanceTrackingConfig)
Returns the configuration for tracking use of this Hazelcast instance.Config
setLicenseKey(String licenseKey)
Sets the license key for this hazelcast instance.Config
setListConfigs(Map<String,ListConfig> listConfigs)
Sets the map ofIList
configurations, mapped by config name.Config
setListenerConfigs(List<ListenerConfig> listenerConfigs)
Sets the list ofEventListener
configurations.Config
setLiteMember(boolean liteMember)
Sets the flag to indicate if this member is a lite member.Config
setManagedContext(ManagedContext managedContext)
Sets the external managed context.Config
setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)
Sets the management center configuration for this hazelcast instance.Config
setMapConfigs(Map<String,MapConfig> mapConfigs)
Sets the map ofIMap
configurations, mapped by config name.Config
setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)
Sets the member attribute configuration.Config
setMetricsConfig(MetricsConfig metricsConfig)
Sets the metrics collection config.Config
setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)
Sets the map ofMultiMap
configurations, mapped by config name.Config
setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
Sets the native memory configuration for this hazelcast instance.Config
setNetworkConfig(NetworkConfig networkConfig)
Sets the network configuration for this hazelcast instance.Config
setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)
Sets the partition group configuration for this hazelcast instance.Config
setPNCounterConfigs(Map<String,PNCounterConfig> pnCounterConfigs)
Sets the map of PN counter configurations, mapped by config name.Config
setProperties(Properties properties)
Sets the properties for this config instance.Config
setProperty(String name, String value)
Sets the value of a named property.Config
setQueueConfigs(Map<String,QueueConfig> queueConfigs)
Sets the map ofIQueue
configurations, mapped by config name.Config
setReliableTopicConfigs(Map<String,ReliableTopicConfig> reliableTopicConfigs)
Sets the map of reliable topic configurations, mapped by config name.Config
setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)
Sets the map ofReplicatedMap
configurations, mapped by config name.Config
setRingbufferConfigs(Map<String,RingbufferConfig> ringbufferConfigs)
Sets the map ofRingbuffer
configurations, mapped by config name.Config
setScheduledExecutorConfigs(Map<String,ScheduledExecutorConfig> scheduledExecutorConfigs)
Sets the map of scheduled executor configurations, mapped by config name.Config
setSecurityConfig(SecurityConfig securityConfig)
Sets the security configuration for this hazelcast instance.Config
setSerializationConfig(SerializationConfig serializationConfig)
Sets the serialization configuration for this hazelcast instance.Config
setSetConfigs(Map<String,SetConfig> setConfigs)
Sets the map ofISet
configurations, mapped by config name.Config
setSplitBrainProtectionConfigs(Map<String,SplitBrainProtectionConfig> splitBrainProtectionConfigs)
Sets the map of split-brain protection configurations, mapped by config name.Config
setSqlConfig(SqlConfig sqlConfig)
Sets SQL config.Config
setTopicConfigs(Map<String,TopicConfig> topicConfigs)
Sets the map ofITopic
configurations, mapped by config name.Config
setUserCodeDeploymentConfig(UserCodeDeploymentConfig userCodeDeploymentConfig)
Set User Code Deployment configurationConfig
setUserContext(ConcurrentMap<String,Object> userContext)
Sets the user supplied context.Config
setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)
Sets the map of WAN replication configurations, mapped by config name.String
toString()
-
Field Details
-
DEFAULT_CLUSTER_NAME
Default cluster name.- See Also:
- Constant Field Values
-
-
Constructor Details
-
Method Details
-
load
Populates HazelcastConfig
object from an external configuration file.It tries to load Hazelcast configuration from a list of well-known locations, and then applies overrides found in environment variables/system properties When no location contains Hazelcast configuration then it returns default.
Note that the same mechanism is used when calling
Hazelcast.newHazelcastInstance()
.- Returns:
- Config created from a file when exists, otherwise default.
-
getClassLoader
Returns the class-loader that will be used in serialization.If
null
, then thread context class-loader will be used instead.- Returns:
- the class-loader
-
setClassLoader
Sets the class-loader to be used during de-serialization and as context class-loader of Hazelcast internal threads.If not set (or set to
null
); thread context class-loader will be used in required places.Default value is
null
.- Parameters:
classLoader
- class-loader to be used during de-serialization- Returns:
- Config instance
-
getConfigPatternMatcher
Returns the pattern matcher which is used to match item names to configuration objects. By default theMatchingPointConfigPatternMatcher
is used.- Returns:
- the pattern matcher
-
setConfigPatternMatcher
Sets the pattern matcher which is used to match item names to configuration objects. By default theMatchingPointConfigPatternMatcher
is used.- Parameters:
configPatternMatcher
- the pattern matcher- Returns:
- this configuration
- Throws:
IllegalArgumentException
- if the pattern matcher isnull
-
getProperty
Returns the value for a named property. If it has not been previously set, it will try to get the value from the system properties.- Parameters:
name
- property name- Returns:
- property value
- See Also:
setProperty(String, String)
, Hazelcast System Properties
-
setProperty
Sets the value of a named property.- Parameters:
name
- property namevalue
- value of the property- Returns:
- this config instance
- See Also:
- Hazelcast System Properties
-
getMemberAttributeConfig
Returns the member attribute configuration. Unlike the config properties (seesetProperties(Properties)
), member attributes are exchanged with other members, e.g. on membership events.- Returns:
- the member attribute configuration
-
setMemberAttributeConfig
Sets the member attribute configuration. Unlike the config properties (seesetProperties(Properties)
), member attributes are exchanged with other members, e.g. on membership events.- Parameters:
memberAttributeConfig
- the member attribute configuration- Returns:
- this configuration
-
getProperties
Returns the properties set on this config instance. These properties are specific to this config and this hazelcast instance.- Returns:
- the config properties
-
setProperties
Sets the properties for this config instance. These properties are specific to this config and this hazelcast instance.- Parameters:
properties
- the config properties- Returns:
- this config instance
-
getInstanceName
Returns the instance name uniquely identifying the hazelcast instance created by this configuration. This name is used in different scenarios, such as identifying the hazelcast instance when running multiple instances in the same JVM.- Returns:
- the hazelcast instance name
-
setInstanceName
Sets the instance name uniquely identifying the hazelcast instance created by this configuration. This name is used in different scenarios, such as identifying the hazelcast instance when running multiple instances in the same JVM.- Parameters:
instanceName
- the hazelcast instance name- Returns:
- this config instance
-
getClusterName
Returns the cluster name uniquely identifying the hazelcast cluster. This name is used in different scenarios, such as identifying cluster for WAN publisher.- Returns:
- the cluster name.
-
setClusterName
Sets the cluster name uniquely identifying the hazelcast cluster. This name is used in different scenarios, such as identifying cluster for WAN publisher.- Parameters:
clusterName
- the new cluster name- Returns:
- this config instance
- Throws:
IllegalArgumentException
- if name isnull
-
getNetworkConfig
Returns the network configuration for this hazelcast instance. The network configuration defines how a member will interact with other members or clients.- Returns:
- the network configuration
-
setNetworkConfig
Sets the network configuration for this hazelcast instance. The network configuration defines how a member will interact with other members or clients.- Parameters:
networkConfig
- the network configuration- Returns:
- this config instance
-
findMapConfig
Returns a read-onlyIMap
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
. For non-default configurations and on-heap maps, it will also initialise the Near Cache eviction if not previously set.- Parameters:
name
- name of the map config- Returns:
- the map configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getMapConfigOrNull
Returns the map config with the given name ornull
if there is none. The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the givenname
.- Parameters:
name
- name of the map config- Returns:
- the map configuration or
null
if none was found - Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getMapConfig
Returns the MapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addMapConfig(MapConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the map config- Returns:
- the map configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addMapConfig
Adds the map configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
mapConfig
- the map configuration- Returns:
- this config instance
-
getMapConfigs
Returns the map ofIMap
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the map configurations mapped by config name
-
setMapConfigs
Sets the map ofIMap
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
mapConfigs
- the IMap configuration map to set- Returns:
- this config instance
-
findCacheConfig
Returns a read-onlyCacheSimpleConfig
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the cardinality estimator config- Returns:
- the cache configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
findCacheConfigOrNull
Returns the cache config with the given name ornull
if there is none. The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the givenname
.- Parameters:
name
- name of the cache config- Returns:
- the cache configuration or
null
if none was found - Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getCacheConfig
Returns the CacheSimpleConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addCacheConfig(CacheSimpleConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the cache config- Returns:
- the cache configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addCacheConfig
Adds the cache configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
cacheConfig
- the cache configuration- Returns:
- this config instance
-
getCacheConfigs
Returns the map of cache configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the cache configurations mapped by config name
-
setCacheConfigs
Sets the map of cache configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Parameters:
cacheConfigs
- the cacheConfigs to set- Returns:
- this config instance
-
findQueueConfig
Returns a read-onlyIQueue
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the queue config- Returns:
- the queue configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getQueueConfig
Returns the QueueConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addQueueConfig(QueueConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the queue config- Returns:
- the queue configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addQueueConfig
Adds the queue configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
queueConfig
- the queue configuration- Returns:
- this config instance
-
getQueueConfigs
Returns the map ofIQueue
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the queue configurations mapped by config name
-
setQueueConfigs
Sets the map ofIQueue
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
queueConfigs
- the queue configuration map to set- Returns:
- this config instance
-
findListConfig
Returns a read-onlyIList
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the list config- Returns:
- the list configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getListConfig
Returns the ListConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addListConfig(ListConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the list config- Returns:
- the list configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addListConfig
Adds the list configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
listConfig
- the list configuration- Returns:
- this config instance
-
getListConfigs
Returns the map ofIList
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the list configurations mapped by config name
-
setListConfigs
Sets the map ofIList
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
listConfigs
- the list configuration map to set- Returns:
- this config instance
-
findSetConfig
Returns a read-onlyISet
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the set config- Returns:
- the set configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getSetConfig
Returns the SetConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addSetConfig(SetConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the set config- Returns:
- the set configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addSetConfig
Adds the set configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
setConfig
- the set configuration- Returns:
- this config instance
-
getSetConfigs
Returns the map ofISet
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the set configurations mapped by config name
-
setSetConfigs
Sets the map ofISet
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
setConfigs
- the set configuration map to set- Returns:
- this config instance
-
findMultiMapConfig
Returns a read-onlyMultiMap
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the multimap config- Returns:
- the multimap configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getMultiMapConfig
Returns the MultiMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addMultiMapConfig(MultiMapConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the multimap config- Returns:
- the multimap configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addMultiMapConfig
Adds the multimap configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
multiMapConfig
- the multimap configuration- Returns:
- this config instance
-
getMultiMapConfigs
Returns the map ofMultiMap
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the multimap configurations mapped by config name
-
setMultiMapConfigs
Sets the map ofMultiMap
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
multiMapConfigs
- the multimap configuration map to set- Returns:
- this config instance
-
findReplicatedMapConfig
Returns a read-onlyReplicatedMap
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the replicated map config- Returns:
- the replicated map configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getReplicatedMapConfig
Returns the ReplicatedMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addReplicatedMapConfig(ReplicatedMapConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the replicated map config- Returns:
- the replicated map configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addReplicatedMapConfig
Adds the replicated map configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
replicatedMapConfig
- the replicated map configuration- Returns:
- this config instance
-
getReplicatedMapConfigs
Returns the map ofReplicatedMap
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the replicate map configurations mapped by config name
-
setReplicatedMapConfigs
Sets the map ofReplicatedMap
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
replicatedMapConfigs
- the replicated map configuration map to set- Returns:
- this config instance
-
findRingbufferConfig
Returns a read-onlyRingbuffer
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the ringbuffer config- Returns:
- the ringbuffer configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getRingbufferConfig
Returns the RingbufferConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addRingBufferConfig(RingbufferConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the ringbuffer config- Returns:
- the ringbuffer configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addRingBufferConfig
Adds the ringbuffer configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
ringbufferConfig
- the ringbuffer configuration- Returns:
- this config instance
-
getRingbufferConfigs
Returns the map ofRingbuffer
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the ringbuffer configurations mapped by config name
-
setRingbufferConfigs
Sets the map ofRingbuffer
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
ringbufferConfigs
- the ringbuffer configuration map to set- Returns:
- this config instance
-
findTopicConfig
Returns a read-onlyITopic
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the topic config- Returns:
- the topic configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getTopicConfig
Returns the TopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addTopicConfig(TopicConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the topic config- Returns:
- the topic configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addTopicConfig
Adds the topic configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
topicConfig
- the topic configuration- Returns:
- this config instance
-
findReliableTopicConfig
Returns a read-only reliable topic configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the reliable topic config- Returns:
- the reliable topic configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getReliableTopicConfig
Returns the ReliableTopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addReliableTopicConfig(ReliableTopicConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the reliable topic config- Returns:
- the reliable topic configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getReliableTopicConfigs
Returns the map of reliable topic configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the reliable topic configurations mapped by config name
-
addReliableTopicConfig
Adds the reliable topic configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
topicConfig
- the reliable topic configuration- Returns:
- this config instance
-
setReliableTopicConfigs
Sets the map of reliable topic configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
reliableTopicConfigs
- the reliable topic configuration map to set- Returns:
- this config instance
-
getTopicConfigs
Returns the map of reliable topic configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the reliable topic configurations mapped by config name
-
setTopicConfigs
Sets the map ofITopic
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
topicConfigs
- the topic configuration map to set- Returns:
- this config instance
-
findExecutorConfig
Returns a read-only executor configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the executor config- Returns:
- the executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
findDurableExecutorConfig
Returns a read-only durable executor configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the durable executor config- Returns:
- the durable executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
findScheduledExecutorConfig
Returns a read-only scheduled executor configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the scheduled executor config- Returns:
- the scheduled executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
findCardinalityEstimatorConfig
Returns a read-onlyCardinalityEstimator
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the cardinality estimator config- Returns:
- the cardinality estimator configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
findPNCounterConfig
Returns a read-onlyPNCounterConfig
configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the PN counter config- Returns:
- the PN counter configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
getExecutorConfig
Returns the ExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addExecutorConfig(ExecutorConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the executor config- Returns:
- the executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getDurableExecutorConfig
Returns the DurableExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addDurableExecutorConfig(DurableExecutorConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the durable executor config- Returns:
- the durable executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getScheduledExecutorConfig
Returns the ScheduledExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addScheduledExecutorConfig(ScheduledExecutorConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the scheduled executor config- Returns:
- the scheduled executor configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getCardinalityEstimatorConfig
Returns the CardinalityEstimatorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addCardinalityEstimatorConfig(CardinalityEstimatorConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the cardinality estimator config- Returns:
- the cardinality estimator configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getPNCounterConfig
Returns thePNCounterConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addPNCounterConfig(PNCounterConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the PN counter config- Returns:
- the PN counter configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addExecutorConfig
Adds the executor configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
executorConfig
- executor config to add- Returns:
- this config instance
-
addDurableExecutorConfig
Adds the durable executor configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
durableExecutorConfig
- durable executor config to add- Returns:
- this config instance
-
addScheduledExecutorConfig
Adds the scheduled executor configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
scheduledExecutorConfig
- scheduled executor config to add- Returns:
- this config instance
-
addCardinalityEstimatorConfig
Adds the cardinality estimator configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
cardinalityEstimatorConfig
- cardinality estimator config to add- Returns:
- this config instance
-
addPNCounterConfig
Adds the PN counter configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
pnCounterConfig
- PN counter config to add- Returns:
- this config instance
-
getExecutorConfigs
Returns the map of executor configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the executor configurations mapped by config name
-
setExecutorConfigs
Sets the map of executor configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
executorConfigs
- the executor configuration map to set- Returns:
- this config instance
-
getDurableExecutorConfigs
Returns the map of durable executor configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the durable executor configurations mapped by config name
-
setDurableExecutorConfigs
Sets the map of durable executor configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
durableExecutorConfigs
- the durable executor configuration map to set- Returns:
- this config instance
-
getScheduledExecutorConfigs
Returns the map of scheduled executor configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the scheduled executor configurations mapped by config name
-
setScheduledExecutorConfigs
public Config setScheduledExecutorConfigs(Map<String,ScheduledExecutorConfig> scheduledExecutorConfigs)Sets the map of scheduled executor configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
scheduledExecutorConfigs
- the scheduled executor configuration map to set- Returns:
- this config instance
-
getCardinalityEstimatorConfigs
Returns the map of cardinality estimator configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the cardinality estimator configurations mapped by config name
-
setCardinalityEstimatorConfigs
public Config setCardinalityEstimatorConfigs(Map<String,CardinalityEstimatorConfig> cardinalityEstimatorConfigs)Sets the map of cardinality estimator configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
cardinalityEstimatorConfigs
- the cardinality estimator configuration map to set- Returns:
- this config instance
-
getPNCounterConfigs
Returns the map of PN counter configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the PN counter configurations mapped by config name
-
setPNCounterConfigs
Sets the map of PN counter configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
pnCounterConfigs
- the PN counter configuration map to set- Returns:
- this config instance
-
getWanReplicationConfig
Returns the WAN replication configuration with the givenname
.- Parameters:
name
- the WAN replication config name- Returns:
- the WAN replication config
-
addWanReplicationConfig
Adds the WAN replication config under the name defined byWanReplicationConfig.getName()
.- Parameters:
wanReplicationConfig
- the WAN replication config- Returns:
- this config instance
-
getWanReplicationConfigs
Returns the map of WAN replication configurations, mapped by config name.- Returns:
- the WAN replication configurations mapped by config name
-
setWanReplicationConfigs
Sets the map of WAN replication configurations, mapped by config name.- Parameters:
wanReplicationConfigs
- the WAN replication configuration map to set- Returns:
- this config instance
-
getSplitBrainProtectionConfigs
Returns the map of split brain protection configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the split-brain protection configurations mapped by config name
-
getSplitBrainProtectionConfig
Returns theSplitBrainProtectionConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addSplitBrainProtectionConfig(SplitBrainProtectionConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the split-brain protection config- Returns:
- the split-brain protection configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
findSplitBrainProtectionConfig
Returns a read-only split-brain protection configuration for the given name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the namedefault
.- Parameters:
name
- name of the split-brain protection config- Returns:
- the split-brain protection configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
,EvictionConfig.setSize(int)
-
setSplitBrainProtectionConfigs
public Config setSplitBrainProtectionConfigs(Map<String,SplitBrainProtectionConfig> splitBrainProtectionConfigs)Sets the map of split-brain protection configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
splitBrainProtectionConfigs
- the split-brain protection configuration map to set- Returns:
- this config instance
-
addSplitBrainProtectionConfig
Adds the split-brain protection configuration. The configuration is saved under the config name defined bySplitBrainProtectionConfig.getName()
.- Parameters:
splitBrainProtectionConfig
- split-brain protection config to add- Returns:
- this config instance
-
getManagementCenterConfig
Returns the management center configuration for this hazelcast instance.- Returns:
- the management center configuration
-
setManagementCenterConfig
Sets the management center configuration for this hazelcast instance.- Parameters:
managementCenterConfig
- the management center configuration- Returns:
- this config instance
-
getSecurityConfig
Returns the security configuration for this hazelcast instance. This includes configuration for security interceptors, permissions, etc.- Returns:
- the security configuration
-
setSecurityConfig
Sets the security configuration for this hazelcast instance. This includes configuration for security interceptors, permissions, etc.- Parameters:
securityConfig
- the security configuration- Returns:
- this config instance
-
addListenerConfig
Adds a configuration for anEventListener
. This includes listeners for events related to this instance/member or the cluster, such as partition, migration, cluster version listeners, etc. but not listeners on specific distributed data structures.- Parameters:
listenerConfig
- the listener configuration- Returns:
- this config instance
-
getListenerConfigs
Returns the list ofEventListener
configurations. This includes listeners for events related to this instance/member or the cluster, such as partition, migration, cluster version listeners, etc. but not listeners on specific distributed data structures.- Returns:
- the listener configurations
-
setListenerConfigs
Sets the list ofEventListener
configurations. This includes listeners for events related to this instance/member or the cluster, such as partition, migration, cluster version listeners, etc. but not listeners on specific distributed data structures.- Parameters:
listenerConfigs
- the listener configurations- Returns:
- this config instance
-
getFlakeIdGeneratorConfigs
Returns the map ofFlakeIdGenerator
configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.- Returns:
- the map configurations mapped by config name
-
findFlakeIdGeneratorConfig
Returns aFlakeIdGeneratorConfig
configuration for the given flake ID generator name.The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given
name
. If there is no config found by the name, it will return the configuration with the name"default"
.- Parameters:
name
- name of the flake ID generator config- Returns:
- the flake ID generator configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
getFlakeIdGeneratorConfig
Returns theFlakeIdGeneratorConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.The configuration is found by matching the configuration name pattern to the provided
name
without the partition qualifier (the part of the name after'@'
). If no configuration matches, it will create one by cloning the"default"
configuration and add it to the configuration collection.This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking
addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig)
.Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
- Parameters:
name
- name of the flake ID generator config- Returns:
- the cache configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- See Also:
StringPartitioningStrategy.getBaseName(java.lang.String)
,setConfigPatternMatcher(ConfigPatternMatcher)
,getConfigPatternMatcher()
-
addFlakeIdGeneratorConfig
Adds a flake ID generator configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.- Parameters:
config
- the flake ID generator configuration- Returns:
- this config instance
-
setFlakeIdGeneratorConfigs
Sets the map ofFlakeIdGenerator
configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.- Parameters:
map
- the FlakeIdGenerator configuration map to set- Returns:
- this config instance
-
getSerializationConfig
Returns the serialization configuration for this hazelcast instance. The serialization configuration defines how objects are serialized and deserialized on this instance.- Returns:
- the serialization configuration
-
setSerializationConfig
Sets the serialization configuration for this hazelcast instance. The serialization configuration defines how objects are serialized and deserialized on this instance.- Parameters:
serializationConfig
- the serialization configuration- Returns:
- this config instance
-
getPartitionGroupConfig
Returns the partition group configuration for this hazelcast instance. The partition group configuration defines how partitions are mapped to members.- Returns:
- the partition group configuration
-
setPartitionGroupConfig
Sets the partition group configuration for this hazelcast instance. The partition group configuration defines how partitions are mapped to members.- Parameters:
partitionGroupConfig
- the partition group configuration- Returns:
- this config instance
-
getHotRestartPersistenceConfig
Returns the Hot Restart configuration for this hazelcast instance- Returns:
- hot restart configuration
-
setHotRestartPersistenceConfig
Sets the Hot Restart configuration.- Parameters:
hrConfig
- Hot Restart configuration- Returns:
- this config instance
- Throws:
NullPointerException
- if thehrConfig
parameter isnull
-
getCRDTReplicationConfig
-
setCRDTReplicationConfig
Sets the replication configuration forCRDT
implementations.- Parameters:
crdtReplicationConfig
- the replication configuration- Returns:
- this config instance
- Throws:
NullPointerException
- if thecrdtReplicationConfig
parameter isnull
-
getManagedContext
Returns the external managed context. This context is used to initialize user supplied objects.- Returns:
- the managed context
-
setManagedContext
Sets the external managed context. This context is used to initialize user supplied objects.- Parameters:
managedContext
- the managed context- Returns:
- this config instance
-
getUserContext
Returns the user supplied context. This context can then be obtained from an instance ofHazelcastInstance
.- Returns:
- the user supplied context
- See Also:
HazelcastInstance.getUserContext()
-
setUserContext
Sets the user supplied context. This context can then be obtained from an instance ofHazelcastInstance
.- Parameters:
userContext
- the user supplied context- Returns:
- this config instance
- See Also:
HazelcastInstance.getUserContext()
-
getNativeMemoryConfig
Returns the native memory configuration for this hazelcast instance. The native memory configuration defines the how native memory is used and the limits on its usage.- Returns:
- the native memory configuration
-
setNativeMemoryConfig
Sets the native memory configuration for this hazelcast instance. The native memory configuration defines the how native memory is used and the limits on its usage.- Parameters:
nativeMemoryConfig
- the native memory configuration- Returns:
- this config instance
-
getConfigurationUrl
Returns theURL
to the declarative configuration, which has been parsed to create thisConfig
instance.- Returns:
- the configuration URL if the configuration loaded from a URL
or
null
otherwise
-
setConfigurationUrl
Sets theURL
from which this configuration has been retrieved and created.Is set by the
XmlConfigBuilder
, when the XML configuration was retrieved from a URL.- Parameters:
configurationUrl
- the configuration URL to set- Returns:
- this config instance
-
getConfigurationFile
Returns theFile
to the declarative configuration, which has been parsed to create thisConfig
instance.- Returns:
- the configuration file if the configuration loaded from a file
or
null
otherwise
-
setConfigurationFile
Sets theFile
from which this configuration has been retrieved and created.Is set by the
XmlConfigBuilder
, when the XML configuration was retrieved from a file.- Parameters:
configurationFile
- the configuration file to set
-
getLicenseKey
Returns the license key for this hazelcast instance. The license key is used to enable enterprise features.- Returns:
- the license key
- Throws:
SecurityException
- If a security manager exists and the calling method doesn't have correspondingHazelcastRuntimePermission
-
setLicenseKey
Sets the license key for this hazelcast instance. The license key is used to enable enterprise features.- Parameters:
licenseKey
- the license key- Returns:
- this config instance
-
isLiteMember
public boolean isLiteMember()Returnstrue
if this member is a lite member. A lite member does not own any partitions.- Returns:
true
if this member is a lite member
-
setLiteMember
Sets the flag to indicate if this member is a lite member. A lite member does not own any partitions.- Parameters:
liteMember
- if this member is a lite member- Returns:
- this config instance
-
getUserCodeDeploymentConfig
Get current configuration of User Code Deployment.- Returns:
- User Code Deployment configuration
- Since:
- 3.8
-
setUserCodeDeploymentConfig
Set User Code Deployment configuration- Parameters:
userCodeDeploymentConfig
- the user code deployment configuration- Returns:
- this config instance
- Since:
- 3.8
-
getAdvancedNetworkConfig
-
setAdvancedNetworkConfig
-
getCPSubsystemConfig
Get current configuration for the CP subsystem- Returns:
- CP subsystem configuration
- Since:
- 3.12
-
setCPSubsystemConfig
Set CP subsystem configuration- Parameters:
cpSubsystemConfig
- the CP subsystem configuration- Returns:
- this config instance
- Since:
- 3.12
-
getMetricsConfig
Returns the metrics collection config. -
setMetricsConfig
Sets the metrics collection config. -
getAuditlogConfig
-
setAuditlogConfig
-
getSqlConfig
- Returns:
- Return SQL config.
-
setSqlConfig
Sets SQL config. -
getInstanceTrackingConfig
Returns the configuration for tracking use of this Hazelcast instance. -
setInstanceTrackingConfig
@Nonnull public Config setInstanceTrackingConfig(@Nonnull InstanceTrackingConfig instanceTrackingConfig)Returns the configuration for tracking use of this Hazelcast instance. -
getServicesConfig
Returns the configuration for the user services managed by this hazelcast instance.- Returns:
- the user services configuration
-
toString
-