| Package | Description | 
|---|---|
| com.hazelcast.config | 
 Provides classes for configuring HazelcastInstance. 
 | 
| com.hazelcast.core | 
 Provides core API interfaces/classes. 
 | 
| com.hazelcast.osgi | 
 This package contains the OSGI functionality contract points for Hazelcast. 
 | 
| com.hazelcast.security | 
 Provides interfaces/classes for Hazelcast security implementation. 
 | 
| com.hazelcast.spi.properties | 
 Contains the Hazelcast properties implementation. 
 | 
| com.hazelcast.spring.config | 
 Contains config factory classes. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ClasspathXmlConfig
A  
Config which is initialized by loading an XML configuration file from the classpath. | 
class  | 
ClasspathYamlConfig
A  
Config which is initialized by loading a YAML configuration file from the classpath. | 
class  | 
FileSystemXmlConfig
A  
Config which includes functionality for loading itself from a
 XML configuration file. | 
class  | 
FileSystemYamlConfig
A  
Config which includes functionality for loading itself from a
 YAML configuration file. | 
class  | 
InMemoryXmlConfig
Creates a  
Config loaded from an in-memory Hazelcast XML String. | 
class  | 
InMemoryYamlConfig
Creates a  
Config loaded from an in-memory Hazelcast YAML String. | 
class  | 
UrlXmlConfig
A  
Config which is loaded using some url pointing to a Hazelcast XML file. | 
class  | 
UrlYamlConfig
A  
Config which is loaded using some url pointing to a Hazelcast YAML file. | 
| Modifier and Type | Method and Description | 
|---|---|
Config | 
Config.addCacheConfig(CacheSimpleConfig cacheConfig)
Adds the cache configuration. 
 | 
Config | 
Config.addCardinalityEstimatorConfig(CardinalityEstimatorConfig cardinalityEstimatorConfig)
Adds the cardinality estimator configuration. 
 | 
Config | 
Config.addDataConnectionConfig(DataConnectionConfig dataConnectionConfig)
Adds a data connection configuration. 
 | 
Config | 
Config.addDeviceConfig(DeviceConfig deviceConfig)
Adds the device configuration. 
 | 
Config | 
Config.addDurableExecutorConfig(DurableExecutorConfig durableExecutorConfig)
Adds the durable executor configuration. 
 | 
Config | 
Config.addExecutorConfig(ExecutorConfig executorConfig)
Adds the executor configuration. 
 | 
Config | 
Config.addFlakeIdGeneratorConfig(FlakeIdGeneratorConfig config)
Adds a flake ID generator configuration. 
 | 
Config | 
Config.addListConfig(ListConfig listConfig)
Adds the list configuration. 
 | 
Config | 
Config.addListenerConfig(ListenerConfig listenerConfig)
Adds a configuration for an  
EventListener. | 
Config | 
Config.addMapConfig(MapConfig mapConfig)
Adds the map configuration. 
 | 
Config | 
Config.addMultiMapConfig(MultiMapConfig multiMapConfig)
Adds the multimap configuration. 
 | 
Config | 
Config.addPNCounterConfig(PNCounterConfig pnCounterConfig)
Adds the PN counter configuration. 
 | 
Config | 
Config.addQueueConfig(QueueConfig queueConfig)
Adds the queue configuration. 
 | 
Config | 
Config.addReliableTopicConfig(ReliableTopicConfig topicConfig)
Adds the reliable topic configuration. 
 | 
Config | 
Config.addReplicatedMapConfig(ReplicatedMapConfig replicatedMapConfig)
Adds the replicated map configuration. 
 | 
Config | 
Config.addRingBufferConfig(RingbufferConfig ringbufferConfig)
Adds the ringbuffer configuration. 
 | 
Config | 
Config.addScheduledExecutorConfig(ScheduledExecutorConfig scheduledExecutorConfig)
Adds the scheduled executor configuration. 
 | 
