Reference Manual 3.9-SNAPSHOT
  •  Preface
    • Hazelcast IMDG Editions
    • Hazelcast IMDG Architecture
    • Hazelcast IMDG Plugins
    • Licensing and Trademarks
    • Customer Support
    • Release Notes
    • Contributing to Hazelcast
    • Partners
    • Phone Home
    • Typographical Conventions
  • Document Revision History
  •  Getting Started
    • Installation
    • Upgrading From 2x
    • Upgrading From 3x
    • Starting the Member and Client
    • Using The Scripts In The Package
    • Deployment Options
  •  Hazelcast Overview
    • Sharding In Hazelcast
    • Hazelcast Topology
    • Why Hazelcast
    • Data Partitioning
    • Use Cases
    • Resources
  •  Understanding Configuration
    • Configuring Declaratively
    • Configuring Programmatically
    • Configuring with System Properties
    • Configuring within Spring Context
    • Dynamically Adding Configuration on a Cluster
    • Checking Configuration
    • Configuration Pattern Matcher
    • Using Wildcards
    • Using Variables
  •  Setting Up Clusters
    • Discovery Mechanisms
    • Discovering Members by TCP
    • Discovering Members by Multicast
    • Discovering Native Clients
    • Creating Cluster Groups
    • User Code Deployment - BETA
    • Client User Code Deployment - BETA
    • Partition Group Configuration
    • Logging Configuration
    • Other Network Configurations
    • Failure Detector Configuration
  • Rolling Member Upgrades
  •  Distributed Data Structures
    •  Map
      • Getting Map and Putting Entries
      • Backing Up Maps
      • Map Eviction
      • Setting In Memory Format
      • Using High-Density Memory Store with Map
      • Loading and Storing Persistent Data
      • Creating Near Cache for Map
      • Locking Maps
      • Accessing Entry Statistics
      • Listening to Map entries with Predicates
      • Removing Bulk Map Entries with Predicates
      • Adding Interceptors
      • Preventing Out of Memory Exceptions
    •  Queue
      • Getting a Queue and Putting Items
      • Creating an Example Queue
      • Setting a Bounded Queue
      • Queue with Persistence Datastore
      • Split-Brain Protection for Queue
      • Configuring Queue
    • MultiMap
    • Set
    • List
    •  Ringbuffer
      • Getting a Ringbuffer and Reading Items
      • Configuring Ringbuffer
      • Ringbuffer with Persistent Datastore
      • Batched Items
      • Using Async Methods
    •  Topic
      • Getting a Topic and Publishing Messages
      • Getting Topic Statistics
      • Understanding Topic Behavior
      • Configuring Topic
    • Reliable Topic
    • Lock
    • IAtomicLong
    • ISemaphore
    • IAtomicReference
    • ICountDownLatch
    • IdGenerator
    • Replicated Map
    • Cardinality Estimator Service
    • Event Journal
  •  Distributed Events
    •  Cluster Events
      • Listening for Member Events
      • Listening for Distributed Object Events
      • Listening for Migration Events
      • Listening for Partition Lost Events
      • Listening for Lifecycle Events
      • Listening for Clients
    •  Distributed Object Events
      • Listening for Map Events
      • Listening for MultiMap Events
      • Listening for Item Events
      • Listening for Topic Messages
    • Event Listeners for Clients
    • Global Event Configuration
  •  Distributed Computing
    •  Executor Service
      • Implementing a Callable Task
      • Implementing a Runnable Task
      • Scaling the Executor Service
      • Executing-Code in the Cluster
      • Canceling an Executing Task
      • Callback When Task Completes
      • Selecting Members for Task Execution
      • Configuring Executor Service
    • Durable Executor Service
    • Scheduled Executor Service
    •  Entry Processor
      • Performing Fast In-Memory Map Operations
      • Entry Processor Interface
      • Processing Backup Entries
      • Creating a Sample Entry Processor
      • Abstract Entry Processor
      • Entry Processor Optimizations
  •  Distributed Query
    •  How Distributed Query Works
      • Employee Map Query Example
      • Querying with Criteria API
      • Querying with SQL
      • Filtering with Paging Predicates
      • Indexing Queries
      • Configuring Query Thread Pool
    •  Querying in Collections and Arrays
      • Indexing in Collections and Arrays
      • Corner Cases
    •  Custom Attributes
      • Implementing a ValueExtractor
      • Extraction Arguments
      • Configuring a Custom Attribute Programmatically
      • Configuring a Custom Attribute Declaratively
      • Indexing Custom Attributes
    •  MapReduce
      • Understanding MapReduce
      • Using the MapReduce API
      • Hazelcast MapReduce Architecture
      • MapReduce Deprecation
    •  Aggregators
      • Aggregations Basics
      • Using the Aggregations API
      • Aggregations Examples
      • Implementing Aggregations
    •  Fast Aggregations
      • Aggregator API
      • Sample Implementation
      • Built-In Aggregations
      • Configuration Options
    •  Projections
      • Projections API
      • Sample Implementation
      • Built-In Projections
    • Continuous Query Cache
  •  Transactions
    • Creating a Transaction Interface
    • Providing XA Transactions
    • Integrating into Java EE
  •  Hazelcast JCache
    • Overview
    •  Setup and Configuration
      • Setting your Application
      • Example JCache Application
      • Configuring for JCache
    •  JCache Providers
      • Configuring JCache Providers
      • Configuring JCache with Client Provider
      • Configuring JCache with Server Provider
    •  JCache API
      • JCache API Application Example
      • JCache Base Classes
      • Implementing Factory and FactoryBuilder
      • Implementing CacheLoader
      • Implementing CacheWriter
      • Implementing Entry Processor
      • Implementing CacheEntryListener
      • Implementing ExpirePolicy
    • Integrating JCache with Hazelcast Instance
    •  Hazelcast JCache Extension-ICache
      • Scoping to Join Clusters
      • Namespacing
      • Retrieving an ICache Instance
      • Configuring ICache
      • ICache Async Methods
      • Defining a Custom Expiry Policy
      • JCache Eviction
      • JCache Near Cache
      • ICache Convenience Methods
      • Implementing BackupAwareEntryProcessor
      • ICache Partition Lost Listener
      • JCache Split-Brain
    • Testing for JCache Specification Compliance
  •  Integrated Clustering
    • Hibernate Second Level Cache
    • Replicating Web Sessions
    •  Integrating with Spring
      • Configuring Spring
      • Enabling SpringAware Objects
      • Adding Caching to Spring
      • Configuring Hibernate Second Level Cache
      • Configuring Hazelcast Transaction Manager
      • Best Practices
  •  Storage
    • High-Density Memory Store
    • Sizing Practices
    •  Hot Restart Persistence
      • Hot Restart Types
      • Restart Process
      • Force Start
      • Partial Start
      • Configuring Hot Restart
      • Moving-Copying Hot Restart Data
      • Design Details
      • Concurrent-Incremental-Generational GC
      • Performance Considerations
      • Hot Backup
    • Hazelcast Striim Hot Cache
  •  Hazelcast Clients
    •  Java Client
      • Overview
      • Getting Started
      •  Configuration
        • Overview
        • Client Network
        • Load Balancer
        • Listeners
        • Client Connection Strategy
        • Other Configurations
      • Using High-Density Memory Store with Java Client
    • C++ Client
    • .NET Client
    • REST Client
    • Memcache Client
    • Other Client and Language Implementations
  •  Serialization
    • Overview
    • Serialization Interface Types
    • Comparing Serialization Interfaces
    • Implementing Java Serializable and Externalizable
    • Implementing DataSerializable
    •  Implementing Portable Serialization
      • Example Code
      • Registering the Portable Factory
      • Versioning for Portable Serialization
      • Ordering Consistency for writePortable
      • Null Portable Serialization
      • DistributedObject Serialization
    •  Custom Serialization
      • Implementing StreamSerializer
      • Implementing ByteArraySerializer
    • Global Serializer
    • Implementing HazelcastInstanceAware
    • Serialization Configuration Wrap-Up
  •  Management
    •  Getting Member Statistics
      • Map Statistics
      • MultiMap Statistics
      • Queue Statistics
      • Topic Statistics
      • Executor Statistics
    • JMX API Per Member
    • Monitoring with JMX
    •  Cluster Utilities
      • Getting Member Events and Member Sets
      • Managing Cluster and Member States
      • Using the Script cluster.sh
      • Using REST API for Cluster Management
      • Enabling Lite Members
      • Defining Member Attributes
      • Safety Checking of Cluster Members
    • Diagnostics
    • Management Center
  •  Security
    • Enabling Security
    • Socket Interceptor
    • Security Interceptor
    • Encryption
    • TLS-SSL
    • Integrating OpenSSL
    • Credentials
    • Validating Secrets Using Strength Policy
    • ClusterLoginModule
    • Cluster Member Security
    • Native Client Security
  •  Performance
    • Data Affinity
    • Back Pressure
    •  Threading Model
      • I:O Threading
      • Event Threading
      • IExecutor Threading
      • Operation Threading
    • Slow Operation Detector
    •  Near Cache
      • Hazelcast Data Structures with Near Cache Support
      • Configuring Near Cache
      • Near Cache Configuration Examples
      • Near Cache Eviction
      • Near Cache Expiration
      • Near Cache Invalidation
      • Near Cache Consistency
      • Near Cache Preloader
  • Hazelcast Simulator
  •  WAN Replication
    • Defining WAN Replication
    • WANBatchReplication Implementation
    • Configuring WAN Replication for IMap and Cache
    • Batch Size
    • Batch Maximum Delay
    • Response Timeout
    • Queue Capacity
    • Queue Full Behavior
    • Event Filtering API
    • Acknoledgment Types
    • Synchronizing WAN Target Cluster
    • WAN Replication Failure Detection and Recovery
    • Additional Information
    • Hazelcast WAN Replication with Solace
  • OSGI
  •  Extending Hazelcast
    •  User Defined Services
      • Creating the Service Class
      • Enabling the Service Calls
      • Adding Properties to the Service
      • Starting the Service
      • Placing a Remote Call via Proxy
      • Creating Containers
      • Partition Migration
      • Creating Backups
    • OperationParker
    •  Discovery SPI
      • Discovery SPI Interfaces and Classes
      • Discovery Strategy
      • DiscoveryService-Framework Integration
    • Config Properties
  • Consistency and Replication Model
  •  Network Partitioning
    • Split-Brain Protection
    • Split-Brain Recovery
  •  System Properties
    • System Properties - Member
    • System Properties - Client
  • Common Exception Types
  • License Questions
  • FAQ
  • Glossary

GitHub Repo
Send Us a Fix
Go to hazelcast.org/documentation

Show Code Blocks Inline

Preface Customer Support

Support for Hazelcast is provided via GitHub, Mail Group and StackOverflow

For information on the commercial support for Hazelcast IMDG and Hazelcast IMDG Enterprise, please see hazelcast.com.

  • Previous
  • Next