public class Config extends Object
HazelcastInstance
. A Config can be created
programmatically, but can also be configured using XML, see
XmlConfigBuilder
.
Config instances can be shared between threads, but should not be modified after they are used to create HazelcastInstances.
Unlike Config
instances obtained via load()
and its variants,
a Config
does not apply overrides found in environment variables/system properties.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_CLUSTER_NAME
Default cluster name.
|
Modifier and Type | Method and Description |
---|---|
Config |
addCacheConfig(CacheSimpleConfig cacheConfig)
Adds the cache configuration.
|
Config |
addCardinalityEstimatorConfig(CardinalityEstimatorConfig cardinalityEstimatorConfig)
Adds the cardinality estimator configuration.
|
Config |
addDeviceConfig(DeviceConfig deviceConfig)
Adds the device configuration.
|
Config |
addDurableExecutorConfig(DurableExecutorConfig durableExecutorConfig)
Adds the durable executor configuration.
|
Config |
addExecutorConfig(ExecutorConfig executorConfig)
Adds the executor configuration.
|
Config |
addExternalDataStoreConfig(ExternalDataStoreConfig externalDataStoreConfig)
Adds an external data store configuration.
|
Config |
addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig config)
Adds a flake ID generator configuration.
|
Config |
addListConfig(ListConfig listConfig)
Adds the list configuration.
|
Config |
addListenerConfig(ListenerConfig listenerConfig)
Adds a configuration for an
EventListener . |
Config |
addMapConfig(MapConfig mapConfig)
Adds the map configuration.
|
Config |
addMultiMapConfig(MultiMapConfig multiMapConfig)
Adds the multimap configuration.
|
Config |
addPNCounterConfig(PNCounterConfig pnCounterConfig)
Adds the PN counter configuration.
|
Config |
addQueueConfig(QueueConfig queueConfig)
Adds the queue configuration.
|
Config |
addReliableTopicConfig(ReliableTopicConfig topicConfig)
Adds the reliable topic configuration.
|
Config |
addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)
Adds the replicated map configuration.
|
Config |
addRingBufferConfig(RingbufferConfig ringbufferConfig)
Adds the ringbuffer configuration.
|
Config |
addScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)
Adds the scheduled executor configuration.
|
Config |
addSetConfig(SetConfig setConfig)
Adds the set configuration.
|
Config |
addSplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
Adds the split-brain protection configuration.
|
Config |
addTopicConfig(TopicConfig topicConfig)
Adds the topic configuration.
|
Config |
addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)
Adds the WAN replication config under the name defined by
WanReplicationConfig.getName() . |
CacheSimpleConfig |
findCacheConfig(String name)
Returns a read-only
CacheSimpleConfig configuration for the given name. |
CacheSimpleConfig |
findCacheConfigOrNull(String name)
Returns the cache config with the given name or
null if there is none. |
CardinalityEstimatorConfig |
findCardinalityEstimatorConfig(String name)
Returns a read-only
CardinalityEstimator
configuration for the given name. |
DurableExecutorConfig |
findDurableExecutorConfig(String name)
Returns a read-only durable executor configuration for the given name.
|
ExecutorConfig |
findExecutorConfig(String name)
Returns a read-only executor configuration for the given name.
|
ExternalDataStoreConfig |
findExternalDataStoreConfig(String name)
Returns a read-only
ExternalDataStoreConfig
configuration for the given name. |
FlakeIdGeneratorConfig |
findFlakeIdGeneratorConfig(String name)
Returns a
FlakeIdGeneratorConfig configuration for the given flake ID generator name. |
ListConfig |
findListConfig(String name)
Returns a read-only
IList configuration for
the given name. |
MapConfig |
findMapConfig(String name)
Returns a read-only
IMap configuration for
the given name. |
MultiMapConfig |
findMultiMapConfig(String name)
Returns a read-only
MultiMap configuration for
the given name. |
PNCounterConfig |
findPNCounterConfig(String name)
Returns a read-only
PNCounterConfig
configuration for the given name. |
QueueConfig |
findQueueConfig(String name)
Returns a read-only
IQueue configuration for
the given name. |
ReliableTopicConfig |
findReliableTopicConfig(String name)
Returns a read-only reliable topic configuration for the given name.
|
ReplicatedMapConfig |
findReplicatedMapConfig(String name)
Returns a read-only
ReplicatedMap configuration for
the given name. |
RingbufferConfig |
findRingbufferConfig(String name)
Returns a read-only
Ringbuffer
configuration for the given name. |
ScheduledExecutorConfig |
findScheduledExecutorConfig(String name)
Returns a read-only scheduled executor configuration for the given name.
|
SetConfig |
findSetConfig(String name)
Returns a read-only
ISet configuration for
the given name. |
SplitBrainProtectionConfig |
findSplitBrainProtectionConfig(String name)
Returns a read-only split-brain protection configuration for the given
name.
|
TopicConfig |
findTopicConfig(String name)
Returns a read-only
ITopic
configuration for the given name. |
AdvancedNetworkConfig |
getAdvancedNetworkConfig() |
AuditlogConfig |
getAuditlogConfig() |
CacheSimpleConfig |
getCacheConfig(String name)
Returns the CacheSimpleConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,CacheSimpleConfig> |
getCacheConfigs()
Returns the map of cache configurations, mapped by config name.
|
CardinalityEstimatorConfig |
getCardinalityEstimatorConfig(String name)
Returns the CardinalityEstimatorConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,CardinalityEstimatorConfig> |
getCardinalityEstimatorConfigs()
Returns the map of cardinality estimator configurations, mapped by config
name.
|
ClassLoader |
getClassLoader()
Returns the class-loader that will be used in serialization.
|
String |
getClusterName()
Returns the cluster name uniquely identifying the hazelcast cluster.
|
ConfigPatternMatcher |
getConfigPatternMatcher()
Returns the pattern matcher which is used to match item names to
configuration objects.
|
File |
getConfigurationFile()
|
URL |
getConfigurationUrl()
|
CPSubsystemConfig |
getCPSubsystemConfig()
Get current configuration for the CP subsystem
|
CRDTReplicationConfig |
getCRDTReplicationConfig() |
<T extends DeviceConfig> |
getDeviceConfig(Class<T> clazz,
String name)
Returns the device config mapped by the provided device name.
|
<T extends DeviceConfig> |
getDeviceConfig(String name)
Returns the device config mapped by the provided device name.
|
Map<String,DeviceConfig> |
getDeviceConfigs()
Returns the map of
LocalDeviceConfig s mapped by device name. |
DurableExecutorConfig |
getDurableExecutorConfig(String name)
Returns the DurableExecutorConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,DurableExecutorConfig> |
getDurableExecutorConfigs()
Returns the map of durable executor configurations, mapped by config
name.
|
DynamicConfigurationConfig |
getDynamicConfigurationConfig()
Returns the dynamic configuration config.
|
ExecutorConfig |
getExecutorConfig(String name)
Returns the ExecutorConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ExecutorConfig> |
getExecutorConfigs()
Returns the map of executor configurations, mapped by config name.
|
ExternalDataStoreConfig |
getExternalDataStoreConfig(String name)
Returns the external data store configuration for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ExternalDataStoreConfig> |
getExternalDataStoreConfigs()
Returns the map of external data store configurations, mapped by config name.
|
FlakeIdGeneratorConfig |
getFlakeIdGeneratorConfig(String name)
Returns the
FlakeIdGeneratorConfig for the given name, creating
one if necessary and adding it to the collection of known configurations. |
Map<String,FlakeIdGeneratorConfig> |
getFlakeIdGeneratorConfigs()
Returns the map of
FlakeIdGenerator configurations,
mapped by config name. |
HotRestartPersistenceConfig |
getHotRestartPersistenceConfig()
Returns the Hot Restart configuration for this hazelcast instance
|
String |
getInstanceName()
Returns the instance name uniquely identifying the hazelcast instance
created by this configuration.
|
InstanceTrackingConfig |
getInstanceTrackingConfig()
Returns the configuration for tracking use of this Hazelcast instance.
|
IntegrityCheckerConfig |
getIntegrityCheckerConfig()
Returns the IntegrityChecker config
|
JetConfig |
getJetConfig()
Returns the Jet config
|
String |
getLicenseKey()
Returns the license key for this hazelcast instance.
|
ListConfig |
getListConfig(String name)
Returns the ListConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ListConfig> |
getListConfigs()
Returns the map of
IList configurations,
mapped by config name. |
List<ListenerConfig> |
getListenerConfigs()
Returns the list of
EventListener configurations. |
ManagedContext |
getManagedContext()
Returns the external managed context.
|
ManagementCenterConfig |
getManagementCenterConfig()
Returns the management center configuration for this hazelcast instance.
|
MapConfig |
getMapConfig(String name)
Returns the MapConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
MapConfig |
getMapConfigOrNull(String name)
Returns the map config with the given name or
null if there is none. |
Map<String,MapConfig> |
getMapConfigs()
Returns the map of
IMap configurations,
mapped by config name. |
MemberAttributeConfig |
getMemberAttributeConfig()
Returns the member attribute configuration.
|
MetricsConfig |
getMetricsConfig()
Returns the metrics collection config.
|
MultiMapConfig |
getMultiMapConfig(String name)
Returns the MultiMapConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,MultiMapConfig> |
getMultiMapConfigs()
Returns the map of
MultiMap configurations,
mapped by config name. |
NativeMemoryConfig |
getNativeMemoryConfig()
Returns the native memory configuration for this hazelcast instance.
|
NetworkConfig |
getNetworkConfig()
Returns the network configuration for this hazelcast instance.
|
PartitionGroupConfig |
getPartitionGroupConfig()
Returns the partition group configuration for this hazelcast instance.
|
PersistenceConfig |
getPersistenceConfig()
Returns the Persistence configuration for this hazelcast instance
|
PNCounterConfig |
getPNCounterConfig(String name)
Returns the
PNCounterConfig for the given name, creating one
if necessary and adding it to the collection of known configurations. |
Map<String,PNCounterConfig> |
getPNCounterConfigs()
Returns the map of PN counter configurations, mapped by config
name.
|
Properties |
getProperties()
Returns the properties set on this config instance.
|
String |
getProperty(String name)
Returns the value for a named property.
|
QueueConfig |
getQueueConfig(String name)
Returns the QueueConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,QueueConfig> |
getQueueConfigs()
Returns the map of
IQueue configurations,
mapped by config name. |
ReliableTopicConfig |
getReliableTopicConfig(String name)
Returns the ReliableTopicConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ReliableTopicConfig> |
getReliableTopicConfigs()
Returns the map of reliable topic configurations, mapped by config name.
|
ReplicatedMapConfig |
getReplicatedMapConfig(String name)
Returns the ReplicatedMapConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ReplicatedMapConfig> |
getReplicatedMapConfigs()
Returns the map of
ReplicatedMap
configurations, mapped by config name. |
RingbufferConfig |
getRingbufferConfig(String name)
Returns the RingbufferConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,RingbufferConfig> |
getRingbufferConfigs()
Returns the map of
Ringbuffer
configurations, mapped by config name. |
ScheduledExecutorConfig |
getScheduledExecutorConfig(String name)
Returns the ScheduledExecutorConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,ScheduledExecutorConfig> |
getScheduledExecutorConfigs()
Returns the map of scheduled executor configurations, mapped by config
name.
|
SecurityConfig |
getSecurityConfig()
Returns the security configuration for this hazelcast instance.
|
SerializationConfig |
getSerializationConfig()
Returns the serialization configuration for this hazelcast instance.
|
protected com.hazelcast.internal.config.ServicesConfig |
getServicesConfig()
Returns the configuration for the user services managed by this
hazelcast instance.
|
SetConfig |
getSetConfig(String name)
Returns the SetConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,SetConfig> |
getSetConfigs()
Returns the map of
ISet configurations,
mapped by config name. |
SplitBrainProtectionConfig |
getSplitBrainProtectionConfig(String name)
Returns the
SplitBrainProtectionConfig for the given name, creating one
if necessary and adding it to the collection of known configurations. |
Map<String,SplitBrainProtectionConfig> |
getSplitBrainProtectionConfigs()
Returns the map of split brain protection configurations, mapped by
config name.
|
SqlConfig |
getSqlConfig() |
TopicConfig |
getTopicConfig(String name)
Returns the TopicConfig for the given name, creating one
if necessary and adding it to the collection of known configurations.
|
Map<String,TopicConfig> |
getTopicConfigs()
Returns the map of reliable topic configurations, mapped by config name.
|
UserCodeDeploymentConfig |
getUserCodeDeploymentConfig()
Get current configuration of User Code Deployment.
|
ConcurrentMap<String,Object> |
getUserContext()
Returns the user supplied context.
|
WanReplicationConfig |
getWanReplicationConfig(String name)
Returns the WAN replication configuration with the given
name . |
Map<String,WanReplicationConfig> |
getWanReplicationConfigs()
Returns the map of WAN replication configurations, mapped by config
name.
|
boolean |
isLiteMember()
Returns
true if this member is a lite member. |
static Config |
load()
Populates Hazelcast
Config object from an external configuration file. |
static Config |
loadDefault()
Same as
load() , i.e., loads Config using the default lookup mechanism |
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. |
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).
|
Config |
setAdvancedNetworkConfig(AdvancedNetworkConfig advancedNetworkConfig) |
Config |
setAuditlogConfig(AuditlogConfig auditlogConfig) |
Config |
setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)
Sets the map of cache configurations, mapped by config name.
|
Config |
setCardinalityEstimatorConfigs(Map<String,CardinalityEstimatorConfig> cardinalityEstimatorConfigs)
Sets the map of cardinality estimator configurations, mapped by config name.
|
Config |
setClassLoader(ClassLoader classLoader)
Sets the class-loader to be used during de-serialization
and as context class-loader of Hazelcast internal threads.
|
Config |
setClusterName(String clusterName)
Sets the cluster name uniquely identifying the hazelcast cluster.
|
Config |
setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
Sets the pattern matcher which is used to match item names to
configuration objects.
|
Config |
setConfigurationFile(File configurationFile)
Sets the
File from which this configuration has been retrieved
and created. |
Config |
setConfigurationUrl(URL configurationUrl)
Sets the
URL from which this configuration has been retrieved
and created. |
Config |
setCPSubsystemConfig(CPSubsystemConfig cpSubsystemConfig)
Set CP subsystem configuration
|
Config |
setCRDTReplicationConfig(CRDTReplicationConfig crdtReplicationConfig)
Sets the replication configuration for
CRDT
implementations. |
Config |
setDeviceConfigs(Map<String,DeviceConfig> deviceConfigs)
Sets the map of
DeviceConfig s mapped by device name. |
Config |
setDurableExecutorConfigs(Map<String,DurableExecutorConfig> durableExecutorConfigs)
Sets the map of durable executor configurations, mapped by config name.
|
Config |
setDynamicConfigurationConfig(DynamicConfigurationConfig dynamicConfigurationConfig)
Sets the dynamic configuration config.
|
Config |
setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)
Sets the map of executor configurations, mapped by config name.
|
Config |
setExternalDataStoreConfigs(Map<String,ExternalDataStoreConfig> externalDataStoreConfigs)
Sets the map of external data store configurations, mapped by config name.
|
Config |
setFlakeIdGeneratorConfigs(Map<String,FlakeIdGeneratorConfig> map)
Sets the map of
FlakeIdGenerator configurations,
mapped by config name. |
Config |
setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
Deprecated.
since 5.0 use
setPersistenceConfig(PersistenceConfig) |
Config |
setInstanceName(String instanceName)
Sets the instance name uniquely identifying the hazelcast instance
created by this configuration.
|
Config |
setInstanceTrackingConfig(InstanceTrackingConfig instanceTrackingConfig)
Sets the configuration for tracking use of this Hazelcast instance.
|
Config |
setIntegrityCheckerConfig(IntegrityCheckerConfig integrityCheckerConfig)
Sets the Integrity Checker config
|
Config |
setJetConfig(JetConfig jetConfig)
Sets the Jet config
|
Config |
setLicenseKey(String licenseKey)
Sets the license key for this hazelcast instance.
|
Config |
setListConfigs(Map<String,ListConfig> listConfigs)
Sets the map of
IList configurations,
mapped by config name. |
Config |
setListenerConfigs(List<ListenerConfig> listenerConfigs)
Sets the list of
EventListener configurations. |
Config |
setLiteMember(boolean liteMember)
Sets the flag to indicate if this member is a lite member.
|
Config |
setManagedContext(ManagedContext managedContext)
Sets the external managed context.
|
Config |
setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)
Sets the management center configuration for this hazelcast instance.
|
Config |
setMapConfigs(Map<String,MapConfig> mapConfigs)
Sets the map of
IMap configurations,
mapped by config name. |
Config |
setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)
Sets the member attribute configuration.
|
Config |
setMetricsConfig(MetricsConfig metricsConfig)
Sets the metrics collection config.
|
Config |
setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)
Sets the map of
MultiMap configurations,
mapped by config name. |
Config |
setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
Sets the native memory configuration for this hazelcast instance.
|
Config |
setNetworkConfig(NetworkConfig networkConfig)
Sets the network configuration for this hazelcast instance.
|
Config |
setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)
Sets the partition group configuration for this hazelcast instance.
|
Config |
setPersistenceConfig(PersistenceConfig persistenceConfig)
Sets the Persistence configuration.
|
Config |
setPNCounterConfigs(Map<String,PNCounterConfig> pnCounterConfigs)
Sets the map of PN counter configurations, mapped by config name.
|
Config |
setProperties(Properties properties)
Sets the properties for this config instance.
|
Config |
setProperty(String name,
String value)
Sets the value of a named property.
|
Config |
setQueueConfigs(Map<String,QueueConfig> queueConfigs)
Sets the map of
IQueue configurations,
mapped by config name. |
Config |
setReliableTopicConfigs(Map<String,ReliableTopicConfig> reliableTopicConfigs)
Sets the map of reliable topic configurations, mapped by config name.
|
Config |
setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)
Sets the map of
ReplicatedMap configurations,
mapped by config name. |
Config |
setRingbufferConfigs(Map<String,RingbufferConfig> ringbufferConfigs)
Sets the map of
Ringbuffer configurations,
mapped by config name. |
Config |
setScheduledExecutorConfigs(Map<String,ScheduledExecutorConfig> scheduledExecutorConfigs)
Sets the map of scheduled executor configurations, mapped by config name.
|
Config |
setSecurityConfig(SecurityConfig securityConfig)
Sets the security configuration for this hazelcast instance.
|
Config |
setSerializationConfig(SerializationConfig serializationConfig)
Sets the serialization configuration for this hazelcast instance.
|
Config |
setSetConfigs(Map<String,SetConfig> setConfigs)
Sets the map of
ISet configurations,
mapped by config name. |
Config |
setSplitBrainProtectionConfigs(Map<String,SplitBrainProtectionConfig> splitBrainProtectionConfigs)
Sets the map of split-brain protection configurations, mapped by config
name.
|
Config |
setSqlConfig(SqlConfig sqlConfig)
Sets SQL config.
|
Config |
setTopicConfigs(Map<String,TopicConfig> topicConfigs)
Sets the map of
ITopic configurations,
mapped by config name. |
Config |
setUserCodeDeploymentConfig(UserCodeDeploymentConfig userCodeDeploymentConfig)
Set User Code Deployment configuration
|
Config |
setUserContext(ConcurrentMap<String,Object> userContext)
Sets the user supplied context.
|
Config |
setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)
Sets the map of WAN replication configurations, mapped by config name.
|
String |
toString() |
public static final String DEFAULT_CLUSTER_NAME
public Config()
public Config(String instanceName)
public static Config load()
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()
.
public static Config loadDefault()
load()
, i.e., loads Config using the default lookup mechanismpublic static Config loadDefault(Properties properties)
lookup mechanism
to locate the configuration file
and applies variable resolution from the provided properties.properties
- properties to resolve variables in the XML or YAMLpublic static Config loadFromClasspath(ClassLoader classLoader, String resource)
classLoader
- the ClassLoader used to load the resourceresource
- the resource, an XML or YAML configuration file from
the classpath, without the "classpath:" prefixIllegalArgumentException
- if classLoader or resource is null
,
or if the resource is not foundInvalidConfigurationException
- if the resource content is invalidpublic static Config loadFromClasspath(ClassLoader classLoader, String resource, Properties properties)
properties
to resolve the variables in the resource.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 resourceIllegalArgumentException
- if classLoader or resource is null
,
or if the resource is not foundInvalidConfigurationException
- if the resource content is invalidpublic static Config loadFromFile(File configFile) throws FileNotFoundException
configFile
- the path of the configuration fileFileNotFoundException
- if the file doesn't existInvalidConfigurationException
- if the file content is invalidpublic static Config loadFromFile(File configFile, Properties properties) throws FileNotFoundException
configFile
- the path of the configuration fileproperties
- properties to use for variable resolution in the fileFileNotFoundException
- if the file doesn't existInvalidConfigurationException
- if the file content is invalidpublic static Config loadFromString(String source)
source
- the XML or YAML contentIllegalArgumentException
- if the source is null or emptyHazelcastException
- if the source content is invalidpublic static Config loadFromString(String source, Properties properties)
source
- the XML or YAML contentproperties
- properties to use for variable resolutionIllegalArgumentException
- if the source is null or emptyHazelcastException
- if the source content is invalidpublic static Config loadFromStream(InputStream source)
source
- the XML or YAML streamHazelcastException
- if the source content is invalidpublic static Config loadFromStream(InputStream source, Properties properties)
source
- the XML or YAML streamproperties
- properties to use for variable resolutionpublic ClassLoader getClassLoader()
If null
, then thread context class-loader will be used instead.
public Config setClassLoader(ClassLoader classLoader)
If not set (or set to null
); thread context class-loader
will be used in required places.
Default value is null
.
classLoader
- class-loader to be used during de-serializationpublic ConfigPatternMatcher getConfigPatternMatcher()
MatchingPointConfigPatternMatcher
is used.public Config setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
MatchingPointConfigPatternMatcher
is used.configPatternMatcher
- the pattern matcherIllegalArgumentException
- if the pattern matcher is null
public String getProperty(String name)
name
- property namesetProperty(String, String)
,
Hazelcast System Propertiespublic Config setProperty(@Nonnull String name, @Nonnull String value)
name
- property namevalue
- value of the propertyIllegalArgumentException
- if either value
is null
or if name
is empty or
null
public MemberAttributeConfig getMemberAttributeConfig()
setProperties(Properties)
), member
attributes are exchanged with other members, e.g. on membership events.public Config setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)
setProperties(Properties)
), member
attributes are exchanged with other members, e.g. on membership events.memberAttributeConfig
- the member attribute configurationpublic Properties getProperties()
public Config setProperties(Properties properties)
properties
- the config propertiespublic String getInstanceName()
public Config setInstanceName(String instanceName)
instanceName
- the hazelcast instance namepublic String getClusterName()
public Config setClusterName(String clusterName)
clusterName
- the new cluster nameIllegalArgumentException
- if name is null
public NetworkConfig getNetworkConfig()
public Config setNetworkConfig(NetworkConfig networkConfig)
networkConfig
- the network configurationpublic MapConfig findMapConfig(String name)
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.
name
- name of the map configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public MapConfig getMapConfigOrNull(String name)
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
.name
- name of the map confignull
if none was foundInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public MapConfig getMapConfig(String name)
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.
name
- name of the map configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addMapConfig(MapConfig mapConfig)
mapConfig
- the map configurationpublic Map<String,MapConfig> getMapConfigs()
IMap
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public Config setMapConfigs(Map<String,MapConfig> mapConfigs)
IMap
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.mapConfigs
- the IMap configuration map to setpublic CacheSimpleConfig findCacheConfig(String name)
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
.
name
- name of the cardinality estimator configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public CacheSimpleConfig findCacheConfigOrNull(String name)
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
.name
- name of the cache confignull
if none was foundInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public CacheSimpleConfig getCacheConfig(String name)
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.
name
- name of the cache configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addCacheConfig(CacheSimpleConfig cacheConfig)
cacheConfig
- the cache configurationpublic Map<String,CacheSimpleConfig> getCacheConfigs()
public Config setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)
cacheConfigs
- the cacheConfigs to setpublic QueueConfig findQueueConfig(String name)
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
.
name
- name of the queue configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public QueueConfig getQueueConfig(String name)
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.
name
- name of the queue configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addQueueConfig(QueueConfig queueConfig)
queueConfig
- the queue configurationpublic Map<String,QueueConfig> getQueueConfigs()
IQueue
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public Config setQueueConfigs(Map<String,QueueConfig> queueConfigs)
IQueue
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.queueConfigs
- the queue configuration map to setpublic ListConfig findListConfig(String name)
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
.
name
- name of the list configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public ListConfig getListConfig(String name)
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.
name
- name of the list configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addListConfig(ListConfig listConfig)
listConfig
- the list configurationpublic Map<String,ListConfig> getListConfigs()
IList
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public Config setListConfigs(Map<String,ListConfig> listConfigs)
IList
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.listConfigs
- the list configuration map to setpublic SetConfig findSetConfig(String name)
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
.
name
- name of the set configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public SetConfig getSetConfig(String name)
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.
name
- name of the set configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addSetConfig(SetConfig setConfig)
setConfig
- the set configurationpublic Map<String,SetConfig> getSetConfigs()
ISet
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public Config setSetConfigs(Map<String,SetConfig> setConfigs)
ISet
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.setConfigs
- the set configuration map to setpublic MultiMapConfig findMultiMapConfig(String name)
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
.
name
- name of the multimap configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public MultiMapConfig getMultiMapConfig(String name)
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.
name
- name of the multimap configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addMultiMapConfig(MultiMapConfig multiMapConfig)
multiMapConfig
- the multimap configurationpublic Map<String,MultiMapConfig> getMultiMapConfigs()
MultiMap
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public Config setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)
MultiMap
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.multiMapConfigs
- the multimap configuration map to setpublic ReplicatedMapConfig findReplicatedMapConfig(String name)
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
.
name
- name of the replicated map configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public ReplicatedMapConfig getReplicatedMapConfig(String name)
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.
name
- name of the replicated map configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)
replicatedMapConfig
- the replicated map configurationpublic Map<String,ReplicatedMapConfig> getReplicatedMapConfigs()
ReplicatedMap
configurations, mapped by config name. The config name may be a pattern
with which the configuration was initially obtained.public Config setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)
ReplicatedMap
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.replicatedMapConfigs
- the replicated map configuration map to setpublic RingbufferConfig findRingbufferConfig(String name)
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
.
name
- name of the ringbuffer configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public RingbufferConfig getRingbufferConfig(String name)
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.
name
- name of the ringbuffer configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addRingBufferConfig(RingbufferConfig ringbufferConfig)
ringbufferConfig
- the ringbuffer configurationpublic Map<String,RingbufferConfig> getRingbufferConfigs()
Ringbuffer
configurations, mapped by config name. The config name may be a pattern
with which the configuration was initially obtained.public Config setRingbufferConfigs(Map<String,RingbufferConfig> ringbufferConfigs)
Ringbuffer
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.ringbufferConfigs
- the ringbuffer configuration map to setpublic TopicConfig findTopicConfig(String name)
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
.
name
- name of the topic configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public TopicConfig getTopicConfig(String name)
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.
name
- name of the topic configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addTopicConfig(TopicConfig topicConfig)
topicConfig
- the topic configurationpublic ReliableTopicConfig findReliableTopicConfig(String 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
.
name
- name of the reliable topic configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public ReliableTopicConfig getReliableTopicConfig(String name)
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.
name
- name of the reliable topic configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Map<String,ReliableTopicConfig> getReliableTopicConfigs()
public Config addReliableTopicConfig(ReliableTopicConfig topicConfig)
topicConfig
- the reliable topic configurationpublic Config setReliableTopicConfigs(Map<String,ReliableTopicConfig> reliableTopicConfigs)
reliableTopicConfigs
- the reliable topic configuration map to setpublic Map<String,TopicConfig> getTopicConfigs()
public Config setTopicConfigs(Map<String,TopicConfig> topicConfigs)
ITopic
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.topicConfigs
- the topic configuration map to setpublic ExecutorConfig findExecutorConfig(String 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
.
name
- name of the executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public DurableExecutorConfig findDurableExecutorConfig(String 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
.
name
- name of the durable executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public ScheduledExecutorConfig findScheduledExecutorConfig(String 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
.
name
- name of the scheduled executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public CardinalityEstimatorConfig findCardinalityEstimatorConfig(String name)
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
.
name
- name of the cardinality estimator configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public PNCounterConfig findPNCounterConfig(String name)
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
.
name
- name of the PN counter configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public ExecutorConfig getExecutorConfig(String name)
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.
name
- name of the executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public DurableExecutorConfig getDurableExecutorConfig(String name)
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.
name
- name of the durable executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public ScheduledExecutorConfig getScheduledExecutorConfig(String name)
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.
name
- name of the scheduled executor configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public CardinalityEstimatorConfig getCardinalityEstimatorConfig(String name)
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.
name
- name of the cardinality estimator configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public PNCounterConfig getPNCounterConfig(String name)
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.
name
- name of the PN counter configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addExecutorConfig(ExecutorConfig executorConfig)
executorConfig
- executor config to addpublic Config addDurableExecutorConfig(DurableExecutorConfig durableExecutorConfig)
durableExecutorConfig
- durable executor config to addpublic Config addScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)
scheduledExecutorConfig
- scheduled executor config to addpublic Config addCardinalityEstimatorConfig(CardinalityEstimatorConfig cardinalityEstimatorConfig)
cardinalityEstimatorConfig
- cardinality estimator config to addpublic Config addPNCounterConfig(PNCounterConfig pnCounterConfig)
pnCounterConfig
- PN counter config to addpublic Map<String,ExecutorConfig> getExecutorConfigs()
public Config setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)
executorConfigs
- the executor configuration map to setpublic Map<String,DurableExecutorConfig> getDurableExecutorConfigs()
public Config setDurableExecutorConfigs(Map<String,DurableExecutorConfig> durableExecutorConfigs)
durableExecutorConfigs
- the durable executor configuration map to setpublic Map<String,ScheduledExecutorConfig> getScheduledExecutorConfigs()
public Config setScheduledExecutorConfigs(Map<String,ScheduledExecutorConfig> scheduledExecutorConfigs)
scheduledExecutorConfigs
- the scheduled executor configuration
map to setpublic Map<String,CardinalityEstimatorConfig> getCardinalityEstimatorConfigs()
public Config setCardinalityEstimatorConfigs(Map<String,CardinalityEstimatorConfig> cardinalityEstimatorConfigs)
cardinalityEstimatorConfigs
- the cardinality estimator
configuration map to setpublic Map<String,PNCounterConfig> getPNCounterConfigs()
public Config setPNCounterConfigs(Map<String,PNCounterConfig> pnCounterConfigs)
pnCounterConfigs
- the PN counter configuration map to setpublic WanReplicationConfig getWanReplicationConfig(String name)
name
.name
- the WAN replication config namepublic Config addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)
WanReplicationConfig.getName()
.wanReplicationConfig
- the WAN replication configpublic Map<String,WanReplicationConfig> getWanReplicationConfigs()
public Config setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)
wanReplicationConfigs
- the WAN replication configuration map to setpublic Map<String,SplitBrainProtectionConfig> getSplitBrainProtectionConfigs()
public SplitBrainProtectionConfig getSplitBrainProtectionConfig(String name)
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.
name
- name of the split-brain protection configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public SplitBrainProtectionConfig findSplitBrainProtectionConfig(String 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
.
name
- name of the split-brain protection configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
public Config setSplitBrainProtectionConfigs(Map<String,SplitBrainProtectionConfig> splitBrainProtectionConfigs)
splitBrainProtectionConfigs
- the split-brain protection configuration map to setpublic Config addSplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
SplitBrainProtectionConfig.getName()
.splitBrainProtectionConfig
- split-brain protection config to addpublic ManagementCenterConfig getManagementCenterConfig()
public Config setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)
managementCenterConfig
- the management center configurationpublic SecurityConfig getSecurityConfig()
public Config setSecurityConfig(SecurityConfig securityConfig)
securityConfig
- the security configurationpublic Config addListenerConfig(ListenerConfig listenerConfig)
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.listenerConfig
- the listener configurationpublic List<ListenerConfig> getListenerConfigs()
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.public Config setListenerConfigs(List<ListenerConfig> listenerConfigs)
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.listenerConfigs
- the listener configurationspublic Map<String,FlakeIdGeneratorConfig> getFlakeIdGeneratorConfigs()
FlakeIdGenerator
configurations,
mapped by config name. The config name may be a pattern with which the
configuration was initially obtained.public FlakeIdGeneratorConfig findFlakeIdGeneratorConfig(String name)
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"
.
name
- name of the flake ID generator configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public FlakeIdGeneratorConfig getFlakeIdGeneratorConfig(String name)
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.
name
- name of the flake ID generator configInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
public Config addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig config)
config
- the flake ID generator configurationpublic Config setFlakeIdGeneratorConfigs(Map<String,FlakeIdGeneratorConfig> map)
FlakeIdGenerator
configurations,
mapped by config name. The config name may be a pattern with which the
configuration will be obtained in the future.map
- the FlakeIdGenerator configuration map to setpublic SerializationConfig getSerializationConfig()
public Config setSerializationConfig(SerializationConfig serializationConfig)
serializationConfig
- the serialization configurationpublic PartitionGroupConfig getPartitionGroupConfig()
public Config setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)
partitionGroupConfig
- the partition group configurationpublic HotRestartPersistenceConfig getHotRestartPersistenceConfig()
public PersistenceConfig getPersistenceConfig()
@Deprecated public Config setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
setPersistenceConfig(PersistenceConfig)
hrConfig
- Hot Restart configurationNullPointerException
- if the hrConfig
parameter is null
public Config setPersistenceConfig(PersistenceConfig persistenceConfig)
persistenceConfig
- Persistence configurationNullPointerException
- if the persistenceConfig
parameter is null
public Map<String,DeviceConfig> getDeviceConfigs()
LocalDeviceConfig
s mapped by device name.public Config setDeviceConfigs(Map<String,DeviceConfig> deviceConfigs)
DeviceConfig
s mapped by device name.deviceConfigs
- device configuration map@Nullable public <T extends DeviceConfig> T getDeviceConfig(String name)
name
- the device namenull
if absent@Nullable public <T extends DeviceConfig> T getDeviceConfig(Class<T> clazz, String name)
name
- the device nameclazz
- desired device implementation classnull
if absentpublic Config addDeviceConfig(DeviceConfig deviceConfig)
deviceConfig
- device configpublic CRDTReplicationConfig getCRDTReplicationConfig()
public Config setCRDTReplicationConfig(CRDTReplicationConfig crdtReplicationConfig)
CRDT
implementations.crdtReplicationConfig
- the replication configurationNullPointerException
- if the crdtReplicationConfig
parameter is null
public ManagedContext getManagedContext()
public Config setManagedContext(ManagedContext managedContext)
managedContext
- the managed contextpublic ConcurrentMap<String,Object> getUserContext()
HazelcastInstance
.HazelcastInstance.getUserContext()
public Config setUserContext(ConcurrentMap<String,Object> userContext)
HazelcastInstance
.userContext
- the user supplied contextHazelcastInstance.getUserContext()
public NativeMemoryConfig getNativeMemoryConfig()
public Config setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
nativeMemoryConfig
- the native memory configurationpublic URL getConfigurationUrl()
URL
to the declarative configuration, which has been parsed
to create this Config
instance.null
otherwisepublic Config setConfigurationUrl(URL configurationUrl)
URL
from which this configuration has been retrieved
and created.
Is set by the XmlConfigBuilder
, when the XML configuration was
retrieved from a URL.
configurationUrl
- the configuration URL to setpublic File getConfigurationFile()
File
to the declarative configuration, which has been
parsed to create this Config
instance.null
otherwisepublic Config setConfigurationFile(File configurationFile)
File
from which this configuration has been retrieved
and created.
Is set by the XmlConfigBuilder
, when the XML configuration was
retrieved from a file.
configurationFile
- the configuration file to setpublic String getLicenseKey()
SecurityException
- If a security manager exists and the calling method doesn't have corresponding
HazelcastRuntimePermission
public Config setLicenseKey(String licenseKey)
licenseKey
- the license keypublic boolean isLiteMember()
true
if this member is a lite member. A lite member
does not own any partitions.true
if this member is a lite memberpublic Config setLiteMember(boolean liteMember)
liteMember
- if this member is a lite memberpublic UserCodeDeploymentConfig getUserCodeDeploymentConfig()
public Config setUserCodeDeploymentConfig(UserCodeDeploymentConfig userCodeDeploymentConfig)
userCodeDeploymentConfig
- the user code deployment configurationpublic AdvancedNetworkConfig getAdvancedNetworkConfig()
public Config setAdvancedNetworkConfig(AdvancedNetworkConfig advancedNetworkConfig)
public CPSubsystemConfig getCPSubsystemConfig()
public Config setCPSubsystemConfig(CPSubsystemConfig cpSubsystemConfig)
cpSubsystemConfig
- the CP subsystem configuration@Nonnull public MetricsConfig getMetricsConfig()
@Nonnull public Config setMetricsConfig(@Nonnull MetricsConfig metricsConfig)
@Nonnull public AuditlogConfig getAuditlogConfig()
@Nonnull public Config setAuditlogConfig(@Nonnull AuditlogConfig auditlogConfig)
@Nonnull public InstanceTrackingConfig getInstanceTrackingConfig()
@Nonnull public Config setInstanceTrackingConfig(@Nonnull InstanceTrackingConfig instanceTrackingConfig)
public DynamicConfigurationConfig getDynamicConfigurationConfig()
public Config setDynamicConfigurationConfig(DynamicConfigurationConfig dynamicConfigurationConfig)
@Nonnull public IntegrityCheckerConfig getIntegrityCheckerConfig()
@Nonnull public Config setIntegrityCheckerConfig(IntegrityCheckerConfig integrityCheckerConfig)
@Beta public Map<String,ExternalDataStoreConfig> getExternalDataStoreConfigs()
@Beta public Config setExternalDataStoreConfigs(Map<String,ExternalDataStoreConfig> externalDataStoreConfigs)
Example configuration: see addExternalDataStoreConfig(com.hazelcast.config.ExternalDataStoreConfig)
@Beta public Config addExternalDataStoreConfig(ExternalDataStoreConfig externalDataStoreConfig)
Example:
Config config = new Config();
Properties properties = new Properties();
properties.put("jdbcUrl", jdbcUrl);
properties.put("username", username);
properties.put("password", password);
ExternalDataStoreConfig externalDataStoreConfig = new ExternalDataStoreConfig()
.setName("my-jdbc-data-store")
.setClassName(JdbcDataStoreFactory.class.getName())
.setProperties(properties);
config.addExternalDataStoreConfig(externalDataStoreConfig);
@Beta public ExternalDataStoreConfig getExternalDataStoreConfig(String name)
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
addExternalDataStoreConfig(ExternalDataStoreConfig)
.
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.
name
- data store nameInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
@Beta public ExternalDataStoreConfig findExternalDataStoreConfig(String name)
ExternalDataStoreConfig
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
.
name
- name of the external DataStoreInvalidConfigurationException
- if ambiguous configurations are
foundStringPartitioningStrategy.getBaseName(java.lang.String)
,
setConfigPatternMatcher(ConfigPatternMatcher)
,
getConfigPatternMatcher()
,
EvictionConfig.setSize(int)
@PrivateApi protected com.hazelcast.internal.config.ServicesConfig getServicesConfig()
Copyright © 2023 Hazelcast, Inc.. All rights reserved.