.hazelcast-all.3.5.source-code.hazelcast-config-3.5.xsd Maven / Gradle / Ivy
Data type used to store entries.
Possible values:
BINARY (default): keys and values are stored as binary data.
OBJECT: values are stored in their object forms.
NATIVE: keys and values are stored in native memory.
True (default) if statistics gathering is enabled on the map, false otherwise.
If true, increases the speed of query processes in the map. It only works when in-memory-format
is set as BINARY and performs a pre-caching on the entries queried. Default value is false.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the map will be copied to one other JVM for
fail-safety. Valid numbers are 0 (no backup), 1, 2 ... 6.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the map will be copied to one other JVM for
fail-safety. Valid numbers are 0 (no backup), 1, 2 ... 6.
Maximum number of seconds for each entry to stay in the map. Entries that are
older than <time-to-live-seconds> and are not updated for <time-to-live-seconds>
are automatically evicted from the map.
Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.
Maximum number of seconds for each entry to stay idle in the map. Entries that are
idle(not touched) for more than <max-idle-seconds> are
automatically evicted from the map. The entry is touched if get, put or containsKey is called.
Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.
Valid values are:
NONE (no eviction).
LRU (Least Recently Used).
LFU (Least Frequently Used).
NONE is the default.
Maximum size of the map.
Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
When the map reaches maximum size, this specified percentage of the map will be evicted. Set to any integer between
0 and 100.
For example, if 25 is set, 25% of the entries are evicted.
Minimum time in milliseconds which should pass before checking
if a partition of this map is evictable or not.
Default value is 100 millis.
While recovering from split-brain (network partitioning), map entries in the small cluster
merge into the bigger cluster
based on the policy set here. When an entry merges into the cluster, an
entry with the same key might already exist in the cluster.
The values of these entries might be different for that same key. Which value should be set for the
key?
The conflict is resolved by the policy set here.
There are built-in merge policies, such as:
com.hazelcast.map.merge.PassThroughMergePolicy: the entry will be added if there is no
existing entry for the key.
com.hazelcast.map.merge.PutIfAbsentMapMergePolicy: the entry will be added if the merging
entry doesn't exist in the cluster.
com.hazelcast.map.merge.HigherHitsMapMergePolicy: the entry with the higher number of hits wins.
com.hazelcast.map.merge.LatestUpdateMapMergePolicy: the entry with the latest update wins.
Default policy is 'com.hazelcast.map.merge.PutIfAbsentMapMergePolicy'
True if reading local backup entries is enabled, false otherwise.
Name of the map.
If true, previously assigned values for the affected keys will be sent to this
cache-entry-listener implementation. Setting this attribute to true
creates additional traffic. Default value is false.
If true, this cache-entry-listener implementation will be called
in a synchronous manner. Default value is false.
The type of the queue entry keys, provided as the full class name.
The type of the queue entry values, provided as the full class name.
True if statistics gathering is enabled on the cache, false (default) otherwise.
True if management is enabled on the cache, false (default) otherwise.
True if read-through caching is used, false (default) otherwise.
True if write-through caching is used, false (default) otherwise.
The cache loader factory class name.
The cache writer factory class name.
Defines the expiry policy factory class name or
defines the expiry policy factory from predefined ones with duration configuration.
List of cache entry listeners.
Data type used to store entries.
Possible values:
BINARY (default): keys and values are stored as binary data.
OBJECT: values are stored in their object forms.
NATIVE: keys and values are stored in native memory.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the map are copied to one other JVM for
fail-safety. Valid numbers are 0 (no backup), 1, 2 ... 6.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the map are copied to one other JVM for
fail-safety. Valid numbers are 0 (no backup), 1, 2 ... 6.
When maximum size is reached, cache is evicted based on the eviction policy.
size:
maximum size can be any integer between 0 and Integer.MAX_VALUE.
Default value is 0.
max-size-policy:
max-size-policy has these valid values:
ENTRY_COUNT (Maximum number of cache entries in the cache),
USED_NATIVE_MEMORY_SIZE (Maximum used native memory size in megabytes for each JVM),
USED_NATIVE_MEMORY_PERCENTAGE (Maximum used native memory size percentage for each JVM),
FREE_NATIVE_MEMORY_SIZE (Maximum free native memory size in megabytes for each JVM),
FREE_NATIVE_MEMORY_PERCENTAGE (Maximum free native memory size percentage for each JVM).
Default value is "ENTRY_COUNT".
eviction-policy:
Eviction policy has these valid values:
LRU (Least Recently Used),
LFU (Least Frequently Used).
Default value is "LRU".
Wan replication configuration for cache.
Name of the cache.
True (default) if statistics gathering is enabled on the queue, false otherwise.
Maximum size of the queue.
Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the queue are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the queue are copied to one other JVM for
fail-safety.
True (default) if statistics gathering is enabled on the list, false otherwise.
Maximum size of the list.
Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the list are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the list will be copied to one other JVM for
fail-safety.
True (default) if statistics gathering is enabled on the set, false otherwise.
Maximum size of the set.
Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the set are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the set will be copied to one other JVM for
fail-safety.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all entries of the multimap are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all entries of the multimap are copied to one other JVM for
fail-safety.
True (default) if statistics gathering is enabled on the multimap, false otherwise.
A replicated map is a fully vector clock based, eventually consistent implementation of the map
interface. This implementation is different from all other Hazecst data structures in that it is not
partitioned, but it fully replicates all data to all members.
Due to the nature of eventually consistency there is a chance of reading stale data and there is no
guarantee to retrieve the same value on multiple get calls.
ReplicatedMap was added in Hazelcast 3.2.
Data type used to store entries.
Possible values:
BINARY: keys and values are stored as binary data.
OBJECT (default): values are stored in their object forms.
NATIVE: keys and values are stored in native memory.
Number of parallel mutexes to minimize contention on keys. The default value is 32 which
is a good number for lots of applications. If higher contention is seen on writes to values
inside of the replicated map this value can be adjusted to the needs.
Defines the number of milliseconds after a put is executed before the value is replicated
to other nodes. During this time, multiple puts can be operated and cached up to be sent
out all at once after the delay. This highers the latency for eventually consistency but lowers IO operations.
Default value is 100ms before a replication is operated. If set to 0, no delay is used and
all values are replicated one by one.
True if the replicated map is available for reads before the initial
replication is completed, false otherwise. Default is true. If false, no Exception will be
thrown when the replicated map is not yet ready, but call is blocked until
the initial replication is completed.
True (default) if statistics gathering is enabled on the replicated map, false otherwise.
True (default) if statistics gathering is enabled on the topic, false otherwise.
True (default) if statistics gathering is enabled on the reliable topic, false otherwise.
The JobTracker configuration is used to setup behavior of the Hazelcast MapReduce framework.
Every JobTracker is capable of running multiple map reduce jobs at once and so once configuration
is meant as a shared resource for all jobs created by the same JobTracker.
The configuration gives full control over the expected load behavior and thread counts to be used.
The maximum thread pool size of the JobTracker.
The maximum size of the queue; the maximum number of tasks that can wait to be processed. A
value of 0 means an unbounded queue.
retry-count is currently not used but reserved for later use where the framework will
automatically try to restart / retry operations from a available savepoint.
The number of emitted values before a chunk is send to the reducers.
If your emitted values are big, you might want to change this to a lower value. If you want
to better balance your work, you might want to change this to a higher value.
A value of 0 means immediate transmission, but remember that low values mean higher traffic
costs.
A very high value might cause an OutOfMemoryError to occur if emitted values do not fit into
heap memory before being sent to reducers. To prevent this, you might want to use a combiner
to pre-reduce values on mapping nodes.
True if statistics (for example, about processed entries)
are transmitted to the job emitter, false otherwise. This might be used to show any kind of progress to
users inside of UI systems, but this produces additional traffic. If statistics are not needed, you might
want to deactivate this.
Defines how the map reduce framework will react on topology
changes while executing a job.
Currently only CANCEL_RUNNING_OPERATION is fully supported; it throws an exception to
the job emitter (throws com.hazelcast.mapreduce.TopologyChangedException).
The thread count to which the concurrent access is limited. For example, if you set
it to "3", concurrent access to the object is limited to 3 threads.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then all permits of the semaphore are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then all permits of the semaphore are copied to one other JVM for
fail-safety.
Number of items in the ringbuffer. If no time-to-live-seconds is set, the size will always
be equal to capacity after the head completed the first loop around the ring. This is
because no items are getting retired.
Maximum number of seconds for each entry to stay in the ringbuffer. Entries that are
older than <time-to-live-seconds> and are not updated for <time-to-live-seconds>
are automatically evicted from the map.
Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then the items in the ringbuffer are copied to one other JVM for
fail-safety.
Number of asynchronous backups. For example, if 1 is set as the backup-count,
then the items in the ringbuffer are copied to one other JVM for
fail-safety.
Data type used to store entries.
Possible values:
BINARY (default): keys and values are stored as binary data.
OBJECT: values are stored in their object forms.
NATIVE: keys and values are stored in native memory.
Overrides the public address of a node. By default, a node selects its socket address
as its public address. But behind a network address translation (NAT), two endpoints (nodes)
may not be able to see/access each other. If both nodes set their public addresses to their
defined addresses on NAT, then they can communicate with each other. In this case, their
public addresses are not an address of a local network interface but a virtual address defined by NAT.
This is optional to set and useful when you have a private cloud.
The ports which Hazelcast will use to communicate between cluster members. Its default value is 5701.
It has the following attributes.
port-count: The default value is 100, meaning that Hazelcast will try to bind 100 ports.
If you set the value of port as 5701, as members join the cluster, Hazelcast tries to find
ports between 5701 and 5801. You can change the port count in cases like having large
instances on a single machine or you are willing to have only a few ports assigned.
auto-increment: Default value is true. If port is set to 5701, Hazelcast will try to find free
ports between 5701 and 5801. Normally, you will not need to change this value, but it comes
in handy when needed. You may also want to choose to use only one port. In that case, you can
disable the auto-increment feature of port by setting its value as false.
When you shutdown a cluster member, the server socket port will be in the TIME_WAIT
state for the next couple of minutes. If you start the member right after shutting it down,
you may not be able to bind it to the same port because it is in the TIME_WAIT state. If you
set reuse-address to true, the TIME_WAIT state is ignored and you can bind the member to the
same port again. Default value is false.
By default, Hazelcast lets the system pick up an ephemeral port during socket bind operation.
But security policies/firewalls may require to restrict outbound ports to be used by
Hazelcast-enabled applications. To fulfill this requirement, you can configure Hazelcast to use
only defined outbound ports.
outbound-ports has the ports attribute to allow you to define outbound ports.
encryption algorithm such as
DES/ECB/PKCS5Padding,
PBEWithMD5AndDES,
AES/CBC/PKCS5Padding,
Blowfish,
DESede
IP address of the required member. Cluster will form only if the member with this IP
address is found.
IP address(es) of one or more well known members. Once members are connected to these
well known ones, all member addresses will be communicated with each other.
Comma separated IP addresses of one or more well known members.
Specifies whether the TCP/IP discovery is enabled or not. Default value is false.
The maximum amount of time Hazelcast is going to try to connect to a well known member
before giving up. Setting it to a too low value could mean that a member is not able
to connect to a cluster. Setting it to a too high value means that member startup could
slow down because of longer timeouts (e.g. when a well known member is not up). Increasing
this value is recommended if you have many IPs listed and the members cannot properly
build up the cluster. Its default value is 5.
The multicast group IP address. Specify it when you want to create clusters within the
same network. Values can be between 224.0.0.0 and 239.255.255.255. Default value is 224.2.2.3.
The multicast socket port through which the Hazelcast member listens and sends discovery messages.
Default value is 54327.
Only when the nodes are starting up, this timeout (in seconds) specifies the period during
which a node waits for a multicast response from another node. For example, if you set it
to 60 seconds, each node will wait for 60 seconds until a leader node is selected.
Its default value is 2 seconds.
Time-to-live value for multicast packets sent out to control the scope of multicasts.
Includes IP addresses of trusted members. When a node wants to join to the cluster,
its join request will be rejected if it is not a trusted member. You can give an IP
addresses range using the wildcard (*) on the last digit of the IP address
(e.g. 192.168.1.* or 192.168.1.100-110).
Specifies whether the multicast discovery is enabled or not. Values can be true or false.
Access key of your account on EC2.
Secret key of your account on EC2.
The region where your nodes are running. Default value is us-east-1.
Needs to be specified if the region is other than the default one.
The URL that is the entry point for a web service. It is optional.
Name of the security group you specified at the EC2 management console.
It is used to narrow the Hazelcast nodes to be within this group.
It is optional.
To narrow the members in the cloud down to only Hazelcast nodes, you can set
this to the one you specified in the EC2 console. It is optional.
To narrow the members in the cloud down to only Hazelcast nodes, you can set
this to the one you specified in the EC2 console. It is optional.
Specifies whether the EC2 discovery is enabled or not. Value can be true or false.
The maximum amount of time Hazelcast is going to try to connect to a well known member
before giving up. Setting its value too low value could mean that a member is not able
to connect to a cluster. Setting it too high value means that member startup could slow
down because of longer timeouts (e.g. when a well known member is not up). Increasing
this value is recommended if you have many IPs listed and the members cannot properly
build up the cluster. Its default value is 5.
True (default) if statistics gathering is enabled on the executor task, false otherwise.
The number of executor threads per member for the executor.
Queue capacity of the executor task. 0 means Integer.MAX_VALUE.
The number of seconds to delay the store writes. Default value is 0.
The number of operations to be included in each batch processing round. Default value is 1.
Setting this is meaningful if you are using write behind in MapStore. When write-coalescing is true,
only the latest store operation on a key in the write-delay-seconds time-window will be
reflected to MapStore. Default value is true.
True to enable this map-store, false to disable.
Sets the initial load mode.
LAZY: default load mode, where load is asynchronous.
EAGER: load is blocked till all partitions are loaded.
True to enable value caching, false to disable.
The predicate to filter events which will be applied to the QueryCache.
Data type used to store entries.
Possible values:
BINARY (default): keys and values are stored as binary data.
OBJECT: values are stored in their object forms.
NATIVE: keys and values are stored in native memory.
Endpoint address of the principal. Wildcards(*) can be used.
Name of the principal. Wildcards(*) can be used.
Name of the permission. Wildcards(*) can be used.
Permission actions that are permitted on Hazelcast instance objects.
One of the following: membership-listener, instance-listener, migration-listener or
partition-lost-listener.