Config (hazelcast-client-protocol 1.0.0 API)

java.lang.Object
- com.hazelcast.config.Config

Direct Known Subclasses:

ClasspathXmlConfig, FileSystemXmlConfig, InMemoryXmlConfig, UrlXmlConfig
```
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.

Constructor Summary

Constructors
Constructor and Description

Config()

Config(String instanceName)

Constructors
Constructor and Description
`Config()`
`Config(String instanceName)`

Method Summary

Methods
Modifier and Type	Method and Description
`Config`	`addCacheConfig(CacheSimpleConfig cacheConfig)`
`Config`	`addExecutorConfig(ExecutorConfig executorConfig)` Adds a new ExecutorConfig by name
`Config`	`addJobTrackerConfig(JobTrackerConfig jobTrackerConfig)`
`Config`	`addListConfig(ListConfig listConfig)`
`Config`	`addListenerConfig(ListenerConfig listenerConfig)`
`Config`	`addMapConfig(MapConfig mapConfig)`
`Config`	`addMultiMapConfig(MultiMapConfig multiMapConfig)`
`Config`	`addQueueConfig(QueueConfig queueConfig)`
`Config`	`addQuorumConfig(QuorumConfig quorumConfig)`
`Config`	`addReliableTopicConfig(ReliableTopicConfig topicConfig)`
`Config`	`addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)`
`Config`	`addRingBufferConfig(RingbufferConfig ringbufferConfig)`
`Config`	`addSemaphoreConfig(SemaphoreConfig semaphoreConfig)` Adds a new SemaphoreConfig by name
`Config`	`addSetConfig(SetConfig setConfig)`
`Config`	`addTopicConfig(TopicConfig topicConfig)`
`Config`	`addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)`
`CacheSimpleConfig`	`findCacheConfig(String name)`
`ExecutorConfig`	`findExecutorConfig(String name)`
`JobTrackerConfig`	`findJobTrackerConfig(String name)`
`ListConfig`	`findListConfig(String name)`
`MapConfig`	`findMapConfig(String name)`
`MultiMapConfig`	`findMultiMapConfig(String name)`
`QueueConfig`	`findQueueConfig(String name)`
`QuorumConfig`	`findQuorumConfig(String name)`
`ReliableTopicConfig`	`findReliableTopicConfig(String name)`
`ReplicatedMapConfig`	`findReplicatedMapConfig(String name)`
`RingbufferConfig`	`findRingbufferConfig(String name)`
`SemaphoreConfig`	`findSemaphoreConfig(String name)`
`SetConfig`	`findSetConfig(String name)`
`TopicConfig`	`findTopicConfig(String name)`
`CacheSimpleConfig`	`getCacheConfig(String name)`
`Map<String,CacheSimpleConfig>`	`getCacheConfigs()`
`ClassLoader`	`getClassLoader()` Returns the class-loader that will be used in serialization.
`ConfigPatternMatcher`	`getConfigPatternMatcher()`
`File`	`getConfigurationFile()`
`URL`	`getConfigurationUrl()`
`ExecutorConfig`	`getExecutorConfig(String name)` Returns the ExecutorConfig for the given name
`Map<String,ExecutorConfig>`	`getExecutorConfigs()`
`GroupConfig`	`getGroupConfig()`
`HotRestartPersistenceConfig`	`getHotRestartPersistenceConfig()` Returns hot restart configuration for this member
`String`	`getInstanceName()`
`JobTrackerConfig`	`getJobTrackerConfig(String name)`
`Map<String,JobTrackerConfig>`	`getJobTrackerConfigs()`
`String`	`getLicenseKey()`
`ListConfig`	`getListConfig(String name)`
`Map<String,ListConfig>`	`getListConfigs()`
`List<ListenerConfig>`	`getListenerConfigs()`
`ManagedContext`	`getManagedContext()`
`ManagementCenterConfig`	`getManagementCenterConfig()`
`MapConfig`	`getMapConfig(String name)`
`Map<String,MapConfig>`	`getMapConfigs()`
`MemberAttributeConfig`	`getMemberAttributeConfig()`
`MultiMapConfig`	`getMultiMapConfig(String name)`
`Map<String,MultiMapConfig>`	`getMultiMapConfigs()`
`NativeMemoryConfig`	`getNativeMemoryConfig()`
`NetworkConfig`	`getNetworkConfig()`
`PartitionGroupConfig`	`getPartitionGroupConfig()`
`Properties`	`getProperties()`
`String`	`getProperty(HazelcastProperty property)` Gets a `HazelcastProperty` already set or from system properties if not exists.
`String`	`getProperty(String name)` Gets a named property already set or from system properties if not exists.
`QueueConfig`	`getQueueConfig(String name)`
`Map<String,QueueConfig>`	`getQueueConfigs()`
`QuorumConfig`	`getQuorumConfig(String name)`
`Map<String,QuorumConfig>`	`getQuorumConfigs()`
`ReliableTopicConfig`	`getReliableTopicConfig(String name)`
`Map<String,ReliableTopicConfig>`	`getReliableTopicConfigs()`
`ReplicatedMapConfig`	`getReplicatedMapConfig(String name)`
`Map<String,ReplicatedMapConfig>`	`getReplicatedMapConfigs()`
`RingbufferConfig`	`getRingbufferConfig(String name)`
`Map<String,RingbufferConfig>`	`getRingbufferConfigs()`
`SecurityConfig`	`getSecurityConfig()`
`SemaphoreConfig`	`getSemaphoreConfig(String name)` Returns the SemaphoreConfig for the given name
`Collection<SemaphoreConfig>`	`getSemaphoreConfigs()` Returns the collection of semaphore configs.
`SerializationConfig`	`getSerializationConfig()`
`ServicesConfig`	`getServicesConfig()`
`SetConfig`	`getSetConfig(String name)`
`Map<String,SetConfig>`	`getSetConfigs()`
`TopicConfig`	`getTopicConfig(String name)`
`Map<String,TopicConfig>`	`getTopicConfigs()`
`ConcurrentMap<String,Object>`	`getUserContext()`
`WanReplicationConfig`	`getWanReplicationConfig(String name)`
`Map<String,WanReplicationConfig>`	`getWanReplicationConfigs()`
`boolean`	`isCompatible(Config config)`
`boolean`	`isLiteMember()`
`Config`	`setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)`
`Config`	`setClassLoader(ClassLoader classLoader)` Sets the class-loader to be used during de-serialization and as context class-loader of Hazelcast internal threads.
`void`	`setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)`
`Config`	`setConfigurationFile(File configurationFile)`
`Config`	`setConfigurationUrl(URL configurationUrl)`
`Config`	`setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)`
`Config`	`setGroupConfig(GroupConfig groupConfig)`
`Config`	`setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)` Sets hot restart configuration.
`Config`	`setInstanceName(String instanceName)`
`Config`	`setJobTrackerConfigs(Map<String,JobTrackerConfig> jobTrackerConfigs)`
`Config`	`setLicenseKey(String licenseKey)`
`Config`	`setListConfigs(Map<String,ListConfig> listConfigs)`
`Config`	`setListenerConfigs(List<ListenerConfig> listenerConfigs)`
`Config`	`setLiteMember(boolean liteMember)`
`Config`	`setManagedContext(ManagedContext managedContext)`
`Config`	`setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)`
`Config`	`setMapConfigs(Map<String,MapConfig> mapConfigs)`
`void`	`setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)`
`Config`	`setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)`
`Config`	`setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)`
`Config`	`setNetworkConfig(NetworkConfig networkConfig)`
`Config`	`setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)`
`Config`	`setProperties(Properties properties)`
`Config`	`setProperty(HazelcastProperty property, String value)` Sets the value of a `HazelcastProperty`.
`Config`	`setProperty(String name, String value)` Sets the value of a named property.
`Config`	`setQueueConfigs(Map<String,QueueConfig> queueConfigs)`
`Config`	`setQuorumConfigs(Map<String,QuorumConfig> quorumConfigs)`
`Config`	`setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)`
`Config`	`setSecurityConfig(SecurityConfig securityConfig)`
`Config`	`setSemaphoreConfigs(Map<String,SemaphoreConfig> semaphoreConfigs)`
`Config`	`setSerializationConfig(SerializationConfig serializationConfig)`
`Config`	`setServicesConfig(ServicesConfig servicesConfig)`
`Config`	`setSetConfigs(Map<String,SetConfig> setConfigs)`
`Config`	`setTopicConfigs(Map<String,TopicConfig> mapTopicConfigs)`
`Config`	`setUserContext(ConcurrentMap<String,Object> userContext)`
`Config`	`setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Config
```
public Config()
```

