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.
ConfigRecognizer	Interface for recognizing a declarative Hazelcast configuration based on the rules defined in the actual implementation.
DeviceConfig	Device configuration for the Tiered-Store
NamedConfig	Interface for hazelcast data structures with name
TrustedInterfacesConfigurable<T extends TrustedInterfacesConfigurable<?>>	Interface defining methods used to configure trusted interfaces (source IP addresses).

Class Summary

Class	Description
AbstractCacheConfig<K,V>	Base class for CacheConfig
AbstractConfigBuilder
AbstractFactoryWithPropertiesConfig<T extends AbstractFactoryWithPropertiesConfig<T>>	Configuration base for config types with a factory class and its properties.
AbstractSymmetricEncryptionConfig<T extends AbstractSymmetricEncryptionConfig>	Base class for symmetric encryption configuration classes.
AbstractWanPublisherConfig	Base class for WAN publisher configuration.
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.
AttributeConfig	Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor.
AuditlogConfig	Auditlog configuration.
AutoDetectionConfig	Configuration for the Discovery Strategy Auto Detection.
AwsConfig	The AWSConfig contains the configuration for AWS join mechanism.
AzureConfig	Configuration for the Azure Discovery Strategy.
BaseMetricsConfig<T extends BaseMetricsConfig>	Base class of configuration options specific to metrics collection.
BitmapIndexOptions	Configures indexing options specific to bitmap indexes.
BTreeIndexConfig	Configuration options specific for B-Tree indexes.
CacheConfig<K,V>	Contains all the configuration for the ICache.
CacheConfigAccessor	Accessor for package-private methods of CacheConfig.
CachePartitionLostListenerConfig	Configuration for CachePartitionLostListener
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.
CacheSimpleEntryListenerConfig	Simple configuration to hold parsed listener config.
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.
CompactSerializationConfig	In 5.0, this feature is disabled by default and has to be enabled via configuration
CompactSerializationConfigAccessor	An accessor for the package-private fields of the CompactSerializationConfig.
Config	Contains all the configuration to start a HazelcastInstance.
ConfigAccessor	Private API for accessing configuration at runtime
ConfigStream	Stream wrapping or copying a generic InputStream for the ConfigRecognizer API.
ConfigXmlGenerator	The ConfigXmlGenerator is responsible for transforming a Config to a Hazelcast XML string.
ConfigXmlGenerator.XmlGenerator	Utility class to build xml using a StringBuilder.
CRDTReplicationConfig	Configures the replication mechanism for all CRDT implementations.
CredentialsFactoryConfig	Contains the configuration for Credentials Factory.
DataPersistenceConfig	Configures the Persistence per Hazelcast data structure.
DiscoveryConfig	This configuration class describes the top-level config of the discovery SPI and its discovery strategies.
DiscoveryStrategyConfig	This configuration class describes a DiscoveryStrategy based on a parsed XML or configured manually using the config API
DiskTierConfig	Disk tier configuration of Tiered-Store.
DurableExecutorConfig	Contains the configuration for an DurableExecutorService.
DynamicConfigurationConfig	Dynamic Configuration related configuration options.
EncryptionAtRestConfig	Contains configuration for the Hot Restart Persistence at Rest encryption
EndpointConfig	Endpoint configuration that defines communication/networking properties common to both incoming/outgoing connections eg.
EntryListenerConfig	Configuration for EntryListener
EurekaConfig	Configuration for the Eureka Discovery Strategy.
EventJournalConfig	Configuration for an event journal.
EvictionConfig	Configuration for eviction.
ExecutorConfig	Contains the configuration for an IExecutorService.
ExternalDataStoreConfig	Contains configuration of an external data store that can be used as a BatchSource and Sink in Jet JDBC connector. Datastore for MapStore and MapLoader
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.
GcpConfig	Configuration for the GCP Discovery Strategy.
GlobalSerializerConfig	Contains the configuration for global serializer.
HotRestartConfig	Deprecated since 5.0 use DataPersistenceConfig
HotRestartPersistenceConfig	Deprecated since 5.0 use PersistenceConfig
IcmpFailureDetectorConfig	This Failure Detector may be configured in addition to one of Deadline and Phi Accrual 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.
IndexConfig	Configuration of an index.
InMemoryXmlConfig	Creates a Config loaded from an in-memory Hazelcast XML String.
InMemoryYamlConfig	Creates a Config loaded from an in-memory Hazelcast YAML String.
InstanceTrackingConfig	Configures tracking of a running Hazelcast instance.
IntegrityCheckerConfig	Configures Module Integrity Checker.
InterfacesConfig	Contains the configuration for Interfaces.
ItemListenerConfig	Contains the configuration for an Item Listener.
JavaKeyStoreSecureStoreConfig	Java KeyStore Secure Store configuration.
JavaSerializationFilterConfig	Configuration for Serialization Filter.
JoinConfig	Contains the multiple different join configuration.
KubernetesConfig	Configuration for the Kubernetes Discovery Strategy.
ListConfig	Contains the configuration for an IList.
ListenerConfig	Contains the configuration for an EventListener.
LocalDeviceConfig	Local Device configuration for the Tiered-Store.
LoginModuleConfig	Configuration for Login Module
ManagementCenterConfig	Contains the configuration for Hazelcast Management Center.
MapConfig	Contains the configuration for an IMap.
MapPartitionLostListenerConfig	Configuration for MapPartitionLostListener
MapStoreConfig	Contains the configuration for a Map Store.
MemberAddressProviderConfig	Configuration for a custom MemberAddressProvider strategy.
MemberAttributeConfig	Contains configuration for attribute of member.
MemberConfigRecognizer	ConfigRecognizer implementation that recognizes Hazelcast member declarative configurations based on an extensible set of built-in ConfigRecognizer implementations.
MemberGroupConfig	Contains the configuration for a single member group.
MemcacheProtocolConfig	This class allows to enable MEMCACHE text protocol support in Hazelcast.
MemoryTierConfig	Memory tier configuration of Tiered-Store.
MergePolicyConfig	Configuration for SplitBrainMergePolicy.
MerkleTreeConfig	Configuration for a merkle tree.
MetricsConfig	Member-side metrics collection configuration.
MetricsJmxConfig	JMX related metrics configuration.
MetricsManagementCenterConfig	Management Center related metrics configuration.
MulticastConfig	Contains the configuration for the multicast discovery mechanism.
MultiMapConfig	Configuration for MultiMap.
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.
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.
PermissionConfig	Contains the configuration for a permission.
PermissionPolicyConfig	Contains the configuration for policy of permission
PersistenceConfig	Configures the Persistence stores.
PersistentMemoryConfig	Configuration class for persistent memory devices (e.g.
PersistentMemoryDirectoryConfig	Configuration class for directories that persistent memories are mounted at.
PNCounterConfig	Configuration for a PNCounter
PredicateConfig	Contains the configuration for an Predicate.
ProbabilisticSplitBrainProtectionConfigBuilder	Builder for a SplitBrainProtectionConfig configured with ProbabilisticSplitBrainProtectionFunction that considers members present in the context of a split brain protection using a probabilistic, adaptive split brain protection function.
QueryCacheConfig	Contains configuration for QueryCache.
QueueConfig	Contains the configuration for an IQueue.
QueueStoreConfig	Configuration for the QueueStore.
RecentlyActiveSplitBrainProtectionConfigBuilder	Builder for a SplitBrainProtectionConfig configured with RecentlyActiveSplitBrainProtectionFunction that considers members present in the context of a split brain protection 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 controlling 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.
SecureStoreConfig	Abstract Secure Store configuration class.
SecurityConfig	Contains configuration for Security
SecurityInterceptorConfig	This class is used to configure SecurityInterceptor
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.
SetConfig	Contains the configuration for an ISet.
SocketInterceptorConfig	Contains the configuration for interceptor socket.
SplitBrainProtectionConfig	Configuration for cluster split brain protection, a means to protect consistency of data from network partitions.
SplitBrainProtectionConfigBuilder	Commons for split brain protection config builders.
SplitBrainProtectionListenerConfig	Configuration class for SplitBrainProtectionListener
SqlConfig	SQL service configuration.
SSLConfig	SSL configuration.
SymmetricEncryptionConfig	Deprecated since 4.2
TcpIpConfig	Contains the configuration for the Tcp/Ip join mechanism.
TieredStoreConfig	Tiered-Store configuration.
TopicConfig	Contains the configuration for a ITopic.
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.
VaultSecureStoreConfig	HashiCorp Vault Secure Store configuration.
WanBatchPublisherConfig	Configuration object for the built-in WAN publisher (available in Hazelcast Enterprise).
WanConsumerConfig	Config for processing WAN events received from a target cluster.
WanCustomPublisherConfig	Configuration object for a custom WAN publisher.
WanReplicationConfig	Configuration for WAN replication.
WanReplicationRef	Configuration for a WAN target replication reference.
WanSyncConfig	Configuration object for the WAN sync mechanism.
XmlConfigBuilder	A XML ConfigBuilder implementation.
YamlConfigBuilder	A YAML ConfigBuilder implementation.

Enum Summary

Enum	Description
AbstractXmlConfigBuilder.ConfigType
BitmapIndexOptions.UniqueKeyTransformation	Defines an assortment of transformations which can be applied to unique key values.
CacheDeserializedValues	Control caching of de-serialized values.
CacheSimpleConfig.ExpiryPolicyFactoryConfig.TimedExpiryPolicyFactoryConfig.ExpiryPolicyType	Represents type of the "TimedExpiryPolicyFactoryConfig".
ConsistencyCheckStrategy	Strategy for checking the consistency of data between replicas.
EvictionPolicy	Eviction Policy enum.
HotRestartClusterDataRecoveryPolicy	Deprecated since 5.0 use PersistenceClusterDataRecoveryPolicy
IndexType	Type of the index.
InMemoryFormat	Storage format type of values stored in cluster
InstanceTrackingConfig.InstanceMode	The mode in which this instance is running.
InstanceTrackingConfig.InstanceProductName	Product name for the Hazelcast instance
InstanceTrackingConfig.InstanceTrackingProperties	Enumeration of instance properties provided to the format pattern for output.
LoginModuleConfig.LoginModuleUsage	Usage of Login Module
MapStoreConfig.InitialLoadMode	Initial load module
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
PersistenceClusterDataRecoveryPolicy	Specifies the policy that will be respected during persistence cluster start
PersistentMemoryMode	The enumeration of the supported persistent memory operational modes.
RestEndpointGroup	Enum of REST endpoint groups.
ScheduledExecutorConfig.CapacityPolicy	Capacity policy options
UserCodeDeploymentConfig.ClassCacheMode	Controls caching of classes loaded from remote members
UserCodeDeploymentConfig.ProviderMode	Controls how to react to receiving a classloading request from a remote member
WanAcknowledgeType	Determines acknowledge waiting type of wan replication operation invocation.
WanQueueFullBehavior	Determines the behavior of WAN replication impl.

Exception Summary

Exception	Description
InvalidConfigurationException	A InvalidConfigurationException is thrown when an Hazelcast faces an invalid configuration.

Package com.hazelcast.config Description

Provides classes for configuring HazelcastInstance.