Config | 
Config.addSetConfig(SetConfig setConfig)
Adds the set configuration. 
 | 
Config | 
Config.addSplitBrainProtectionConfig(SplitBrainProtectionConfig splitBrainProtectionConfig)
Adds the split-brain protection configuration. 
 | 
Config | 
Config.addTopicConfig(TopicConfig topicConfig)
Adds the topic configuration. 
 | 
Config | 
Config.addWanReplicationConfig(WanReplicationConfig wanReplicationConfig)
Adds the WAN replication config under the name defined by
  
WanReplicationConfig.getName(). | 
Config | 
XmlConfigBuilder.build()  | 
Config | 
YamlConfigBuilder.build()  | 
Config | 
ConfigBuilder.build()
Builds Config object. 
 | 
static Config | 
Config.load()
Populates Hazelcast  
Config object from an external configuration file. | 
static Config | 
Config.loadDefault()
Same as  
load(), i.e., loads Config using the default lookup mechanism | 
static Config | 
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 | 
Config.loadFromClasspath(ClassLoader classLoader,
                 String resource)
Creates a Config which is loaded from a classpath resource. 
 | 
static Config | 
Config.loadFromClasspath(ClassLoader classLoader,
                 String resource,
                 Properties properties)
Creates a Config which is loaded from a classpath resource. 
 | 
static Config | 
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 | 
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 | 
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 | 
Config.loadFromStream(InputStream source,
              Properties properties)
Creates a Config from the provided stream (XML or YAML content). 
 | 
static Config | 
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 | 
Config.loadFromString(String source,
              Properties properties)
Creates a Config from the provided string (XML or YAML content). 
 | 
Config | 
Config.setAdvancedNetworkConfig(AdvancedNetworkConfig advancedNetworkConfig)  | 
Config | 
Config.setAuditlogConfig(AuditlogConfig auditlogConfig)  | 
Config | 
Config.setCacheConfigs(Map<String,CacheSimpleConfig> cacheConfigs)
Sets the map of cache configurations, mapped by config name. 
 | 
Config | 
Config.setCardinalityEstimatorConfigs(Map<String,CardinalityEstimatorConfig> cardinalityEstimatorConfigs)
Sets the map of cardinality estimator configurations, mapped by config name. 
 | 
Config | 
Config.setClassLoader(ClassLoader classLoader)
Sets the class-loader to be used during de-serialization
 and as context class-loader of Hazelcast internal threads. 
 | 
Config | 
Config.setClusterName(String clusterName)
Sets the cluster name uniquely identifying the hazelcast cluster. 
 | 
Config | 
Config.setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
Sets the pattern matcher which is used to match item names to
 configuration objects. 
 | 
Config | 
Config.setConfigurationFile(File configurationFile)
Sets the  
File from which this configuration has been retrieved
 and created. | 
Config | 
Config.setConfigurationUrl(URL configurationUrl)
Sets the  
URL from which this configuration has been retrieved
 and created. | 
Config | 
Config.setCPSubsystemConfig(CPSubsystemConfig cpSubsystemConfig)
Set CP subsystem configuration 
 | 
Config | 
Config.setCRDTReplicationConfig(CRDTReplicationConfig crdtReplicationConfig)
Sets the replication configuration for  
CRDT
 implementations. | 
Config | 
Config.setDataConnectionConfigs(Map<String,DataConnectionConfig> dataConnectionConfigs)
Sets the map of data connection configurations, mapped by config name. 
 | 
Config | 
Config.setDeviceConfigs(Map<String,DeviceConfig> deviceConfigs)
Sets the map of  
DeviceConfigs mapped by device name. | 
Config | 
Config.setDurableExecutorConfigs(Map<String,DurableExecutorConfig> durableExecutorConfigs)
Sets the map of durable executor configurations, mapped by config name. 
 | 