Config
```
public Config(String instanceName)
```

Method Detail

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()

setConfigPatternMatcher

public void setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)

getProperty
```
public String getProperty(String name)
```
Gets a named property already set or from system properties if not exists.

Parameters:
name - property name

Returns:
value of the property

setProperty
```
public Config setProperty(String name,
                 String value)
```
Sets the value of a named property.

Parameters:
name - property name
value - value of the property

Returns:
configured Config for chaining

getProperty
```
public String getProperty(HazelcastProperty property)
```
Gets a HazelcastProperty already set or from system properties if not exists.

Parameters:
property - HazelcastProperty to get

Returns:
value of the property

setProperty
```
public Config setProperty(HazelcastProperty property,
                 String value)
```
Sets the value of a HazelcastProperty.

Parameters:
property - HazelcastProperty to set
value - value of the property

Returns:
configured Config for chaining
See Also:
HazelcastProperty} for properties that is used to configure client

getMemberAttributeConfig

public MemberAttributeConfig getMemberAttributeConfig()

setMemberAttributeConfig

public void setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)

getProperties
```
public Properties getProperties()
```

setProperties

public Config setProperties(Properties properties)

getInstanceName
```
public String getInstanceName()
```

setInstanceName

public Config setInstanceName(String instanceName)

getGroupConfig
```
public GroupConfig getGroupConfig()
```

