Package com.hazelcast.config

Class Config

java.lang.Object
com.hazelcast.config.Config
Direct Known Subclasses:
ClasspathXmlConfig, ClasspathYamlConfig, FileSystemXmlConfig, FileSystemYamlConfig, InMemoryXmlConfig, InMemoryYamlConfig, UrlXmlConfig, UrlYamlConfig
public class Config extends Object
Contains all the configuration to start a 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 Details

  • Constructor Details

    • Config

      public Config()

    • Config

      public Config(String instanceName)

  • Method Details

    • load

      public static Config load()
      Populates Hazelcast Config 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

      public static Config loadDefault()
      Same as load(), i.e., loads Config using the default lookup mechanism
      Returns:
      Config created from a file when exists, otherwise default.

    • loadDefault

      public static Config loadDefault(Properties properties)
      Loads Config using the default lookup 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

      public static Config loadFromClasspath(ClassLoader classLoader, String resource)
      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 resource
      resource - 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 is null, or if the resource is not found
      InvalidConfigurationException - 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 given properties to resolve the variables in the resource.
      Parameters:
      classLoader - the ClassLoader used to load the resource
      resource - the resource, an XML or YAML configuration file from the classpath, without the "classpath:" prefix
      properties - the properties used to resolve variables in the resource
      Returns:
      Config created from the resource
      Throws:
      IllegalArgumentException - if classLoader or resource is null, or if the resource is not found
      InvalidConfigurationException - if the resource content is invalid

    • loadFromFile

      public static Config loadFromFile(File configFile) 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 file
      Returns:
      Config created from the configFile
      Throws:
      FileNotFoundException - if the file doesn't exist
      InvalidConfigurationException - 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 file
      properties - properties to use for variable resolution in the file
      Returns:
      Config created from the configFile
      Throws:
      FileNotFoundException - if the file doesn't exist
      InvalidConfigurationException - if the file content is invalid

    • loadFromString

      public static Config loadFromString(String source)
      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 empty
      HazelcastException - if the source content is invalid

    • loadFromString

      public static Config loadFromString(String source, Properties properties)
      Creates a Config from the provided string (XML or YAML content).
      Parameters:
      source - the XML or YAML content
      properties - properties to use for variable resolution
      Returns:
      Config created from the string
      Throws:
      IllegalArgumentException - if the source is null or empty
      HazelcastException - if the source content is invalid

    • loadFromStream

      public static Config loadFromStream(InputStream source)
      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

      public static Config loadFromStream(InputStream source, Properties properties)
      Creates a Config from the provided stream (XML or YAML content).
      Parameters:
      source - the XML or YAML stream
      properties - properties to use for variable resolution
      Returns:
      Config created from the stream

    • getClassLoader

      public ClassLoader 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

      public Config setClassLoader(ClassLoader classLoader)
      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

      public ConfigPatternMatcher getConfigPatternMatcher()
      Returns the pattern matcher which is used to match item names to configuration objects. By default, the MatchingPointConfigPatternMatcher is used.
      Returns:
      the pattern matcher

    • setConfigPatternMatcher

      public Config setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
      Sets the pattern matcher which is used to match item names to configuration objects. By default, the MatchingPointConfigPatternMatcher is used.
      Parameters:
      configPatternMatcher - the pattern matcher
      Returns:
      this configuration
      Throws:
      IllegalArgumentException - if the pattern matcher is null

    • getProperty

      public String getProperty(String name)
      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

      public Config setProperty(@Nonnull String name, @Nonnull String value)
      Sets the value of a named property.
      Parameters:
      name - property name
      value - value of the property
      Returns:
      this config instance
      Throws:
      IllegalArgumentException - if either value is null or if name is empty or null
      See Also:

    • getMemberAttributeConfig

      public MemberAttributeConfig getMemberAttributeConfig()
      Returns the member attribute configuration. Unlike the config properties (see setProperties(Properties)), member attributes are exchanged with other members, e.g. on membership events.
      Returns:
      the member attribute configuration

    • setMemberAttributeConfig

      public Config setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)
      Sets the member attribute configuration. Unlike the config properties (see setProperties(Properties)), member attributes are exchanged with other members, e.g. on membership events.
      Parameters:
      memberAttributeConfig - the member attribute configuration
      Returns:
      this configuration

    • getProperties

      public Properties 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

      public Config setProperties(Properties properties)
      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

      public String 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

      public Config setInstanceName(String instanceName)
      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

      public String 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

      public Config setClusterName(String clusterName)
      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 is null

    • getNetworkConfig

      public NetworkConfig 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

      public Config setNetworkConfig(NetworkConfig networkConfig)
      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

      public MapConfig findMapConfig(String name)
      Returns a read-only IMap 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 name default. 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

      public MapConfig getMapConfigOrNull(String name)
      Returns the map config with the given name or null if there is none. The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given name.
      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

      public MapConfig getMapConfig(String name)
      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

      public Config addMapConfig(MapConfig mapConfig)
      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

      public Map<String,MapConfig> getMapConfigs()
      Returns the map of IMap 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

      public Config setMapConfigs(Map<String,MapConfig> mapConfigs)
      Sets the map of IMap 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

      public CacheSimpleConfig findCacheConfig(String name)
      Returns a read-only CacheSimpleConfig 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 name default.

      Parameters:
      name - name of the cardinality estimator config
      Returns:
      the cache configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • findCacheConfigOrNull

      public CacheSimpleConfig findCacheConfigOrNull(String name)
      Returns the cache config with the given name or null if there is none. The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given name.
      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

      public CacheSimpleConfig getCacheConfig(String name)
      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

      public Config addCacheConfig(CacheSimpleConfig cacheConfig)
      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

      public Map<String,CacheSimpleConfig> 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

      public Config setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)
      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

      public QueueConfig findQueueConfig(String name)
      Returns a read-only IQueue 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 name default.

      Parameters:
      name - name of the queue config
      Returns:
      the queue configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getQueueConfig

      public QueueConfig getQueueConfig(String name)
      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

      public Config addQueueConfig(QueueConfig queueConfig)
      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

      public Map<String,QueueConfig> getQueueConfigs()
      Returns the map of IQueue 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

      public Config setQueueConfigs(Map<String,QueueConfig> queueConfigs)
      Sets the map of IQueue 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

      public ListConfig findListConfig(String name)
      Returns a read-only IList 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 name default.

      Parameters:
      name - name of the list config
      Returns:
      the list configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getListConfig

      public ListConfig getListConfig(String name)
      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

      public Config addListConfig(ListConfig listConfig)
      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

      public Map<String,ListConfig> getListConfigs()
      Returns the map of IList 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

      public Config setListConfigs(Map<String,ListConfig> listConfigs)
      Sets the map of IList 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

      public SetConfig findSetConfig(String name)
      Returns a read-only ISet 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 name default.

      Parameters:
      name - name of the set config
      Returns:
      the set configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getSetConfig

      public SetConfig getSetConfig(String name)
      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

      public Config addSetConfig(SetConfig setConfig)
      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

      public Map<String,SetConfig> getSetConfigs()
      Returns the map of ISet 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

      public Config setSetConfigs(Map<String,SetConfig> setConfigs)
      Sets the map of ISet 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

      public MultiMapConfig findMultiMapConfig(String name)
      Returns a read-only MultiMap 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 name default.

      Parameters:
      name - name of the multimap config
      Returns:
      the multimap configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getMultiMapConfig

      public MultiMapConfig getMultiMapConfig(String name)
      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

      public Config addMultiMapConfig(MultiMapConfig multiMapConfig)
      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

      public Map<String,MultiMapConfig> getMultiMapConfigs()
      Returns the map of MultiMap 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

      public Config setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)
      Sets the map of MultiMap 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

      public ReplicatedMapConfig findReplicatedMapConfig(String name)
      Returns a read-only ReplicatedMap 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 name default.

      Parameters:
      name - name of the replicated map config
      Returns:
      the replicated map configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getReplicatedMapConfig

      public ReplicatedMapConfig getReplicatedMapConfig(String name)
      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

      public Config addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)
      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

      public Map<String,ReplicatedMapConfig> getReplicatedMapConfigs()
      Returns the map of ReplicatedMap 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

      public Config setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)
      Sets the map of ReplicatedMap 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

      public RingbufferConfig findRingbufferConfig(String name)
      Returns a read-only Ringbuffer 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 name default.

      Parameters:
      name - name of the ringbuffer config
      Returns:
      the ringbuffer configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getRingbufferConfig

      public RingbufferConfig getRingbufferConfig(String name)
      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

      public Config addRingBufferConfig(RingbufferConfig ringbufferConfig)
      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

      public Map<String,RingbufferConfig> getRingbufferConfigs()
      Returns the map of Ringbuffer 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

      public Config setRingbufferConfigs(Map<String,RingbufferConfig> ringbufferConfigs)
      Sets the map of Ringbuffer 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

      public TopicConfig findTopicConfig(String name)
      Returns a read-only ITopic 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 name default.

      Parameters:
      name - name of the topic config
      Returns:
      the topic configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getTopicConfig

      public TopicConfig getTopicConfig(String name)
      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

      public Config addTopicConfig(TopicConfig topicConfig)
      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

      public ReliableTopicConfig findReliableTopicConfig(String name)
      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 name default.

      Parameters:
      name - name of the reliable topic config
      Returns:
      the reliable topic configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getReliableTopicConfig

      public ReliableTopicConfig getReliableTopicConfig(String name)
      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

      public Map<String,ReliableTopicConfig> 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

      public Config addReliableTopicConfig(ReliableTopicConfig topicConfig)
      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

      public Config setReliableTopicConfigs(Map<String,ReliableTopicConfig> reliableTopicConfigs)
      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

      public Map<String,TopicConfig> 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

      public Config setTopicConfigs(Map<String,TopicConfig> topicConfigs)
      Sets the map of ITopic 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

      public ExecutorConfig findExecutorConfig(String name)
      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 name default.

      Parameters:
      name - name of the executor config
      Returns:
      the executor configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • findDurableExecutorConfig

      public DurableExecutorConfig findDurableExecutorConfig(String name)
      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 name default.

      Parameters:
      name - name of the durable executor config
      Returns:
      the durable executor configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • findScheduledExecutorConfig

      public ScheduledExecutorConfig findScheduledExecutorConfig(String name)
      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 name default.

      Parameters:
      name - name of the scheduled executor config
      Returns:
      the scheduled executor configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • findCardinalityEstimatorConfig

      public CardinalityEstimatorConfig findCardinalityEstimatorConfig(String name)
      Returns a read-only CardinalityEstimator 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 name default.

      Parameters:
      name - name of the cardinality estimator config
      Returns:
      the cardinality estimator configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • findPNCounterConfig

      public PNCounterConfig findPNCounterConfig(String name)
      Returns a read-only PNCounterConfig 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 name default.

      Parameters:
      name - name of the PN counter config
      Returns:
      the PN counter configuration
      Throws:
      InvalidConfigurationException - if ambiguous configurations are found
      See Also:

    • getExecutorConfig

      public ExecutorConfig getExecutorConfig(String name)
      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

      public DurableExecutorConfig getDurableExecutorConfig(String name)
      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

      public ScheduledExecutorConfig getScheduledExecutorConfig(String name)
      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

      public CardinalityEstimatorConfig getCardinalityEstimatorConfig(String name)
      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

      public PNCounterConfig getPNCounterConfig(String name)
      Returns the PNCounterConfig 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

      public Config addExecutorConfig(ExecutorConfig executorConfig)
      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

      public Config addDurableExecutorConfig(DurableExecutorConfig durableExecutorConfig)
      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

      public Config addScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)
      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

      public Config addCardinalityEstimatorConfig(CardinalityEstimatorConfig cardinalityEstimatorConfig)
      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

      public Config addPNCounterConfig(PNCounterConfig pnCounterConfig)
      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

      public Map<String,ExecutorConfig> 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

      public Config setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)
      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

      public Map<String,DurableExecutorConfig> 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

      public Config setDurableExecutorConfigs(Map<String,DurableExecutorConfig> durableExecutorConfigs)
      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

      public Map<String,ScheduledExecutorConfig> 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

      public Map<String,CardinalityEstimatorConfig> 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

      public Map<String,PNCounterConfig> 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

      public Config setPNCounterConfigs(Map<String,PNCounterConfig> pnCounterConfigs)
      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

      public WanReplicationConfig getWanReplicationConfig(String name)
      Returns the WAN replication configuration with the given name.
      Parameters:
      name - the WAN replication config name
      Returns:
      the WAN replication config

    • addWanReplicationConfig

      public Config addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)
      Adds the WAN replication config under the name defined by WanReplicationConfig.getName().
      Parameters:
      wanReplicationConfig - the WAN replication config
      Returns:
      this config instance

    • getWanReplicationConfigs

      public Map<String,WanReplicationConfig> getWanReplicationConfigs()
      Returns the map of WAN replication configurations, mapped by config name.
      Returns:
      the WAN replication configurations mapped by config name

    • setWanReplicationConfigs

      public Config setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)
      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

      public Map<String,SplitBrainProtectionConfig> 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

      public SplitBrainProtectionConfig getSplitBrainProtectionConfig(String name)
      Returns the SplitBrainProtectionConfig 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

      public SplitBrainProtectionConfig findSplitBrainProtectionConfig(String name)
      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 name default.

      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

      public Config addSplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
      Adds the split-brain protection configuration. The configuration is saved under the config name defined by SplitBrainProtectionConfig.getName().
      Parameters:
      splitBrainProtectionConfig - split-brain protection config to add
      Returns:
      this config instance

    • getManagementCenterConfig

      public ManagementCenterConfig getManagementCenterConfig()
      Returns the management center configuration for this hazelcast instance.
      Returns:
      the management center configuration

    • setManagementCenterConfig

      public Config setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)
      Sets the management center configuration for this hazelcast instance.
      Parameters:
      managementCenterConfig - the management center configuration
      Returns:
      this config instance

    • getSecurityConfig

      public SecurityConfig getSecurityConfig()
      Returns the security configuration for this hazelcast instance. This includes configuration for security interceptors, permissions, etc.
      Returns:
      the security configuration

    • setSecurityConfig

      public Config setSecurityConfig(SecurityConfig securityConfig)
      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

      public Config addListenerConfig(ListenerConfig listenerConfig)
      Adds a configuration for an EventListener. 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

      public List<ListenerConfig> getListenerConfigs()
      Returns the list of EventListener 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

      public Config setListenerConfigs(List<ListenerConfig> listenerConfigs)
      Sets the list of EventListener 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

      public Map<String,FlakeIdGeneratorConfig> getFlakeIdGeneratorConfigs()
      Returns the map of FlakeIdGenerator 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

      public FlakeIdGeneratorConfig findFlakeIdGeneratorConfig(String name)
      Returns a FlakeIdGeneratorConfig 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

      public FlakeIdGeneratorConfig getFlakeIdGeneratorConfig(String name)
      Returns the FlakeIdGeneratorConfig 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

      public Config addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig config)
      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

      public Config setFlakeIdGeneratorConfigs(Map<String,FlakeIdGeneratorConfig> map)
      Sets the map of FlakeIdGenerator 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

      public SerializationConfig 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

      public Config setSerializationConfig(SerializationConfig serializationConfig)
      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

      public PartitionGroupConfig 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

      public Config setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)
      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

      public HotRestartPersistenceConfig getHotRestartPersistenceConfig()
      Returns the Hot Restart configuration for this hazelcast instance
      Returns:
      hot restart configuration

    • getPersistenceConfig

      public PersistenceConfig getPersistenceConfig()
      Returns the Persistence configuration for this hazelcast instance
      Returns:
      persistence configuration

    • setHotRestartPersistenceConfig

      @Deprecated public Config setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
      Deprecated.
      since 5.0 use setPersistenceConfig(PersistenceConfig)
      Sets the Hot Restart configuration.
      Parameters:
      hrConfig - Hot Restart configuration
      Returns:
      this config instance
      Throws:
      NullPointerException - if the hrConfig parameter is null

    • setPersistenceConfig

      public Config setPersistenceConfig(PersistenceConfig persistenceConfig)
      Sets the Persistence configuration.
      Parameters:
      persistenceConfig - Persistence configuration
      Returns:
      this config instance
      Throws:
      NullPointerException - if the persistenceConfig parameter is null

    • getDeviceConfigs

      public Map<String,DeviceConfig> getDeviceConfigs()
      Returns the map of LocalDeviceConfigs mapped by device name.
      Returns:
      the device configurations mapped by device name

    • setDeviceConfigs

      public Config setDeviceConfigs(Map<String,DeviceConfig> deviceConfigs)
      Sets the map of DeviceConfigs mapped by device name.
      Parameters:
      deviceConfigs - device configuration map
      Returns:
      this config instance

    • getDeviceConfig

      @Nullable public <T extends DeviceConfig> T getDeviceConfig(String name)
      Returns the device config mapped by the provided device name.
      Parameters:
      name - the device name
      Returns:
      device config or null if absent

    • getDeviceConfig

      @Nullable public <T extends DeviceConfig> T getDeviceConfig(Class<T> clazz, String name)
      Returns the device config mapped by the provided device name.
      Parameters:
      name - the device name
      clazz - desired device implementation class
      Returns:
      device config or null if absent

    • addDeviceConfig

      public Config addDeviceConfig(DeviceConfig deviceConfig)
      Adds the device configuration. Removes the default device config if present.
      Parameters:
      deviceConfig - device config
      Returns:
      this config instance

    • getCRDTReplicationConfig

      public CRDTReplicationConfig getCRDTReplicationConfig()

    • setCRDTReplicationConfig

      public Config setCRDTReplicationConfig(CRDTReplicationConfig crdtReplicationConfig)
      Sets the replication configuration for CRDT implementations.
      Parameters:
      crdtReplicationConfig - the replication configuration
      Returns:
      this config instance
      Throws:
      NullPointerException - if the crdtReplicationConfig parameter is null

    • getManagedContext

      public ManagedContext getManagedContext()
      Returns the external managed context. This context is used to initialize user supplied objects.
      Returns:
      the managed context

    • setManagedContext

      public Config setManagedContext(ManagedContext managedContext)
      Sets the external managed context. This context is used to initialize user supplied objects.
      Parameters:
      managedContext - the managed context
      Returns:
      this config instance

    • getUserContext

      public ConcurrentMap<String,Object> getUserContext()
      Returns the user supplied context. This context can then be obtained from an instance of HazelcastInstance.
      Returns:
      the user supplied context
      See Also:

    • setUserContext

      public Config setUserContext(ConcurrentMap<String,Object> userContext)
      Sets the user supplied context. This context can then be obtained from an instance of HazelcastInstance.
      Parameters:
      userContext - the user supplied context
      Returns:
      this config instance
      See Also:

    • getNativeMemoryConfig

      public NativeMemoryConfig 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

      public Config setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
      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

      public URL getConfigurationUrl()
      Returns the URL to the declarative configuration, which has been parsed to create this Config instance.
      Returns:
      the configuration URL if the configuration loaded from a URL or null otherwise

    • setConfigurationUrl

      public Config setConfigurationUrl(URL configurationUrl)
      Sets the URL 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

      public File getConfigurationFile()
      Returns the File to the declarative configuration, which has been parsed to create this Config instance.
      Returns:
      the configuration file if the configuration loaded from a file or null otherwise

    • setConfigurationFile

      public Config setConfigurationFile(File configurationFile)
      Sets the File 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

      public String 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 corresponding HazelcastRuntimePermission

    • setLicenseKey

      public Config setLicenseKey(String licenseKey)
      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()
      Returns true 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

      public Config setLiteMember(boolean liteMember)
      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

      public UserCodeDeploymentConfig getUserCodeDeploymentConfig()
      Get current configuration of User Code Deployment.
      Returns:
      User Code Deployment configuration
      Since:
      3.8

    • setUserCodeDeploymentConfig

      public Config setUserCodeDeploymentConfig(UserCodeDeploymentConfig userCodeDeploymentConfig)
      Set User Code Deployment configuration
      Parameters:
      userCodeDeploymentConfig - the user code deployment configuration
      Returns:
      this config instance
      Since:
      3.8

    • getAdvancedNetworkConfig

      public AdvancedNetworkConfig getAdvancedNetworkConfig()

    • setAdvancedNetworkConfig

      public Config setAdvancedNetworkConfig(AdvancedNetworkConfig advancedNetworkConfig)

    • getCPSubsystemConfig

      public CPSubsystemConfig getCPSubsystemConfig()
      Get current configuration for the CP subsystem
      Returns:
      CP subsystem configuration
      Since:
      3.12

    • setCPSubsystemConfig

      public Config setCPSubsystemConfig(CPSubsystemConfig cpSubsystemConfig)
      Set CP subsystem configuration
      Parameters:
      cpSubsystemConfig - the CP subsystem configuration
      Returns:
      this config instance
      Since:
      3.12

    • getMetricsConfig

      @Nonnull public MetricsConfig getMetricsConfig()
      Returns the metrics collection config.

    • setMetricsConfig

      @Nonnull public Config setMetricsConfig(@Nonnull MetricsConfig metricsConfig)
      Sets the metrics collection config.

    • getAuditlogConfig

      @Nonnull public AuditlogConfig getAuditlogConfig()

    • setAuditlogConfig

      @Nonnull public Config setAuditlogConfig(@Nonnull AuditlogConfig auditlogConfig)

    • getSqlConfig

      @Nonnull public SqlConfig getSqlConfig()
      Returns:
      Return SQL config.

    • setSqlConfig

      @Nonnull public Config setSqlConfig(@Nonnull SqlConfig sqlConfig)
      Sets SQL config.

    • getVectorCollectionConfigOrNull

      public VectorCollectionConfig getVectorCollectionConfigOrNull(String name)
      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

      public Map<String,VectorCollectionConfig> 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

      public Config setVectorCollectionConfigs(Map<String,VectorCollectionConfig> vectorConfigs)
      Set the list of vector collection configurations.
      Parameters:
      vectorConfigs - the list of vector configuration to set
      Returns:
      this config instance
      Since:
      5.5

    • getInstanceTrackingConfig

      @Nonnull public InstanceTrackingConfig 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

      @Nonnull public JetConfig getJetConfig()
      Returns the Jet config

    • setJetConfig

      @Nonnull public Config setJetConfig(JetConfig jetConfig)
      Sets the Jet config

    • getDynamicConfigurationConfig

      public DynamicConfigurationConfig getDynamicConfigurationConfig()
      Returns the dynamic configuration config.

    • setDynamicConfigurationConfig

      public Config setDynamicConfigurationConfig(DynamicConfigurationConfig dynamicConfigurationConfig)
      Sets the dynamic configuration config.

    • getIntegrityCheckerConfig

      @Nonnull public IntegrityCheckerConfig getIntegrityCheckerConfig()
      Returns the IntegrityChecker config
      Since:
      5.1

    • setIntegrityCheckerConfig

      @Nonnull public Config setIntegrityCheckerConfig(IntegrityCheckerConfig integrityCheckerConfig)
      Sets the Integrity Checker config
      Since:
      5.1

    • getDataConnectionConfigs

      @Beta public Map<String,DataConnectionConfig> 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

      @Beta public Config addDataConnectionConfig(DataConnectionConfig dataConnectionConfig)
      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

      @Beta public DataConnectionConfig getDataConnectionConfig(String name)
      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

      @Beta public DataConnectionConfig findDataConnectionConfig(String name)
      Returns a read-only DataConnectionConfig 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 name default.

      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

      public UserCodeNamespacesConfig 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

      @Beta @Nonnull public TpcConfig getTpcConfig()
      Gets the TpcConfig. Can't return null.
      Returns:
      the TpcConfig.
      Since:
      5.3

    • setTpcConfig

      @Beta @Nonnull public Config setTpcConfig(@Nonnull TpcConfig tpcConfig)
      Sets the TpcConfig.
      Parameters:
      tpcConfig - the TpcConfig.
      Returns:
      this config
      Throws:
      NullPointerException - if tpcConfig is null
      Since:
      5.3

    • getRestConfig

      public RestConfig getRestConfig()
      Gets the configuration for the REST API server.
      Returns:
      the RestConfig.

    • setRestConfig

      @Nonnull public Config setRestConfig(@Nonnull RestConfig restConfig)
      Sets the configuration for the REST API server.
      Parameters:
      restConfig - the RestConfig.
      Returns:
      this Config instance
      Throws:
      NullPointerException - if restConfig is null

    • getServicesConfig

      @PrivateApi protected com.hazelcast.internal.config.ServicesConfig getServicesConfig()
      Returns the configuration for the user services managed by this hazelcast instance.
      Returns:
      the user services configuration

    • toString

      public String toString()
      Overrides:
      toString in class Object