Class Config
- Direct Known Subclasses:
ClasspathXmlConfig
,ClasspathYamlConfig
,FileSystemXmlConfig
,FileSystemYamlConfig
,InMemoryXmlConfig
,InMemoryYamlConfig
,UrlXmlConfig
,UrlYamlConfig
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.
Unlike Config
instances obtained via load()
and its variants,
a Config
does not apply overrides found in environment variables/system properties.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Default cluster name.protected UserCodeNamespacesConfig
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCacheConfig
(CacheSimpleConfig cacheConfig) Adds the cache configuration.addCardinalityEstimatorConfig
(CardinalityEstimatorConfig cardinalityEstimatorConfig) Adds the cardinality estimator configuration.addDataConnectionConfig
(DataConnectionConfig dataConnectionConfig) Adds a data connection configuration.addDeviceConfig
(DeviceConfig deviceConfig) Adds the device configuration.addDurableExecutorConfig
(DurableExecutorConfig durableExecutorConfig) Adds the durable executor configuration.addExecutorConfig
(ExecutorConfig executorConfig) Adds the executor configuration.Adds a flake ID generator configuration.addListConfig
(ListConfig listConfig) Adds the list configuration.addListenerConfig
(ListenerConfig listenerConfig) Adds a configuration for anEventListener
.addMapConfig
(MapConfig mapConfig) Adds the map configuration.addMultiMapConfig
(MultiMapConfig multiMapConfig) Adds the multimap configuration.addPNCounterConfig
(PNCounterConfig pnCounterConfig) Adds the PN counter configuration.addQueueConfig
(QueueConfig queueConfig) Adds the queue configuration.addReliableTopicConfig
(ReliableTopicConfig topicConfig) Adds the reliable topic configuration.addReplicatedMapConfig
(ReplicatedMapConfig replicatedMapConfig) Adds the replicated map configuration.addRingBufferConfig
(RingbufferConfig ringbufferConfig) Adds the ringbuffer configuration.addScheduledExecutorConfig
(ScheduledExecutorConfig scheduledExecutorConfig) Adds the scheduled executor configuration.addSetConfig
(SetConfig setConfig) Adds the set configuration.addSplitBrainProtectionConfig
(SplitBrainProtectionConfig splitBrainProtectionConfig) Adds the split-brain protection configuration.addTopicConfig
(TopicConfig topicConfig) Adds the topic configuration.addVectorCollectionConfig
(VectorCollectionConfig vectorCollectionConfig) Add vector collection config.addWanReplicationConfig
(WanReplicationConfig wanReplicationConfig) Adds the WAN replication config under the name defined byWanReplicationConfig.getName()
.findCacheConfig
(String name) Returns a read-onlyCacheSimpleConfig
configuration for the given name.findCacheConfigOrNull
(String name) Returns the cache config with the given name ornull
if there is none.Returns a read-onlyCardinalityEstimator
configuration for the given name.Returns a read-onlyDataConnectionConfig
configuration for the given name.Returns a read-only durable executor configuration for the given name.findExecutorConfig
(String name) Returns a read-only executor configuration for the given name.Returns aFlakeIdGeneratorConfig
configuration for the given flake ID generator name.findListConfig
(String name) Returns a read-onlyIList
configuration for the given name.findMapConfig
(String name) Returns a read-onlyIMap
configuration for the given name.findMultiMapConfig
(String name) Returns a read-onlyMultiMap
configuration for the given name.findPNCounterConfig
(String name) Returns a read-onlyPNCounterConfig
configuration for the given name.findQueueConfig
(String name) Returns a read-onlyIQueue
configuration for the given name.Returns a read-only reliable topic configuration for the given name.Returns a read-onlyReplicatedMap
configuration for the given name.findRingbufferConfig
(String name) Returns a read-onlyRingbuffer
configuration for the given name.Returns a read-only scheduled executor configuration for the given name.findSetConfig
(String name) Returns a read-onlyISet
configuration for the given name.Returns a read-only split-brain protection configuration for the given name.findTopicConfig
(String name) Returns a read-onlyITopic
configuration for the given name.getCacheConfig
(String name) Returns the CacheSimpleConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of cache configurations, mapped by config name.Returns the CardinalityEstimatorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of cardinality estimator configurations, mapped by config name.Returns the class-loader that will be used in serialization.Returns the cluster name uniquely identifying the hazelcast cluster.Returns the pattern matcher which is used to match item names to configuration objects.Get current configuration for the CP subsystemReturns the data connection configuration for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of data connection configurations, mapped by config name.<T extends DeviceConfig>
TgetDeviceConfig
(Class<T> clazz, String name) Returns the device config mapped by the provided device name.<T extends DeviceConfig>
TgetDeviceConfig
(String name) Returns the device config mapped by the provided device name.Returns the map ofLocalDeviceConfig
s mapped by device name.Returns the DurableExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of durable executor configurations, mapped by config name.Returns the dynamic configuration config.getExecutorConfig
(String name) Returns the ExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of executor configurations, mapped by config name.Returns theFlakeIdGeneratorConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofFlakeIdGenerator
configurations, mapped by config name.Returns the Hot Restart configuration for this hazelcast instanceReturns the instance name uniquely identifying the hazelcast instance created by this configuration.Returns the configuration for tracking use of this Hazelcast instance.Returns the IntegrityChecker configReturns the Jet configReturns the license key for this hazelcast instance.getListConfig
(String name) Returns the ListConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofIList
configurations, mapped by config name.Returns the list ofEventListener
configurations.Returns the external managed context.Returns the management center configuration for this hazelcast instance.getMapConfig
(String name) Returns the MapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.getMapConfigOrNull
(String name) Returns the map config with the given name ornull
if there is none.Returns the map ofIMap
configurations, mapped by config name.Returns the member attribute configuration.Returns the metrics collection config.getMultiMapConfig
(String name) Returns the MultiMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofMultiMap
configurations, mapped by config name.Returns the native memory configuration for this hazelcast instance.Returns the network configuration for this hazelcast instance.Returns the partition group configuration for this hazelcast instance.Returns the Persistence configuration for this hazelcast instancegetPNCounterConfig
(String name) Returns thePNCounterConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of PN counter configurations, mapped by config name.Returns the properties set on this config instance.getProperty
(String name) Returns the value for a named property.getQueueConfig
(String name) Returns the QueueConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofIQueue
configurations, mapped by config name.getReliableTopicConfig
(String name) Returns the ReliableTopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of reliable topic configurations, mapped by config name.getReplicatedMapConfig
(String name) Returns the ReplicatedMapConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofReplicatedMap
configurations, mapped by config name.Gets the configuration for the REST API server.getRingbufferConfig
(String name) Returns the RingbufferConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofRingbuffer
configurations, mapped by config name.Returns the ScheduledExecutorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of scheduled executor configurations, mapped by config name.Returns the security configuration for this hazelcast instance.Returns the serialization configuration for this hazelcast instance.protected com.hazelcast.internal.config.ServicesConfig
Returns the configuration for the user services managed by this hazelcast instance.getSetConfig
(String name) Returns the SetConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map ofISet
configurations, mapped by config name.Returns theSplitBrainProtectionConfig
for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of split brain protection configurations, mapped by config name.getTopicConfig
(String name) Returns the TopicConfig for the given name, creating one if necessary and adding it to the collection of known configurations.Returns the map of reliable topic configurations, mapped by config name.Gets the TpcConfig.Get current configuration of User Code Deployment.Returns the user supplied context.Get vector collection config.Retrieve configurations for all vector collections.Returns the WAN replication configuration with the givenname
.Returns the map of WAN replication configurations, mapped by config name.boolean
Returnstrue
if this member is a lite member.static Config
load()
Populates HazelcastConfig
object from an external configuration file.static Config
Same asload()
, i.e., loads Config using the default lookup mechanismstatic Config
loadDefault
(Properties properties) Loads Config using the defaultlookup mechanism
to locate the configuration file and applies variable resolution from the provided properties.static Config
loadFromClasspath
(ClassLoader classLoader, String resource) Creates a Config which is loaded from a classpath resource.static Config
loadFromClasspath
(ClassLoader classLoader, String resource, Properties properties) Creates a Config which is loaded from a classpath resource.static Config
loadFromFile
(File configFile) Creates a Config based on a the provided configuration file (XML or YAML) and uses the System.properties to resolve variables in the file.static Config
loadFromFile
(File configFile, Properties properties) Creates a Config based on a the provided configuration file (XML or YAML) and uses the System.properties to resolve variables in the file.static Config
loadFromStream
(InputStream source) Creates a Config from the provided stream (XML or YAML content) and uses the System.properties for variable resolution.static Config
loadFromStream
(InputStream source, Properties properties) Creates a Config from the provided stream (XML or YAML content).static Config
loadFromString
(String source) Creates a Config from the provided string (XML or YAML content) and uses the System.properties for variable resolution.static Config
loadFromString
(String source, Properties properties) Creates a Config from the provided string (XML or YAML content).setAdvancedNetworkConfig
(AdvancedNetworkConfig advancedNetworkConfig) setAuditlogConfig
(AuditlogConfig auditlogConfig) setCacheConfigs
(Map<String, CacheSimpleConfig> cacheConfigs) Sets the map of cache configurations, mapped by config name.setCardinalityEstimatorConfigs
(Map<String, CardinalityEstimatorConfig> cardinalityEstimatorConfigs) Sets the map of cardinality estimator configurations, mapped by config name.setClassLoader
(ClassLoader classLoader) Sets the class-loader to be used during de-serialization and as context class-loader of Hazelcast internal threads.setClusterName
(String clusterName) Sets the cluster name uniquely identifying the hazelcast cluster.setConfigPatternMatcher
(ConfigPatternMatcher configPatternMatcher) Sets the pattern matcher which is used to match item names to configuration objects.setConfigurationFile
(File configurationFile) Sets theFile
from which this configuration has been retrieved and created.setConfigurationUrl
(URL configurationUrl) Sets theURL
from which this configuration has been retrieved and created.setCPSubsystemConfig
(CPSubsystemConfig cpSubsystemConfig) Set CP subsystem configurationsetCRDTReplicationConfig
(CRDTReplicationConfig crdtReplicationConfig) Sets the replication configuration forCRDT
implementations.setDataConnectionConfigs
(Map<String, DataConnectionConfig> dataConnectionConfigs) Sets the map of data connection configurations, mapped by config name.setDeviceConfigs
(Map<String, DeviceConfig> deviceConfigs) Sets the map ofDeviceConfig
s mapped by device name.setDurableExecutorConfigs
(Map<String, DurableExecutorConfig> durableExecutorConfigs) Sets the map of durable executor configurations, mapped by config name.setDynamicConfigurationConfig
(DynamicConfigurationConfig dynamicConfigurationConfig) Sets the dynamic configuration config.setExecutorConfigs
(Map<String, ExecutorConfig> executorConfigs) Sets the map of executor configurations, mapped by config name.Sets the map ofFlakeIdGenerator
configurations, mapped by config name.Deprecated.setInstanceName
(String instanceName) Sets the instance name uniquely identifying the hazelcast instance created by this configuration.setInstanceTrackingConfig
(InstanceTrackingConfig instanceTrackingConfig) Sets the configuration for tracking use of this Hazelcast instance.setIntegrityCheckerConfig
(IntegrityCheckerConfig integrityCheckerConfig) Sets the Integrity Checker configsetJetConfig
(JetConfig jetConfig) Sets the Jet configsetLicenseKey
(String licenseKey) Sets the license key for this hazelcast instance.setListConfigs
(Map<String, ListConfig> listConfigs) Sets the map ofIList
configurations, mapped by config name.setListenerConfigs
(List<ListenerConfig> listenerConfigs) Sets the list ofEventListener
configurations.setLiteMember
(boolean liteMember) Sets the flag to indicate if this member is a lite member.setManagedContext
(ManagedContext managedContext) Sets the external managed context.setManagementCenterConfig
(ManagementCenterConfig managementCenterConfig) Sets the management center configuration for this hazelcast instance.setMapConfigs
(Map<String, MapConfig> mapConfigs) Sets the map ofIMap
configurations, mapped by config name.setMemberAttributeConfig
(MemberAttributeConfig memberAttributeConfig) Sets the member attribute configuration.setMetricsConfig
(MetricsConfig metricsConfig) Sets the metrics collection config.setMultiMapConfigs
(Map<String, MultiMapConfig> multiMapConfigs) Sets the map ofMultiMap
configurations, mapped by config name.setNamespacesConfig
(UserCodeNamespacesConfig userCodeNamespacesConfig) Sets the namespaces configuration.setNativeMemoryConfig
(NativeMemoryConfig nativeMemoryConfig) Sets the native memory configuration for this hazelcast instance.setNetworkConfig
(NetworkConfig networkConfig) Sets the network configuration for this hazelcast instance.setPartitionGroupConfig
(PartitionGroupConfig partitionGroupConfig) Sets the partition group configuration for this hazelcast instance.setPersistenceConfig
(PersistenceConfig persistenceConfig) Sets the Persistence configuration.setPNCounterConfigs
(Map<String, PNCounterConfig> pnCounterConfigs) Sets the map of PN counter configurations, mapped by config name.setProperties
(Properties properties) Sets the properties for this config instance.setProperty
(String name, String value) Sets the value of a named property.setQueueConfigs
(Map<String, QueueConfig> queueConfigs) Sets the map ofIQueue
configurations, mapped by config name.setReliableTopicConfigs
(Map<String, ReliableTopicConfig> reliableTopicConfigs) Sets the map of reliable topic configurations, mapped by config name.setReplicatedMapConfigs
(Map<String, ReplicatedMapConfig> replicatedMapConfigs) Sets the map ofReplicatedMap
configurations, mapped by config name.setRestConfig
(RestConfig restConfig) Sets the configuration for the REST API server.setRingbufferConfigs
(Map<String, RingbufferConfig> ringbufferConfigs) Sets the map ofRingbuffer
configurations, mapped by config name.setScheduledExecutorConfigs
(Map<String, ScheduledExecutorConfig> scheduledExecutorConfigs) Sets the map of scheduled executor configurations, mapped by config name.setSecurityConfig
(SecurityConfig securityConfig) Sets the security configuration for this hazelcast instance.setSerializationConfig
(SerializationConfig serializationConfig) Sets the serialization configuration for this hazelcast instance.setSetConfigs
(Map<String, SetConfig> setConfigs) Sets the map ofISet
configurations, mapped by config name.setSplitBrainProtectionConfigs
(Map<String, SplitBrainProtectionConfig> splitBrainProtectionConfigs) Sets the map of split-brain protection configurations, mapped by config name.setSqlConfig
(SqlConfig sqlConfig) Sets SQL config.setTopicConfigs
(Map<String, TopicConfig> topicConfigs) Sets the map ofITopic
configurations, mapped by config name.setTpcConfig
(TpcConfig tpcConfig) Sets the TpcConfig.setUserCodeDeploymentConfig
(UserCodeDeploymentConfig userCodeDeploymentConfig) Set User Code Deployment configurationsetUserContext
(ConcurrentMap<String, Object> userContext) Sets the user supplied context.setVectorCollectionConfigs
(Map<String, VectorCollectionConfig> vectorConfigs) Set the list of vector collection configurations.setWanReplicationConfigs
(Map<String, WanReplicationConfig> wanReplicationConfigs) Sets the map of WAN replication configurations, mapped by config name.toString()
-
Field Details
-
DEFAULT_CLUSTER_NAME
Default cluster name.- See Also:
-
userCodeNamespacesConfig
-
-
Constructor Details
-
Config
public Config() -
Config
-
-
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.
-
loadDefault
Same asload()
, i.e., loads Config using the default lookup mechanism- Returns:
- Config created from a file when exists, otherwise default.
-
loadDefault
Loads Config using the defaultlookup mechanism
to locate the configuration file and applies variable resolution from the provided properties.- Parameters:
properties
- properties to resolve variables in the XML or YAML- Returns:
- Config created from a file when exists, otherwise default.
-
loadFromClasspath
Creates a Config which is loaded from a classpath resource. The System.properties are used for variable resolution in the configuration file- Parameters:
classLoader
- the ClassLoader used to load the resourceresource
- the resource, an XML or YAML configuration file from the classpath, without the "classpath:" prefix- Returns:
- Config created from the resource
- Throws:
IllegalArgumentException
- if classLoader or resource isnull
, or if the resource is not foundInvalidConfigurationException
- if the resource content is invalid
-
loadFromClasspath
public static Config loadFromClasspath(ClassLoader classLoader, String resource, Properties properties) Creates a Config which is loaded from a classpath resource. Uses the givenproperties
to resolve the variables in the resource.- Parameters:
classLoader
- the ClassLoader used to load the resourceresource
- the resource, an XML or YAML configuration file from the classpath, without the "classpath:" prefixproperties
- the properties used to resolve variables in the resource- Returns:
- Config created from the resource
- Throws:
IllegalArgumentException
- if classLoader or resource isnull
, or if the resource is not foundInvalidConfigurationException
- if the resource content is invalid
-
loadFromFile
Creates a Config based on a the provided configuration file (XML or YAML) and uses the System.properties to resolve variables in the file.- Parameters:
configFile
- the path of the configuration file- Returns:
- Config created from the configFile
- Throws:
FileNotFoundException
- if the file doesn't existInvalidConfigurationException
- if the file content is invalid
-
loadFromFile
public static Config loadFromFile(File configFile, Properties properties) throws FileNotFoundException Creates a Config based on a the provided configuration file (XML or YAML) and uses the System.properties to resolve variables in the file.- Parameters:
configFile
- the path of the configuration fileproperties
- properties to use for variable resolution in the file- Returns:
- Config created from the configFile
- Throws:
FileNotFoundException
- if the file doesn't existInvalidConfigurationException
- if the file content is invalid
-
loadFromString
Creates a Config from the provided string (XML or YAML content) and uses the System.properties for variable resolution.- Parameters:
source
- the XML or YAML content- Returns:
- Config created from the string
- Throws:
IllegalArgumentException
- if the source is null or emptyHazelcastException
- if the source content is invalid
-
loadFromString
Creates a Config from the provided string (XML or YAML content).- Parameters:
source
- the XML or YAML contentproperties
- properties to use for variable resolution- Returns:
- Config created from the string
- Throws:
IllegalArgumentException
- if the source is null or emptyHazelcastException
- if the source content is invalid
-
loadFromStream
Creates a Config from the provided stream (XML or YAML content) and uses the System.properties for variable resolution.- Parameters:
source
- the XML or YAML stream- Returns:
- Config created from the stream
- Throws:
HazelcastException
- if the source content is invalid
-
loadFromStream
Creates a Config from the provided stream (XML or YAML content).- Parameters:
source
- the XML or YAML streamproperties
- properties to use for variable resolution- Returns:
- Config created from the stream
-
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
Sets the value of a named property.- Parameters:
name
- property namevalue
- value of the property- Returns:
- this config instance
- Throws:
IllegalArgumentException
- if eithervalue
isnull
or ifname
is empty ornull
- See Also:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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:
-
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
-
getPersistenceConfig
Returns the Persistence configuration for this hazelcast instance- Returns:
- persistence configuration
-
setHotRestartPersistenceConfig
Deprecated.since 5.0 usesetPersistenceConfig(PersistenceConfig)
Sets the Hot Restart configuration.- Parameters:
hrConfig
- Hot Restart configuration- Returns:
- this config instance
- Throws:
NullPointerException
- if thehrConfig
parameter isnull
-
setPersistenceConfig
Sets the Persistence configuration.- Parameters:
persistenceConfig
- Persistence configuration- Returns:
- this config instance
- Throws:
NullPointerException
- if thepersistenceConfig
parameter isnull
-
getDeviceConfigs
Returns the map ofLocalDeviceConfig
s mapped by device name.- Returns:
- the device configurations mapped by device name
-
setDeviceConfigs
Sets the map ofDeviceConfig
s mapped by device name.- Parameters:
deviceConfigs
- device configuration map- Returns:
- this config instance
-
getDeviceConfig
Returns the device config mapped by the provided device name.- Parameters:
name
- the device name- Returns:
- device config or
null
if absent
-
getDeviceConfig
Returns the device config mapped by the provided device name.- Parameters:
name
- the device nameclazz
- desired device implementation class- Returns:
- device config or
null
if absent
-
addDeviceConfig
Adds the device configuration. Removes the default device config if present.- Parameters:
deviceConfig
- device config- Returns:
- this config instance
-
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:
-
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:
-
getNativeMemoryConfig
Returns the native memory configuration for this hazelcast instance. The native memory configuration defines 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 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. -
getVectorCollectionConfigOrNull
Get vector collection config. If no configuration is found for the given name, returns null.- Returns:
- vector collection config or
null
- Since:
- 5.5
-
getVectorCollectionConfigs
Retrieve configurations for all vector collections.- Returns:
- a map where the key represents the name of the vector collection config and the value corresponds to the respective vector collection config.
- Since:
- 5.5
-
addVectorCollectionConfig
@Nonnull public Config addVectorCollectionConfig(@Nonnull VectorCollectionConfig vectorCollectionConfig) Add vector collection config.- Parameters:
vectorCollectionConfig
- the vector configuration to add- Returns:
- this config instance
- Since:
- 5.5
-
setVectorCollectionConfigs
Set the list of vector collection configurations.- Parameters:
vectorConfigs
- the list of vector configuration to set- Returns:
- this config instance
- Since:
- 5.5
-
getInstanceTrackingConfig
Returns the configuration for tracking use of this Hazelcast instance. -
setInstanceTrackingConfig
@Nonnull public Config setInstanceTrackingConfig(@Nonnull InstanceTrackingConfig instanceTrackingConfig) Sets the configuration for tracking use of this Hazelcast instance. -
getJetConfig
Returns the Jet config -
setJetConfig
Sets the Jet config -
getDynamicConfigurationConfig
Returns the dynamic configuration config. -
setDynamicConfigurationConfig
Sets the dynamic configuration config. -
getIntegrityCheckerConfig
Returns the IntegrityChecker config- Since:
- 5.1
-
setIntegrityCheckerConfig
Sets the Integrity Checker config- Since:
- 5.1
-
getDataConnectionConfigs
Returns the map of data connection configurations, mapped by config name.- Since:
- 5.3
-
setDataConnectionConfigs
@Beta public Config setDataConnectionConfigs(Map<String, DataConnectionConfig> dataConnectionConfigs) Sets the map of data connection configurations, mapped by config name.Example configuration: see
addDataConnectionConfig(DataConnectionConfig)
- Since:
- 5.3
-
addDataConnectionConfig
Adds a data connection configuration.Example:
Config config = new Config(); Properties properties = new Properties(); properties.setProperty("jdbcUrl", jdbcUrl); properties.setProperty("username", username); properties.setProperty("password", password); DataConnectionConfig dataConnectionConfig = new DataConnectionConfig() .setName("my-jdbc-data-connection") .setType("Jdbc") .setProperties(properties); config.addDataConnectionConfig(dataConnectionConfig);
- Since:
- 5.3
-
getDataConnectionConfig
Returns the data connection configuration 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
addDataConnectionConfig(DataConnectionConfig)
.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
- data connection name- Returns:
- data connection configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- Since:
- 5.3
- See Also:
-
findDataConnectionConfig
Returns a read-onlyDataConnectionConfig
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 data connection- Returns:
- the data connection configuration
- Throws:
InvalidConfigurationException
- if ambiguous configurations are found- Since:
- 5.3
- See Also:
-
getNamespacesConfig
- Returns:
- the namespaces configuration object
- Since:
- 5.4.0
-
setNamespacesConfig
@PrivateApi @Nonnull public Config setNamespacesConfig(@Nonnull UserCodeNamespacesConfig userCodeNamespacesConfig) Sets the namespaces configuration. Internal API used for Spring configuration.- Since:
- 5.4.0
-
getTpcConfig
Gets the TpcConfig. Can't return null.- Returns:
- the TpcConfig.
- Since:
- 5.3
-
setTpcConfig
Sets the TpcConfig.- Parameters:
tpcConfig
- the TpcConfig.- Returns:
- this config
- Throws:
NullPointerException
- if tpcConfig is null- Since:
- 5.3
-
getRestConfig
Gets the configuration for the REST API server.- Returns:
- the RestConfig.
-
setRestConfig
Sets the configuration for the REST API server.- Parameters:
restConfig
- the RestConfig.- Returns:
- this Config instance
- Throws:
NullPointerException
- if restConfig is null
-
getServicesConfig
Returns the configuration for the user services managed by this hazelcast instance.- Returns:
- the user services configuration
-
toString
-
setPersistenceConfig(PersistenceConfig)