Config | 
Config.setDynamicConfigurationConfig(DynamicConfigurationConfig dynamicConfigurationConfig)
Sets the dynamic configuration config. 
 | 
Config | 
Config.setExecutorConfigs(Map<String,ExecutorConfig> executorConfigs)
Sets the map of executor configurations, mapped by config name. 
 | 
Config | 
Config.setFlakeIdGeneratorConfigs(Map<String,FlakeIdGeneratorConfig> map)
Sets the map of  
FlakeIdGenerator configurations,
 mapped by config name. | 
Config | 
Config.setHotRestartPersistenceConfig(HotRestartPersistenceConfig hrConfig)
Deprecated. 
 
since 5.0 use  
setPersistenceConfig(PersistenceConfig) | 
Config | 
Config.setInstanceName(String instanceName)
Sets the instance name uniquely identifying the hazelcast instance
 created by this configuration. 
 | 
Config | 
Config.setInstanceTrackingConfig(InstanceTrackingConfig instanceTrackingConfig)
Sets the configuration for tracking use of this Hazelcast instance. 
 | 
Config | 
Config.setIntegrityCheckerConfig(IntegrityCheckerConfig integrityCheckerConfig)
Sets the Integrity Checker config 
 | 
Config | 
Config.setJetConfig(JetConfig jetConfig)
Sets the Jet config 
 | 
Config | 
Config.setLicenseKey(String licenseKey)
Sets the license key for this hazelcast instance. 
 | 
Config | 
Config.setListConfigs(Map<String,ListConfig> listConfigs)
Sets the map of  
IList configurations,
 mapped by config name. | 
Config | 
Config.setListenerConfigs(List<ListenerConfig> listenerConfigs)
Sets the list of  
EventListener configurations. | 
Config | 
Config.setLiteMember(boolean liteMember)
Sets the flag to indicate if this member is a lite member. 
 | 
Config | 
Config.setManagedContext(ManagedContext managedContext)
Sets the external managed context. 
 | 
Config | 
Config.setManagementCenterConfig(ManagementCenterConfig managementCenterConfig)
Sets the management center configuration for this hazelcast instance. 
 | 
Config | 
Config.setMapConfigs(Map<String,MapConfig> mapConfigs)
Sets the map of  
IMap configurations,
 mapped by config name. | 
Config | 
Config.setMemberAttributeConfig(MemberAttributeConfig memberAttributeConfig)
Sets the member attribute configuration. 
 | 
Config | 
Config.setMetricsConfig(MetricsConfig metricsConfig)
Sets the metrics collection config. 
 | 
Config | 
Config.setMultiMapConfigs(Map<String,MultiMapConfig> multiMapConfigs)
Sets the map of  
MultiMap configurations,
 mapped by config name. | 
Config | 
Config.setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
Sets the native memory configuration for this hazelcast instance. 
 | 
Config | 
Config.setNetworkConfig(NetworkConfig networkConfig)
Sets the network configuration for this hazelcast instance. 
 | 
Config | 
Config.setPartitionGroupConfig(PartitionGroupConfig partitionGroupConfig)
Sets the partition group configuration for this hazelcast instance. 
 | 
Config | 
Config.setPersistenceConfig(PersistenceConfig persistenceConfig)
Sets the Persistence configuration. 
 | 
Config | 
Config.setPNCounterConfigs(Map<String,PNCounterConfig> pnCounterConfigs)
Sets the map of PN counter configurations, mapped by config name. 
 | 
Config | 
Config.setProperties(Properties properties)
Sets the properties for this config instance. 
 | 
Config | 
Config.setProperty(String name,
           String value)
Sets the value of a named property. 
 | 
Config | 
Config.setQueueConfigs(Map<String,QueueConfig> queueConfigs)
Sets the map of  
IQueue configurations,
 mapped by config name. | 
Config | 
Config.setReliableTopicConfigs(Map<String,ReliableTopicConfig> reliableTopicConfigs)
Sets the map of reliable topic configurations, mapped by config name. 
 | 
