A newer version of Hazelcast is available.

View latest

Configuration Options

To configure Hazelcast applications, you can choose either static or dynamic configuration. Explore the options and decide which one is best for your application.

Before configuring Hazelcast, we recommend trying the defaults, which are set in the hazelcast-default.xml file of your Hazelcast package.

Static Configuration

Static configuration allows you to configure Hazelcast before runtime by providing either configuration files or using the API. Static configuration cannot be changed during runtime.

To use static configuration, you have the following options:

The following topics are also relevant to static configuration:

Hazelcast performs schema validation through the hazelcast-config-4.1.4.xsd file, which comes with Hazelcast libraries. If an error occurs in declarative or programmatic configuration, Hazelcast throws a meaningful exception.

Configuration Precedence

Hazelcast looks for static configuration options in the following order:

  1. Config object provided by programmatic configuration

  2. hazelcast.config system property

  3. hazelcast.xml declarative configuration file in the working directory

  4. hazelcast.xml declarative configuration file on the classpath

  5. hazelcast.yaml (or .yml) declarative configuration file in the working directory

  6. hazelcast.yaml declarative configuration file on the classpath

If Hazelcast does not find any of these configuration options, it loads the default configuration file (hazelcast-default.xml), which comes with your Hazelcast package.

Dynamic Configuration

Dynamic configuration allows you to temporarily change the configuration of some data structures.