# Package com.hazelcast.config

Provides classes for configuring HazelcastInstance.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  CacheConfiguration<K,V> | Mutable extension to `CompleteConfiguration`
  ConfigBuilder | Interface for all config builders.
  ConfigPatternMatcher | The ConfigPatternMatcher provides a strategy to match an item name to a configuration pattern.
  DomConfigProcessor | Interface used by XML and YAML configuration classes for traversing and filling config object graph.
  NamedConfig | Interface for hazelcast data structures with name

- Class Summary
  Class | Description
  --- | ---
  AbstractBasicConfig<T extends AbstractBasicConfig> | Provides a basic configuration for a split-brain aware data structure.
  AbstractCacheConfig<K,V> | Base class for `CacheConfig`
  AbstractConfigLocator | Abstract base class for config locators.
  AbstractDomConfigProcessor | Base class of the config processors working from W3C DOM objects
  AbstractXmlConfigBuilder | Contains logic for replacing system variables in the XML file and importing XML files from different locations.
  AbstractXmlConfigHelper | Contains Hazelcast XML Configuration helper methods and variables.
  AbstractYamlConfigBuilder | Contains logic for replacing system variables in the YAML file and importing YAML files from different locations.
  AdvancedNetworkConfig | Similar to `NetworkConfig` with the additional ability to define multiple endpoints, each with its own separate protocol/security and/or socket properties.
  AdvancedNetworkConfig.MemberNetworkingView | Member endpoint decorated as a `NetworkConfig` Facade used during bootstrap to hide if-logic between the two networking configuration approaches
  AliasedDiscoveryConfig<T extends AliasedDiscoveryConfig<T>> | Configuration for discovery strategy aliases, e.g.
  AliasedDiscoveryConfigUtils | Utility class for Aliased Discovery Configs.
  AtomicLongConfig | Contains the configuration for an `AtomicLong`.
  AtomicReferenceConfig | Contains the configuration for an `AtomicReference`.
  AwsConfig | The AWSConfig contains the configuration for AWS join mechanism.
  AzureConfig | Configuration for the Azure Discovery Strategy.
  CacheConfig<K,V> | Contains all the configuration for the `ICache`.
  CacheConfigAccessor | Accessor for CacheConfig fields
  CacheConfigReadOnly<K,V> | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  CacheEvictionConfig | Deprecated Use `EvictionConfig` instead of this
  CacheEvictionConfigReadOnly | Deprecated Use `EvictionConfigReadOnly` instead of this
  CachePartitionLostListenerConfig | Configuration for CachePartitionLostListener
  CachePartitionLostListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  CacheSimpleConfig | Simple configuration to hold parsed XML configuration.
  CacheSimpleConfig.ExpiryPolicyFactoryConfig | Represents configuration for "ExpiryPolicyFactory".
  CacheSimpleConfig.ExpiryPolicyFactoryConfig.DurationConfig | Represents duration configuration with duration amount and time unit for the "TimedExpiryPolicyFactoryConfig".
  CacheSimpleConfig.ExpiryPolicyFactoryConfig.TimedExpiryPolicyFactoryConfig | Represents configuration for time based "ExpiryPolicyFactory" with duration and time unit.
  CacheSimpleConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  CacheSimpleEntryListenerConfig | Simple configuration to hold parsed listener config.
  CacheSimpleEntryListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  CardinalityEstimatorConfig | Configuration options for the `CardinalityEstimator`
  ClassFilter | Holds blacklist and whitelist configuration in java deserialization configuration.
  ClasspathXmlConfig | A `Config` which is initialized by loading an XML configuration file from the classpath.
  ClasspathYamlConfig | A `Config` which is initialized by loading a YAML configuration file from the classpath.
  CollectionConfig<T extends CollectionConfig> | Provides configuration service for Collection.
  Config | Contains all the configuration to start a `HazelcastInstance`.
  ConfigAccessor | Private API for accessing configuration at runtime
  ConfigDataSerializerHook | DataSerializerHook for com.hazelcast.config classes
  ConfigLoader | Provides loading service for a configuration.
  ConfigXmlGenerator | The ConfigXmlGenerator is responsible for transforming a `Config` to a Hazelcast XML string.
  ConfigXmlGenerator.XmlGenerator | Utility class to build xml using a `StringBuilder`.
  CountDownLatchConfig | Contains the configuration for an `ICountDownLatch`.
  CRDTReplicationConfig | Configures the replication mechanism for all `CRDT` implementations.
  CredentialsFactoryConfig | Contains the configuration for Credentials Factory.
  DiscoveryConfig | This configuration class describes the top-level config of the discovery SPI and its discovery strategies.
  DiscoveryConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  DiscoveryStrategyConfig | This configuration class describes a `DiscoveryStrategy` based on a parsed XML or configured manually using the config API
  DomConfigHelper | Helper class for accessing and extracting values from W3C DOM `Node` instances
  DurableExecutorConfig | Contains the configuration for an `DurableExecutorService`.
  EndpointConfig | Endpoint configuration that defines communication/networking properties common to both incoming/outgoing connections eg.
  EntryListenerConfig | Configuration for EntryListener
  EntryListenerConfig.MapListenerToEntryListenerAdapter | Wraps a MapListener into an EntryListener.
  EntryListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  EurekaConfig | Configuration for the Eureka Discovery Strategy.
  EventJournalConfig | Configuration for an event journal.
  EvictionConfig | Configuration for eviction.
  EvictionConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  ExecutorConfig | Contains the configuration for an `IExecutorService`.
  ExecutorConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  FileSystemXmlConfig | A `Config` which includes functionality for loading itself from a XML configuration file.
  FileSystemYamlConfig | A `Config` which includes functionality for loading itself from a YAML configuration file.
  FlakeIdGeneratorConfig | The `FlakeIdGeneratorConfig` contains the configuration for the member regarding `Flake ID Generator`.
  FlakeIdGeneratorConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  GcpConfig | Configuration for the GCP Discovery Strategy.
  GlobalSerializerConfig | Contains the configuration for global serializer.
  GroupConfig | Contains the configuration for Hazelcast groups.
  HotRestartConfig | Configures the Hot Restart Persistence per Hazelcast data structure.
  HotRestartPersistenceConfig | Configures the Hot Restart stores.
  IcmpFailureDetectorConfig | This Failure Detector may be configured in addition to one of Deadline and Phi Accual Failure Detectors. It operates at Layer 3 of the OSI protocol, and provides much quicker and more deterministic detection of hardware and other lower level events.
  InMemoryXmlConfig | Creates a `Config` loaded from an in-memory Hazelcast XML String.
  InMemoryYamlConfig | Creates a `Config` loaded from an in-memory Hazelcast YAML String.
  InterfacesConfig | Contains the configuration for Interfaces.
  ItemListenerConfig | Contains the configuration for an Item Listener.
  ItemListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  JavaSerializationFilterConfig | Configuration for Serialization Filter.
  JobTrackerConfig | Contains the configuration for an `JobTracker`.
  JobTrackerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  JoinConfig | Contains the 3 different join configurations; TCP-IP/multicast/AWS.
  KubernetesConfig | Configuration for the Kubernetes Discovery Strategy.
  LegacyCacheConfig<K,V> | Contains all the configuration for the `ICache` (used for backward compatibility).
  LegacyCacheEvictionConfig | Configuration for cache eviction (used for backward compatibility).
  ListConfig | Contains the configuration for an `IList`.
  ListConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  ListenerConfig | Contains the configuration for an `EventListener`.
  ListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  LockConfig | Contains the configuration for the `ILock`.
  LoginModuleConfig | Configuration for Login Module
  ManagementCenterConfig | Contains the configuration for a Management Center.
  MapAttributeConfig | Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor.
  MapAttributeConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MapConfig | Contains the configuration for an `IMap`.
  MapConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MapIndexConfig | Contains the configuration for an index in a map.
  MapIndexConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MapPartitionLostListenerConfig | Configuration for MapPartitionLostListener
  MapPartitionLostListenerConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MapStoreConfig | Contains the configuration for a Map Store.
  MapStoreConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MaxSizeConfig | Configuration for map's capacity.
  MaxSizeConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MCMutualAuthConfig | Management Center mutual authentication configuration.
  MemberAddressProviderConfig | Configuration for a custom `MemberAddressProvider` strategy.
  MemberAttributeConfig | Contains configuration for attribute of member.
  MemberAttributeConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  MemberGroupConfig | Contains the configuration for a single member group.
  MemcacheProtocolConfig | This class allows to enable MEMCACHE text protocol support in Hazelcast.
  MergePolicyConfig | Configuration for `SplitBrainMergePolicy`.
  MerkleTreeConfig | Configuration for a merkle tree.
  MulticastConfig | Contains the configuration for the multicast discovery mechanism.
  MultiMapConfig | Configuration for MultiMap.
  MultiMapConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  NativeMemoryConfig | Configures native memory region.
  NearCacheConfig | Contains the configuration for a Near Cache.
  NearCacheConfigAccessor | Accessor for the `EvictionConfig` of a `NearCacheConfig` to initialize the old default max size, if no size was configured by the user.
  NearCacheConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  NearCachePreloaderConfig | Configuration for storing and pre-loading Near Cache keys.
  NetworkConfig | Contains configuration for Network.
  PartitionGroupConfig | With PartitionGroupConfig, you can control how primary and backup partitions are mapped to physical Members.
  PartitioningStrategyConfig | Contains the configuration for partitioning strategy.
  PartitioningStrategyConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  PermissionConfig | Contains the configuration for a permission.
  PermissionPolicyConfig | Contains the configuration for policy of permission
  PNCounterConfig | Configuration for a `PNCounter`
  PredicateConfig | Contains the configuration for an `Predicate`.
  ProbabilisticQuorumConfigBuilder | Builder for a `QuorumConfig` configured with `ProbabilisticQuorumFunction` that considers members present in the context of a quorum using a probabilistic, adaptive quorum function.
  QueryCacheConfig | Contains configuration for `QueryCache`.
  QueueConfig | Contains the configuration for an `IQueue`.
  QueueConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  QueueStoreConfig | Configuration for the `QueueStore`.
  QueueStoreConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  QuorumConfig | Configuration for cluster quorum, a means to protect consistency of data from network partitions.
  QuorumConfigBuilder | Commons for quorum config builders.
  QuorumListenerConfig | Confiquration class for `QuorumListener` IMPORTANT: The term "quorum" simply refers to the count of members in the cluster required for an operation to succeed.
  RecentlyActiveQuorumConfigBuilder | Builder for a `QuorumConfig` configured with `RecentlyActiveQuorumFunction` that considers members present in the context of a quorum if the last received heartbeat is within a recent window of time.
  ReliableTopicConfig | Configuration for a reliable `ITopic`.
  ReplicatedMapConfig | Contains the configuration for an `ReplicatedMap`
  RestApiConfig | This class allows to control which parts of Hazelcast REST API will be enabled.
  RestServerEndpointConfig | Server socket endpoint config specialized for REST service Allows configuring access to REST groups similar to `RestApiConfig`
  RingbufferConfig | Contains the configuration for the `Ringbuffer`.
  RingbufferStoreConfig | Configuration for the `RingbufferStore`.
  ScheduledExecutorConfig | Configuration options for the `IScheduledExecutorService`.
  SecurityConfig | Contains configuration for Security
  SecurityInterceptorConfig | This class is used to configure `SecurityInterceptor`
  SemaphoreConfig | Contains the configuration for an `ISemaphore`.
  SemaphoreConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  SerializationConfig | Contains the serialization configuration of `HazelcastInstance`.
  SerializerConfig | Contains the serialization configuration for a particular class.
  ServerSocketEndpointConfig | Endpoint configuration that defines a listening side (server)
  ServiceConfig | Configuration for a single service.
  ServicesConfig | Configuration for the Services.
  SetConfig | Contains the configuration for an `ISet`.
  SetConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  SocketInterceptorConfig | Contains the configuration for interceptor socket.
  SSLConfig | SSL configuration.
  SymmetricEncryptionConfig | Contains configuration for symmetric encryption
  TcpIpConfig | Contains the configuration for the Tcp/Ip join mechanism.
  TopicConfig | Contains the configuration for a `ITopic`.
  TopicConfigReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  UrlXmlConfig | A `Config` which is loaded using some url pointing to a Hazelcast XML file.
  UrlYamlConfig | A `Config` which is loaded using some url pointing to a Hazelcast YAML file.
  UserCodeDeploymentConfig | Configuration of User Code Deployment.
  WanConsumerConfig | Config for processing WAN events received from a target cluster.
  WanPublisherConfig | Configuration object for a WAN publisher.
  WanReplicationConfig | Configuration for WAN replication.
  WanReplicationRef | Configuration for a WAN target replication reference.
  WanReplicationRefReadOnly | Deprecated this class will be removed in 4.0; it is meant for internal usage only.
  WanSyncConfig | Configuration object for the WAN sync mechanism.
  XmlConfigBuilder | A XML `ConfigBuilder` implementation.
  XmlConfigLocator | Support class for the `XmlConfigBuilder` that locates the XML configuration: system property working directory classpath default
  YamlConfigBuilder | A YAML `ConfigBuilder` implementation.
  YamlConfigLocator | Support class for the `YamlConfigBuilder` that locates the YAML configuration: system property working directory classpath default