Config | 
Config.setReplicatedMapConfigs(Map<String,ReplicatedMapConfig> replicatedMapConfigs)
Sets the map of  
ReplicatedMap configurations,
 mapped by config name. | 
Config | 
Config.setRingbufferConfigs(Map<String,RingbufferConfig> ringbufferConfigs)
Sets the map of  
Ringbuffer configurations,
 mapped by config name. | 
Config | 
Config.setScheduledExecutorConfigs(Map<String,ScheduledExecutorConfig> scheduledExecutorConfigs)
Sets the map of scheduled executor configurations, mapped by config name. 
 | 
Config | 
Config.setSecurityConfig(SecurityConfig securityConfig)
Sets the security configuration for this hazelcast instance. 
 | 
Config | 
Config.setSerializationConfig(SerializationConfig serializationConfig)
Sets the serialization configuration for this hazelcast instance. 
 | 
Config | 
Config.setSetConfigs(Map<String,SetConfig> setConfigs)
Sets the map of  
ISet configurations,
 mapped by config name. | 
Config | 
Config.setSplitBrainProtectionConfigs(Map<String,SplitBrainProtectionConfig> splitBrainProtectionConfigs)
Sets the map of split-brain protection configurations, mapped by config
 name. 
 | 
Config | 
Config.setSqlConfig(SqlConfig sqlConfig)
Sets SQL config. 
 | 
Config | 
Config.setTopicConfigs(Map<String,TopicConfig> topicConfigs)
Sets the map of  
ITopic configurations,
 mapped by config name. | 
Config | 
Config.setTpcConfig(TpcConfig tpcConfig)
Sets the TpcConfig. 
 | 
Config | 
Config.setUserCodeDeploymentConfig(UserCodeDeploymentConfig userCodeDeploymentConfig)
Set User Code Deployment configuration 
 | 
Config | 
Config.setUserContext(ConcurrentMap<String,Object> userContext)
Sets the user supplied context. 
 | 
Config | 
Config.setWanReplicationConfigs(Map<String,WanReplicationConfig> wanReplicationConfigs)
Sets the map of WAN replication configurations, mapped by config name. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
String | 
ConfigXmlGenerator.generate(Config config)
Generates the XML string based on some Config. 
 | 
static NetworkConfig | 
ConfigAccessor.getActiveMemberNetworkConfig(Config config)  | 
static com.hazelcast.internal.config.ServicesConfig | 
ConfigAccessor.getServicesConfig(Config config)  | 
static boolean | 
ConfigAccessor.isInstanceTrackingEnabledSet(Config config)  | 
| Modifier and Type | Method and Description | 
|---|---|
Config | 
HazelcastInstance.getConfig()
Returns the configuration of this Hazelcast instance. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static HazelcastInstance | 
Hazelcast.getOrCreateHazelcastInstance(Config config)
Gets or creates the HazelcastInstance with a certain name. 
 | 
static HazelcastInstance | 
Hazelcast.newHazelcastInstance(Config config)
Creates a new HazelcastInstance (a new node in a cluster). 
 | 
| Modifier and Type | Method and Description | 
|---|---|
HazelcastOSGiInstance | 
HazelcastOSGiService.newHazelcastInstance(Config config)
Creates a new  
HazelcastOSGiInstance
 on the owner bundle with specified configuration. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
IPermissionPolicy.configure(Config config,
         Properties properties)
Configures  
IPermissionPolicy. | 
| Modifier and Type | Method and Description | 
|---|---|
protected Config | 
HazelcastProperties.getConfig()  | 
| Constructor and Description | 
|---|
HazelcastProperties(Config config)
Creates a container with configured Hazelcast properties. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Config | 
ConfigFactory.newConfig()  | 
Copyright © 2023 Hazelcast, Inc.. All rights reserved.