setGroupConfig

public Config setGroupConfig(GroupConfig groupConfig)

getNetworkConfig

public NetworkConfig getNetworkConfig()

setNetworkConfig

public Config setNetworkConfig(NetworkConfig networkConfig)

findMapConfig

public MapConfig findMapConfig(String name)

getMapConfig

public MapConfig getMapConfig(String name)

addMapConfig

public Config addMapConfig(MapConfig mapConfig)

getMapConfigs

public Map<String,MapConfig> getMapConfigs()

Returns:: the mapConfigs

setMapConfigs

public Config setMapConfigs(Map<String,MapConfig> mapConfigs)

Parameters:: mapConfigs - the mapConfigs to set

findCacheConfig

public CacheSimpleConfig findCacheConfig(String name)

getCacheConfig

public CacheSimpleConfig getCacheConfig(String name)

addCacheConfig

public Config addCacheConfig(CacheSimpleConfig cacheConfig)

getCacheConfigs

public Map<String,CacheSimpleConfig> getCacheConfigs()

Returns:: the cacheConfigs

setCacheConfigs

public Config setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)

Parameters:: cacheConfigs - the cacheConfigs to set

findQueueConfig

public QueueConfig findQueueConfig(String name)

getQueueConfig

public QueueConfig getQueueConfig(String name)

addQueueConfig

public Config addQueueConfig(QueueConfig queueConfig)

getQueueConfigs

public Map<String,QueueConfig> getQueueConfigs()

setQueueConfigs

public Config setQueueConfigs(Map<String,QueueConfig> queueConfigs)

findListConfig

public ListConfig findListConfig(String name)

getListConfig

public ListConfig getListConfig(String name)

addListConfig

public Config addListConfig(ListConfig listConfig)

getListConfigs

public Map<String,ListConfig> getListConfigs()

setListConfigs

public Config setListConfigs(Map<String,ListConfig> listConfigs)

findSetConfig

public SetConfig findSetConfig(String name)

getSetConfig

public SetConfig getSetConfig(String name)

addSetConfig

public Config addSetConfig(SetConfig setConfig)

getSetConfigs

public Map<String,SetConfig> getSetConfigs()

setSetConfigs

public Config setSetConfigs(Map<String,SetConfig> setConfigs)

findMultiMapConfig

public MultiMapConfig findMultiMapConfig(String name)

getMultiMapConfig

public MultiMapConfig getMultiMapConfig(String name)

addMultiMapConfig

public Config addMultiMapConfig(MultiMapConfig multiMapConfig)

getMultiMapConfigs

public Map<String,MultiMapConfig> getMultiMapConfigs()

setMultiMapConfigs

public Config setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)

findReplicatedMapConfig

public ReplicatedMapConfig findReplicatedMapConfig(String name)

getReplicatedMapConfig

public ReplicatedMapConfig getReplicatedMapConfig(String name)

addReplicatedMapConfig

public Config addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)

getReplicatedMapConfigs

