-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
hazelcast-spring-3.8.xsd
2863 lines (2768 loc) · 167 KB
/
hazelcast-spring-3.8.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.hazelcast.com/schema/spring"
xmlns:tool="http://www.springframework.org/schema/tool"
targetNamespace="http://www.hazelcast.com/schema/spring"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:import namespace="http://www.springframework.org/schema/tool"
schemaLocation="http://www.springframework.org/schema/tool/spring-tool.xsd"/>
<xs:element name="config">
<xs:complexType>
<xs:complexContent>
<xs:extension base="hazelcast-bean">
<xs:sequence>
<xs:element name="spring-aware" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="instance-name" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="group" type="group" minOccurs="0" maxOccurs="1"/>
<xs:element name="license-key" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="management-center" type="management-center" minOccurs="0" maxOccurs="1"/>
<xs:element name="properties" type="properties" minOccurs="0" maxOccurs="1"/>
<xs:element name="wan-replication" type="wan-replication" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="network" type="network" minOccurs="0" maxOccurs="1"/>
<xs:element name="partition-group" type="partition-group" minOccurs="0" maxOccurs="1"/>
<xs:element name="executor-service" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence/>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="pool-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
The number of executor threads per Member for the Executor.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="queue-capacity" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Executor's task queue capacity. 0 means Integer.MAX_VALUE.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="statistics-enabled" type="parameterized-boolean"
use="optional" default="true">
<xs:annotation>
<xs:documentation>
Enable/disable statistics
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="durable-executor-service" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence/>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="pool-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
The number of executor threads per Member for the Executor.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="durability" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
The durability of the executor
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="capacity" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Executor's task capacity (per partition)
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="queue" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="item-listeners" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="item-listener" type="item-listener" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="queue-store" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="properties" type="properties" minOccurs="0"
maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="enabled" use="required" type="xs:string"/>
<xs:attribute name="class-name" use="optional" type="xs:string"/>
<xs:attribute name="factory-class-name" use="optional" type="xs:string"/>
<xs:attribute name="store-implementation" use="optional" type="xs:string"/>
<xs:attribute name="factory-implementation" use="optional"
type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="quorum-ref" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="max-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Value of maximum size of items in the Queue.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
Count of asynchronous backups.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="statistics-enabled" type="parameterized-boolean"
use="optional" default="true">
<xs:annotation>
<xs:documentation>
Enable/disable statistics.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="empty-queue-ttl" use="optional" default="-1">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="-1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="lock" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="quorum-ref" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="ringbuffer" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="ringbuffer-store" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Includes the ring buffer store factory class name. The store format is the same as
the in-memory-format for the ringbuffer.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="enabled" use="required" type="parameterized-boolean"/>
<xs:attributeGroup ref="class-or-bean-name">
<xs:annotation>
<xs:documentation>
Name of the class or bean implementing MapLoader and/or MapStore.
</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
<xs:attribute name="factory-class-name" use="optional" type="xs:string"/>
<xs:attribute name="factory-implementation" use="optional"
type="xs:string"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="capacity" use="optional" type="parameterized-unsigned-int">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count" default="1">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count"
default="0">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="time-to-live-seconds" use="optional" type="parameterized-unsigned-int">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="in-memory-format" use="optional" type="in-memory-format" default="BINARY">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="semaphore" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="initial-permits" use="optional" type="parameterized-unsigned-int">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count" default="1">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count"
default="0">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="reliable-topic" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="message-listeners" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="message-listener" type="listener" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="statistics-enabled" type="parameterized-boolean" use="optional" default="true">
<xs:annotation>
<xs:documentation>
Enable/disable statistics.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="read-batch-size" use="optional" type="xs:int" default="10">
<xs:annotation>
<xs:documentation>
The maximum number of items to read in a batch.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="topic-overload-policy" use="optional" type="topic-overload-policy">
<xs:annotation>
<xs:documentation>
Policy to handle an overloaded topic. Available values are `DISCARD_OLDEST`, `DISCARD_NEWEST`,
`BLOCK` and `ERROR`. The default value is `BLOCK.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="map" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="map-store" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="properties" type="properties" minOccurs="0"
maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="enabled" use="required" type="xs:string"/>
<xs:attributeGroup ref="class-or-bean-name">
<xs:annotation>
<xs:documentation>
Name of the class or bean implementing MapLoader and/or MapStore.
</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
<xs:attribute name="factory-class-name" use="optional" type="xs:string"/>
<xs:attribute name="factory-implementation" use="optional"
type="xs:string"/>
<xs:attribute name="write-delay-seconds" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="write-batch-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="write-coalescing" use="optional" type="parameterized-boolean"
default="true">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initial-mode">
<xs:simpleType>
<xs:restriction base="non-space-string">
<xs:enumeration value="LAZY"/>
<xs:enumeration value="EAGER"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="near-cache" type="near-cache" minOccurs="0" maxOccurs="1"/>
<xs:element name="query-caches" type="query-caches" minOccurs="0" maxOccurs="1"/>
<xs:element name="wan-replication-ref" type="wan-replication-ref" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="indexes" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
This configuration lets you index the attributes and also order them.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="index" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="attribute" type="xs:string" use="required"/>
<xs:attribute name="ordered" type="xs:string" use="optional"
default="false"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="attributes" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
This configuration lets you define extractors for custom attributes.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="attribute" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="extractor" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="entry-listeners" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
This configuration lets you add listeners (listener classes) for the
map entries.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="entry-listener" type="entry-listener" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="quorum-ref" minOccurs="0" maxOccurs="1"/>
<xs:element name="partition-lost-listeners" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>List of partition lost listeners</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="partition-lost-listener" type="listener"
minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="hot-restart" type="hot-restart" minOccurs="0" maxOccurs="1" />
<xs:element name="map-eviction-policy" type="map-eviction-policy" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Internal eviction algorithm finds most appropriate entry
to evict from this map by using this policy.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="partition-strategy" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="in-memory-format" use="optional" type="xs:string" default="BINARY">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="statistics-enabled" use="optional" type="parameterized-boolean"
default="true">
<xs:annotation>
<xs:documentation>
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()`.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optimize-queries" use="optional" type="parameterized-boolean">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-deserialized-values" use="optional" type="cache-deserialized">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="time-to-live-seconds" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="max-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Maximum size. Any integer between 0 and Integer.MAX_VALUE. 0 means
Integer.MAX_VALUE. Default is 0.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<!--max-size-policy attribute didn't converted into enumeration to support case-insensitivity-->
<xs:attribute name="max-size-policy" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="max-idle-seconds" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="eviction-percentage" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="min-eviction-check-millis" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="eviction-policy" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Valid values are: NONE (no eviction), LRU (Least Recently Used), LFU
(Least Frequently Used). NONE is the default.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="merge-policy" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
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.
<p>
<br/>
There are built-in merge policies such as:
<br/>
com.hazelcast.map.merge.PassThroughMergePolicy; entry will be added if
there is no existing entry for the key.
<br/>
com.hazelcast.map.merge.PutIfAbsentMapMergePolicy ; entry will be added
if
the merging entry doesn't exist in the cluster.
<br/>
com.hazelcast.map.merge.HigherHitsMapMergePolicy ; entry with the higher
hits wins.
<br/>
com.hazelcast.map.merge.LatestUpdateMapMergePolicy ; entry with the
latest
update wins.
<br/>
Default policy is 'com.hazelcast.map.merge.PutIfAbsentMapMergePolicy'
</p>
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="read-backup-data" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
This boolean parameter enables reading local backup entries when set as
`true`.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="cache" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="eviction" type="eviction" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
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".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="cache-entry-listeners" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>List of cache entry listeners</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="cache-entry-listener" type="cache-entry-listener"
minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="partition-lost-listeners" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>List of partition lost listeners</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="partition-lost-listener" type="listener"
minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="expiry-policy-factory" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Defines the expiry policy factory class name or
defines the expiry policy factory from predefined ones with duration
configuration.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="timed-expiry-policy-factory"
type="timed-expiry-policy-factory"
minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="class-name"/>
</xs:complexType>
</xs:element>
<xs:element name="wan-replication-ref" type="wan-replication-ref" minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="quorum-ref" minOccurs="0" maxOccurs="1" />
<xs:element name="merge-policy" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
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.
<p>
<br/>There are built-in merge policies, such as:
<br/>`com.hazelcast.cache.merge.PassThroughCacheMergePolicy` or `PASS_THROUGH`:
The entry will be added directly even though there is an existing entry for the key.
<br/>`com.hazelcast.cache.merge.PutIfAbsentCacheMergePolicy` or `PUT_IF_ABSENT`:
The entry will be added if there is no existing entry for the key.
<br/>`com.hazelcast.cache.merge.HigherHitsCacheMergePolicy` or `HIGHER_HITS`:
The entry with the higher number of hits wins.
<br/>`com.hazelcast.cache.merge.LatestAccessCacheMergePolicy` or `LATEST_ACCESS`:
The entry which has been accessed more recently wins.
<br/>Default policy is 'com.hazelcast.cache.merge.PassThroughCacheMergePolicy'
</p>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="hot-restart" type="hot-restart" minOccurs="0" maxOccurs="1" />
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the cache.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="key-type" type="non-space-string" use="optional">
<xs:annotation>
<xs:documentation>the type of keys provided as full class name
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value-type" type="non-space-string" use="optional">
<xs:annotation>
<xs:documentation>the type of values provided as full class name
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="statistics-enabled" type="parameterized-boolean" use="optional">
<xs:annotation>
<xs:documentation>
Defines whether statistics gathering is enabled on a cache.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="management-enabled" type="parameterized-boolean" use="optional">
<xs:annotation>
<xs:documentation>
Defines whether management is enabled on a cache.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="read-through" type="parameterized-boolean" use="optional">
<xs:annotation>
<xs:documentation>
Set if read-through caching should be used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="disable-per-entry-invalidation-events" type="parameterized-boolean" use="optional">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="write-through" type="parameterized-boolean" use="optional">
<xs:annotation>
<xs:documentation>
Set if write-through caching should be used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="in-memory-format" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-loader-factory" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
Defines the cache loader factory class name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-writer-factory" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
Defines the cache writer factory class name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="expiry-policy-factory" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
Defines the expiry policy factory class name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="hot-restart-enabled" use="optional" type="parameterized-boolean">
<xs:annotation>
<xs:documentation>
This boolean parameter enables hot-restart feature when set as true.
Only available on Hazelcast Enterprise.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="multimap" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="entry-listeners" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="entry-listener" type="entry-listener" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="optional" default="default"/>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value-collection-type" type="xs:string" use="optional"
default="SET">
<xs:annotation>
<xs:documentation>
Type of value collection. It can be Set or List.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="statistics-enabled" use="optional" type="parameterized-boolean"
default="true">
<xs:annotation>
<xs:documentation>
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()`.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="binary" use="optional" type="parameterized-boolean"
default="true">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="list" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="item-listeners" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="item-listener" type="item-listener" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string"/>
<xs:attribute name="max-size" use="optional" type="xs:string">
<xs:annotation>
<xs:documentation>
Maximum size. Any integer between 0 and Integer.MAX_VALUE. 0 means
Integer.MAX_VALUE. Default is 0.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="backup-count" use="optional" type="parameterized-backup-count">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>