- Enum Summary
  Enum | Description
  --- | ---
  AbstractXmlConfigBuilder.ConfigType |
  CacheDeserializedValues | Control caching of de-serialized values.
  CacheEvictionConfig.CacheMaxSizePolicy | Cache Maximum Size Policy
  CacheSimpleConfig.ExpiryPolicyFactoryConfig.TimedExpiryPolicyFactoryConfig.ExpiryPolicyType | Represents type of the "TimedExpiryPolicyFactoryConfig".
  ConsistencyCheckStrategy | Strategy for checking the consistency of data between replicas.
  EvictionConfig.MaxSizePolicy | Maximum Size Policy
  EvictionPolicy | Eviction Policy enum.
  HotRestartClusterDataRecoveryPolicy | Specifies the policy that will be respected during hot restart cluster start
  InMemoryFormat | Storage format type of values stored in cluster
  LoginModuleConfig.LoginModuleUsage | Usage of Login Module
  MapStoreConfig.InitialLoadMode | Initial load module
  MaxSizeConfig.MaxSizePolicy | Maximum Size Policy
  MetadataPolicy | Hazelcast may process objects of supported types ahead of time to create additional metadata about them.
  MultiMapConfig.ValueCollectionType | Type of value collection
  NativeMemoryConfig.MemoryAllocatorType | Type of memory allocator: STANDARD: allocate/free memory using default OS memory manager POOLED: manage memory blocks in pool
  NearCacheConfig.LocalUpdatePolicy | Defines how to reflect local updates to the Near Cache.
  OnJoinPermissionOperationName | Enum of operation names for handling client permissions when the member is joining into the cluster.
  PartitionGroupConfig.MemberGroupType | Type of member groups.
  PermissionConfig.PermissionType | Type of permission
  RestEndpointGroup | Enum of REST endpoint groups.
  UserCodeDeploymentConfig.ClassCacheMode | Controls caching of caches loaded from remote members
  UserCodeDeploymentConfig.ProviderMode | Controls how to react on receiving a classloading request from a remote member
  WanAcknowledgeType | Determines acknowledge waiting type of wan replication operation invocation.
  WanPublisherState | Defines the state in which a WAN publisher can be in if it is not shutting down.
  WANQueueFullBehavior | Determines the behavior of WAN replication impl.

- Exception Summary
  Exception | Description
  --- | ---
  ConfigurationException | A `HazelcastException` that is thrown when something is wrong with the server or client configuration.
  InvalidConfigurationException | A InvalidConfigurationException is thrown when there is an Invalid Configuration.

## Package com.hazelcast.config Description

Provides classes for configuring HazelcastInstance.

Copyright © 2019. All rights reserved.