public Map<String,ReplicatedMapConfig> getReplicatedMapConfigs()

setReplicatedMapConfigs

public Config setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)

findRingbufferConfig

public RingbufferConfig findRingbufferConfig(String name)

getRingbufferConfig

public RingbufferConfig getRingbufferConfig(String name)

addRingBufferConfig

public Config addRingBufferConfig(RingbufferConfig ringbufferConfig)

getRingbufferConfigs

public Map<String,RingbufferConfig> getRingbufferConfigs()

findTopicConfig

public TopicConfig findTopicConfig(String name)

getTopicConfig

public TopicConfig getTopicConfig(String name)

addTopicConfig

public Config addTopicConfig(TopicConfig topicConfig)

findReliableTopicConfig

public ReliableTopicConfig findReliableTopicConfig(String name)

getReliableTopicConfig

public ReliableTopicConfig getReliableTopicConfig(String name)

getReliableTopicConfigs

public Map<String,ReliableTopicConfig> getReliableTopicConfigs()

Returns:: the reliable topic configs

addReliableTopicConfig

public Config addReliableTopicConfig(ReliableTopicConfig topicConfig)

getTopicConfigs

public Map<String,TopicConfig> getTopicConfigs()

Returns:: the topicConfigs

setTopicConfigs

public Config setTopicConfigs(Map<String,TopicConfig> mapTopicConfigs)

Parameters:: mapTopicConfigs - the topicConfigs to set

findExecutorConfig

public ExecutorConfig findExecutorConfig(String name)

getExecutorConfig
```
public ExecutorConfig getExecutorConfig(String name)
```
Returns the ExecutorConfig for the given name

Parameters:
name - name of the executor config

Returns:
ExecutorConfig

addExecutorConfig
```
public Config addExecutorConfig(ExecutorConfig executorConfig)
```
Adds a new ExecutorConfig by name

Parameters:
executorConfig - executor config to add

Returns:
this config instance

getExecutorConfigs

public Map<String,ExecutorConfig> getExecutorConfigs()

setExecutorConfigs

public Config setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)

findSemaphoreConfig

public SemaphoreConfig findSemaphoreConfig(String name)

getSemaphoreConfig
```
public SemaphoreConfig getSemaphoreConfig(String name)
```
Returns the SemaphoreConfig for the given name

Parameters:
name - name of the semaphore config

Returns:
SemaphoreConfig

addSemaphoreConfig
```
public Config addSemaphoreConfig(SemaphoreConfig semaphoreConfig)
```
Adds a new SemaphoreConfig by name

Parameters:
semaphoreConfig - semaphore config to add

Returns:
this config instance

getSemaphoreConfigs
```
public Collection<SemaphoreConfig> getSemaphoreConfigs()
```
Returns the collection of semaphore configs.

Returns:
collection of semaphore configs.

setSemaphoreConfigs

public Config setSemaphoreConfigs(Map<String,SemaphoreConfig> semaphoreConfigs)

getWanReplicationConfig

public WanReplicationConfig getWanReplicationConfig(String name)

addWanReplicationConfig

public Config addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)

getWanReplicationConfigs

public Map<String,WanReplicationConfig> getWanReplicationConfigs()

setWanReplicationConfigs

public Config setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)

findJobTrackerConfig

public JobTrackerConfig findJobTrackerConfig(String name)

getJobTrackerConfig

public JobTrackerConfig getJobTrackerConfig(String name)

addJobTrackerConfig

public Config addJobTrackerConfig(JobTrackerConfig jobTrackerConfig)

getJobTrackerConfigs

public Map<String,JobTrackerConfig> getJobTrackerConfigs()

setJobTrackerConfigs

public Config setJobTrackerConfigs(Map<String,JobTrackerConfig> jobTrackerConfigs)

getQuorumConfigs

public Map<String,QuorumConfig> getQuorumConfigs()

getQuorumConfig

public QuorumConfig getQuorumConfig(String name)

findQuorumConfig

public QuorumConfig findQuorumConfig(String name)

setQuorumConfigs

public Config setQuorumConfigs(Map<String,QuorumConfig> quorumConfigs)

addQuorumConfig

public Config addQuorumConfig(QuorumConfig quorumConfig)

getManagementCenterConfig

public ManagementCenterConfig getManagementCenterConfig()

setManagementCenterConfig

public Config setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)

getServicesConfig

