.hazelcast-all.3.8.2.source-code.hazelcast-spring-3.8.xsd Maven / Gradle / Ivy
The number of executor threads per Member for the Executor.
Executor's task queue capacity. 0 means Integer.MAX_VALUE.
Enable/disable statistics
The number of executor threads per Member for the Executor.
The durability of the executor
Executor's task capacity (per partition)
The number of executor threads per member for the executor.
The durability of the scheduled executor.
The maximum number of tasks that a scheduler can have at any given point
in time per partition.
Number of synchronous backups. For example, if 1 is set as the backup-count,
then the cardinality estimation 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 async-backup-count,
then cardinality estimation will be copied to one other JVM (asynchronously) for
fail-safety. Valid numbers are 0 (no backup), 1, 2 ... 6.
Name of the cardinality estimator.
Value of maximum size of items in the Queue.
Count of synchronous backups. Remember that, Queue is a non-partitioned
data structure, i.e. all entries of a Set resides in one partition. When
this parameter is '1', it means there will be a backup of that Set in
another node in the cluster. When it is '2', 2 nodes will have the backup.
Count of asynchronous backups.
Enable/disable statistics.
Includes the ring buffer store factory class name. The store format is the same as
the in-memory-format for the ringbuffer.
Name of the class or bean implementing MapLoader and/or MapStore.
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. The default value is 10000.
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.
`backup-count` + `async-backup-count` cannot be bigger than maximum
backup count which is `6`. Valid numbers are 0 (no backup), 1, 2 ... 6.
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.
`backup-count` + `async-backup-count` cannot be bigger than maximum
backup count which is `6`. Valid numbers are 0 (no backup), 1, 2 ... 6.
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.
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. Only available on Hazelcast
Enterprise.
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 the items in the ringbuffer are copied to one other JVM for fail-safety.
`backup-count` + `async-backup-count` cannot be bigger than maximum
backup count which is `6`. Valid numbers are 0 (no backup), 1, 2 ... 6.
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.
`backup-count` + `async-backup-count` cannot be bigger than maximum
backup count which is `6`. Valid numbers are 0 (no backup), 1, 2 ... 6.
Enable/disable statistics.
The maximum number of items to read in a batch.
Policy to handle an overloaded topic. Available values are `DISCARD_OLDEST`, `DISCARD_NEWEST`,
`BLOCK` and `ERROR`. The default value is `BLOCK.
Name of the class or bean implementing MapLoader and/or MapStore.
Number of seconds to delay to call the MapStore.store(key,
value).
If the value is zero then it is write-through so
MapStore.store(key, value) will be called as soon as the
entry is updated. Otherwise it is write-behind so updates will
be stored after write-delay-seconds value by calling
Hazelcast.storeAll(map). Default value is 0.
Used to create batch chunks when writing map store. In default
mode all entries will be tried to persist in one go. To create
batch chunks, minimum meaningful value for write-batch-size is
2.
For values smaller than 2, it works as in default mode.
Setting write-coalescing is meaningful if you are using
write-behind map-store. Otherwise it has no effect.
When write-coalescing is true, only the latest
store operation on a key in the write-delay-seconds
time-window will be reflected to the map-store.
Hazelcast can replicate some or all of the cluster data. For example,
you can have 5 different maps but you want only one of these maps
replicating across clusters. To achieve this you mark the maps
to be replicated by adding this element.
This configuration lets you index the attributes and also order them.
This configuration lets you define extractors for custom attributes.
This configuration lets you add listeners (listener classes) for the
map entries.
List of partition lost listeners
Internal eviction algorithm finds most appropriate entry
to evict from this map by using this policy.
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. Only available on Hazelcast Enterprise.
You can retrieve some statistics like owned entry count, backup entry count,
last update time, locked entry count by setting this parameter's value
as "true". The method for retrieving the statistics is `getLocalMapStats()`.
This parameter is deprecated as of Hazelcast 3.6
Use cache-deserialized-values attribute instead.
When both optimize-query and cache-deserialized-values are used at the same time
Hazelcast will do its best to detect possible conflicts. Conflict detection
is done on best-effort basis and you should not rely on it.
This parameter is used to increase 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.
Control caching of de-serialized values. Caching makes query evaluation faster, but it cost memory.
Possible Values:
NEVER: Never cache de-serialized object
INDEX-ONLY: Cache values only when they are inserted into an index.
ALWAYS: Always cache de-serialized values.
Number of sync backups. If 1 is set as the backup-count for example, then
all
entries of the map will be copied to another JVM for fail-safety. Valid
numbers are 0 (no backup), 1, 2 ... 6.
Number of async backups. If 1 is set as the backup-count for example, then
all
entries of the map will be copied to another 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 not updated for
`time-to-live-seconds` will get automatically evicted from the map. Any
integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.
Maximum size. Any integer between 0 and Integer.MAX_VALUE. 0 means
Integer.MAX_VALUE. Default is 0.
Valid values are:
PER_NODE: Maximum number of map entries in each Hazelcast instance.
This is the default policy.
PER_PARTITION: Maximum number of map entries within each partition. Storage size
depends on the partition count in a Hazelcast instance.
This attribute should not be used often.
Avoid using this attribute with a small cluster: if the cluster is small it will
be hosting more partitions, and therefore map entries, than that of a larger
cluster. Thus, for a small cluster, eviction of the entries will decrease
performance (the number of entries is large).
USED_HEAP_SIZE: Maximum used heap size in megabytes per map for each Hazelcast instance.
USED_HEAP_PERCENTAGE: Maximum used heap size percentage per map for each Hazelcast instance.
If, for example, JVM is configured to have 1000 MB and this value is 10, then the map
entries will be evicted when used heap size exceeds 100 MB.
FREE_HEAP_SIZE: Minimum free heap size in megabytes for each JVM.
FREE_HEAP_PERCENTAGE: Minimum free heap size percentage for each JVM.
For example, if JVM is configured to have 1000 MB and this value is 10,
then the map entries will be evicted when free heap size is below 100 MB.
USED_NATIVE_MEMORY_SIZE: Maximum used native memory size in megabytes per map
for each Hazelcast instance.
USED_NATIVE_MEMORY_PERCENTAGE: Maximum used native memory size percentage per map
for each Hazelcast instance.
FREE_NATIVE_MEMORY_SIZE: Minimum free native memory size in megabytes
for each Hazelcast instance.
FREE_NATIVE_MEMORY_PERCENTAGE: Minimum free native memory size percentage
for each Hazelcast instance.
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 will get
automatically evicted from the map. Entry is touched if get, put or
containsKey is called. Any integer between 0 and Integer.MAX_VALUE. 0 means
infinite. Default is 0.
This parameter is deprecated as of version 3.7 due to the eviction mechanism change.
(New eviction mechanism uses a probabilistic algorithm based on sampling. Please see documentation for further details.)
When max. size is reached, specified percentage of the map will be evicted.
Any integer between 0 and 100. If 25 is set for example, 25% of the
entries will get evicted.
This parameter is deprecated as of version 3.7 due to the eviction mechanism change.
(New eviction mechanism uses a probabilistic algorithm based on sampling. Please see documentation for further details.)
Minimum time in milliseconds which should pass before checking if a
partition of this map is evictable or not. Default value is 100 millis.
Valid values are: NONE (no eviction), LRU (Least Recently Used), LFU
(Least Frequently Used). NONE is the default.
While recovering from split-brain (network partitioning), map entries in
the small cluster will merge into the bigger cluster based on the policy set
here. When an entry merge into the cluster, there might an existing entry
with the same key already. Values of these entries might be different for
that same key. Which value should be set for the key? Conflict is resolved
by the policy set here.
There are built-in merge policies such as:
com.hazelcast.map.merge.PassThroughMergePolicy; entry will be added if
there is no existing entry for the key.
com.hazelcast.map.merge.PutIfAbsentMapMergePolicy ; entry will be added
if
the merging entry doesn't exist in the cluster.
com.hazelcast.map.merge.HigherHitsMapMergePolicy ; entry with the higher
hits wins.
com.hazelcast.map.merge.LatestUpdateMapMergePolicy ; entry with the
latest
update wins.
Default policy is 'com.hazelcast.map.merge.PutIfAbsentMapMergePolicy'
This boolean parameter enables reading local backup entries when set as
`true`.
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 per cache
for each Hazelcast instance),
USED_NATIVE_MEMORY_PERCENTAGE (Maximum used native memory size percentage per cache
for each Hazelcast instance),
FREE_NATIVE_MEMORY_SIZE (Minimum free native memory size in megabytes for each Hazelcast instance),
FREE_NATIVE_MEMORY_PERCENTAGE (Minimum free native memory size percentage for each Hazelcast instance).
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".
List of cache entry listeners
List of partition lost listeners
Defines the expiry policy factory class name or
defines the expiry policy factory from predefined ones with duration
configuration.
Hazelcast can replicate some or all of the cluster data. For example,
you can have 5 different caches but you want only one of these caches
replicating across clusters. To achieve this you mark the caches
to be replicated by adding this element.
While recovering from split-brain (network partitioning), cache 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.cache.merge.PassThroughCacheMergePolicy` or `PASS_THROUGH`:
The entry will be added directly even though there is an existing entry for the key.
`com.hazelcast.cache.merge.PutIfAbsentCacheMergePolicy` or `PUT_IF_ABSENT`:
The entry will be added if there is no existing entry for the key.
`com.hazelcast.cache.merge.HigherHitsCacheMergePolicy` or `HIGHER_HITS`:
The entry with the higher number of hits wins.
`com.hazelcast.cache.merge.LatestAccessCacheMergePolicy` or `LATEST_ACCESS`:
The entry which has been accessed more recently wins.
Default policy is 'com.hazelcast.cache.merge.PassThroughCacheMergePolicy'
Name of the cache.
the type of keys provided as full class name
the type of values provided as full class name
Defines whether statistics gathering is enabled on a cache.
Defines whether management is enabled on a cache.
Set if read-through caching should be used.
Disables invalidation events for per entry but full-flush invalidation events are still enabled.
Full-flush invalidation event means that invalidation events for all entries on clear.
Set if write-through caching should be used.
Data type that will be used for storing records. Possible values:
BINARY (default): keys and values will be stored as binary data
OBJECT : values will be stored in their object forms
NATIVE : keys and values will be stored in native memory.
Defines the cache loader factory class name.
Defines the cache loader class name.
Defines the cache writer factory class name.
Defines the cache writer class name.
Defines the expiry policy factory class name.
Number of synchronous backups. For example, if `1` is set as the `backup-count`,
then all entries of the cache are copied to one other instance as synchronous for fail-safety.
`backup-count` + `async-backup-count` cannot be bigger than maximum backup count which is `6`.
Valid numbers are 0 (no backup), 1, 2 ... 6.
Number of asynchronous backups. For example, if `1` is set as the `async-backup-count`,
then all entries of the cache are copied to one other instance as asynchronous for fail-safety.
`backup-count` + `async-backup-count` cannot be bigger than maximum backup count which is `6`.
Valid numbers are 0 (no backup), 1, 2 ... 6.
This boolean parameter enables hot-restart feature when set as true.
Only available on Hazelcast Enterprise.
Number of sync backups. If 1 is set as the backup-count for example, then
all
entries of the map will be copied to another JVM for fail-safety. Valid
numbers are 0 (no backup), 1, 2 ... 6.
Number of async backups. If 1 is set as the backup-count for example, then
all
entries of the map will be copied to another JVM for fail-safety. Valid
numbers are 0 (no backup), 1, 2 ... 6.
Type of value collection. It can be Set or List.
You can retrieve some statistics like owned entry count, backup entry count,
last update time, locked entry count by setting this parameter's value
as "true". The method for retrieving the statistics is `getLocalMultiMapStats()`.
By default, BINARY in-memory format is used, meaning that the object is stored
in a serialized form. You can set it to false, then, the OBJECT in-memory format
is used, which is useful when the OBJECT in-memory format has a smaller memory
footprint than BINARY.
Maximum size. Any integer between 0 and Integer.MAX_VALUE. 0 means
Integer.MAX_VALUE. Default is 0.
Count of synchronous backups. Remember that, List is a non-partitioned data
structure, i.e. all entries of a List resides in one partition. When this
parameter is '1', it means there will be a backup of that List in another
node in the cluster. When it is '2', 2 nodes will have the backup.
Count of asynchronous backups.
Enable/disable statistics
Maximum size. Any integer between 0 and Integer.MAX_VALUE. 0 means
Integer.MAX_VALUE. Default is 0.
Count of synchronous backups. Remember that, Set is a non-partitioned data
structure, i.e. all entries of a List resides in one partition. When this
parameter is '1', it means there will be a backup of that List in another
node in the cluster. When it is '2', 2 nodes will have the backup.
Count of asynchronous backups.
Enable/disable statistics
If set as `true`, you can retrieve statistics for the topic using the
method `getLocalTopicStats()`.
By default, it is false, meaning there is no global order
guarantee by default.
Default is `false`, meaning only one dedicated thread will handle topic messages.
When multi-threading enabled (true) all threads from event thread pool can be used for message handling.
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 max-thread-size setting configures the maximum thread pool size of the
JobTracker.
The queue-size defines the maximum number of tasks are able to wait to be
processed. A value of 0 means number of partitions * 2.
retry-count is currently not used but reserved for later use where the
framework will automatically try to restart / retry operations from an
available savepoint.
The chunk-size defined the number of emitted values before a chunk is sent
to the reducers. If your emitted values are big or you want to better
balance your work you might want to change this to a lower or 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 not fit into heap memory before being send to
reducers. To prevent this you might want to use a combiner to pre-reduce
values on mapping nodes.
The communicate-stats setting defines if statistics (for example about
processed entries) are transmitted to the job emitter. This might be used
to show any kind of progress to an user inside of an UI system but produces
additional traffic. If not needed you might want to deactivate this.
The topology-changed-strategy defines how the map reduce framework will
react on topology changes while executing a job. Currently only
CANCEL_RUNNING_OPERATION is fully supported which throws an exception to the
job emitter (throws com.hazelcast.mapreduce.TopologyChangedException).
A replicated map is a implementation
of the map
interface which is not
partitioned but fully replicates all data to all members.
Due to the nature of weak consistency there is a chance of reading staled data
and no
guarantee is given to retrieve the same value on multiple get calls.
ReplicatedMap was added in Hazelcast 3.2.
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 a number of milliseconds after a put is executed before the value is
replicated
to other nodes. In this time multiple puts can be operated and are cached up
to be send
at once.
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.
This value defines it the replicated map is available for reads before the
initial
replication is completed. Default is true. If set to false no Exception will
be
thrown when replicated map is not yet ready but call will block until
finished.
Specify the name, type and value of your attribute here.
True to set the node as a lite member, false otherwise.
Custom classes implementing com.hazelcast.nio.serialization.DataSerializableFactory to be registered.
These can be used to speed up serialization/deserialization of objects.
PortableFactory class to be registered.
Global serializer class to be registered if no other serializer is applicable.
Defines the class name of the serializer implementation.
Configure the hazelcast instance
Configure the hazelcast client
Retrieve a Hazelcast IMap instance
Retrieve a JCache cache manager from specified Hazelcast instance
Retrieve a Hazelcast MultiMap instance
Retrieve a Hazelcast ReplicatedMap instance
Retrieve a Hazelcast IQueue instance
Retrieve a Hazelcast Ringbuffer instance
Retrieve a Hazelcast ITopic instance
Retrieve a Hazelcast ISet instance
Retrieve a Hazelcast IList instance
Retrieve a Hazelcast IExecutorService instance
Retrieve a Hazelcast IdGenerator instance
Retrieve a Hazelcast IAtomicLong instance
Retrieve a Hazelcast IAtomicReference instance
Retrieve a Hazelcast ICountDownLatch instance
Retrieve a Hazelcast ISemaphore instance
Retrieve a Hazelcast ILock instance
element.]]>
Encryption algorithm such as DES/ECB/PKCS5Padding, PBEWithMD5AndDES, AES/CBC/PKCS5Padding,
Blowfish, DESede.
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).
Name of the principal. Wildcards(*) can be used.
Name of the permission. Wildcards(*) can be used.
Endpoint address of principal. Wildcards(*) can be used.
Permission actions that are permitted on Hazelcast instance objects.
Deprecated element, subject to remove. Please use class-name/implementation attributes instead
Credentials className
This configuration lets you add listeners (listener classes) for the
map entries.
This configuration lets you index the attributes and also order them.
This configuration lets you index the attributes and also order them.
One of membership-listener, instance-listener or migration-listener
Base directory for all hot-restart data. Can be an absolute or relative path to the node startup
directory.
Base directory for hot backups. Each new backup will be created in a separate directory inside this one.
Can be an absolute or relative path to the node startup directory.
True to enable hot-restart, false otherwise.
Validation timeout for hot-restart process, includes validating
cluster members expected to join and partition table on all cluster.
Data load timeout for hot-restart process,
all members in the cluster should complete restoring their local data
before this timeout.
Specifies the policy that will be respected during hot restart cluster start. Valid values are :
FULL_RECOVERY_ONLY : Starts the cluster only when all expected nodes are present and correct.
Otherwise, it fails.
PARTIAL_RECOVERY_MOST_RECENT : Starts the cluster with the members which have most up-to-date
partition table and successfully restored their data. All other members will leave the cluster and
force-start themselves. If no member restores its data successfully, cluster start fails.
PARTIAL_RECOVERY_MOST_COMPLETE : Starts the cluster with the largest group of members which have the
same partition table version and successfully restored their data. All other members will leave the
cluster and force-start themselves. If no member restores its data successfully, cluster start fails.
True if disk write should be followed by an fsync() system call,
false otherwise.
True if hot-restart is enabled, false otherwise
Only available on Hazelcast Enterprise.