public ServicesConfig getServicesConfig()

setServicesConfig

public Config setServicesConfig(ServicesConfig servicesConfig)

getSecurityConfig

public SecurityConfig getSecurityConfig()

setSecurityConfig

public Config setSecurityConfig(SecurityConfig securityConfig)

addListenerConfig

public Config addListenerConfig(ListenerConfig listenerConfig)

getListenerConfigs

public List<ListenerConfig> getListenerConfigs()

setListenerConfigs

public Config setListenerConfigs(List<ListenerConfig> listenerConfigs)

getSerializationConfig

public SerializationConfig getSerializationConfig()

setSerializationConfig

public Config setSerializationConfig(SerializationConfig serializationConfig)

getPartitionGroupConfig

public PartitionGroupConfig getPartitionGroupConfig()

setPartitionGroupConfig

public Config setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)

getHotRestartPersistenceConfig
```
public HotRestartPersistenceConfig getHotRestartPersistenceConfig()
```
Returns hot restart configuration for this member

Returns:
hot restart configuration

setHotRestartPersistenceConfig
```
public Config setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
```
Sets hot restart configuration.

Parameters:
hrConfig - hot restart configuration

Returns:
Config

getManagedContext

public ManagedContext getManagedContext()

setManagedContext

public Config setManagedContext(ManagedContext managedContext)

getUserContext

public ConcurrentMap<String,Object> getUserContext()

setUserContext

public Config setUserContext(ConcurrentMap<String,Object> userContext)

getNativeMemoryConfig

public NativeMemoryConfig getNativeMemoryConfig()

setNativeMemoryConfig

public Config setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)

getConfigurationUrl
```
public URL getConfigurationUrl()
```
Returns:
the configurationUrl

setConfigurationUrl
```
public Config setConfigurationUrl(URL configurationUrl)
```
Parameters:
configurationUrl - the configurationUrl to set

getConfigurationFile
```
public File getConfigurationFile()
```
Returns:
the configurationFile

setConfigurationFile
```
public Config setConfigurationFile(File configurationFile)
```
Parameters:
configurationFile - the configurationFile to set

getLicenseKey
```
public String getLicenseKey()
```

setLicenseKey

public Config setLicenseKey(String licenseKey)

isLiteMember
```
public boolean isLiteMember()
```
Returns:
indicates if the node is a lite member or not. Lite members do not own any partition.

setLiteMember
```
public Config setLiteMember(boolean liteMember)
```
Parameters:
liteMember - sets if the node will be a lite member or not. Lite members do not own any partition.

isCompatible
```
public boolean isCompatible(Config config)
```
Parameters:
config -

Returns:
true if config is compatible with this one, false if config belongs to another group

Throws:

RuntimeException - if map, queue, topic configs are incompatible

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Config

Method Detail

getClassLoader

setClassLoader

getConfigPatternMatcher

setConfigPatternMatcher

getProperty

setProperty

getProperty

setProperty

getMemberAttributeConfig

setMemberAttributeConfig

getProperties

setProperties

getInstanceName

setInstanceName

getGroupConfig

setGroupConfig

getNetworkConfig

setNetworkConfig

findMapConfig

getMapConfig

addMapConfig

getMapConfigs

setMapConfigs

findCacheConfig

getCacheConfig

addCacheConfig

getCacheConfigs

setCacheConfigs

findQueueConfig

getQueueConfig

addQueueConfig

getQueueConfigs

setQueueConfigs

findListConfig

getListConfig

addListConfig

getListConfigs

setListConfigs

findSetConfig

getSetConfig

addSetConfig

getSetConfigs

setSetConfigs

findMultiMapConfig

getMultiMapConfig

addMultiMapConfig

getMultiMapConfigs

setMultiMapConfigs

findReplicatedMapConfig

getReplicatedMapConfig

addReplicatedMapConfig

getReplicatedMapConfigs

setReplicatedMapConfigs

findRingbufferConfig

getRingbufferConfig

addRingBufferConfig

getRingbufferConfigs

findTopicConfig

getTopicConfig

addTopicConfig

findReliableTopicConfig

getReliableTopicConfig

getReliableTopicConfigs

addReliableTopicConfig

getTopicConfigs

setTopicConfigs

findExecutorConfig

getExecutorConfig

addExecutorConfig

getExecutorConfigs

setExecutorConfigs

findSemaphoreConfig