forked from ModeShape/modeshape
-
Notifications
You must be signed in to change notification settings - Fork 1
/
modeshape_1_0.xsd
841 lines (791 loc) · 40 KB
/
modeshape_1_0.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
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:jboss:domain:modeshape:1.0"
xmlns="urn:jboss:domain:modeshape:1.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
version="1.0">
<!-- The subsystem root element -->
<xs:element name="subsystem" type="subsystem">
<xs:annotation>
<xs:documentation>Enumerates the available repositories.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="subsystem">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="repository" type="repository">
<xs:annotation>
<xs:documentation>Defines an embedded cache container.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
<xs:complexType name="repository">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="workspaces" type="workspaces" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the pre-existing workspaces that will exist when the repository starts up.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="node-types" type="node-types" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of node type (CND) files that should be import on repository start-up
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="authenticators" type="authenticators" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the custom authenticators.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sequencers" type="sequencers" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the custom sequencers.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="test-extractors" type="text-extractors" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the custom text extractors.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="external-sources" type="external-sources" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the external sources</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="indexing" type="indexing" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The definition of the indexing mechanism.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="local-file-index-storage" type="local-file-index-storage">
<xs:annotation>
<xs:documentation>The indexes are stored on the local file system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="master-file-index-storage" type="master-file-index-storage">
<xs:annotation>
<xs:documentation>The indexes are stored on the local file system and are considered the master indexes that will be
periodically copied.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="slave-file-index-storage" type="slave-file-index-storage">
<xs:annotation>
<xs:documentation>The indexes are stored on the local file system and are considered the slave indexes that will be
periodically updated from the master.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="cache-index-storage" type="cache-index-storage">
<xs:annotation>
<xs:documentation>The indexes are stored in an Infinispan cache.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ram-index-storage" type="ram-index-storage">
<xs:annotation>
<xs:documentation>The indexes are stored only in memory. This option is not appropriate in a cluster.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="custom-index-storage" type="custom-index-storage">
<xs:annotation>
<xs:documentation>A custom storage option for the indexes.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="file-binary-storage" type="file-binary-storage">
<xs:annotation>
<xs:documentation>The binary files are stored on the local file system.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="cache-binary-storage" type="cache-binary-storage">
<xs:annotation>
<xs:documentation>The binary files are stored in an Infinispan cache.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="db-binary-storage" type="db-binary-storage">
<xs:annotation>
<xs:documentation>The binary files are stored in a relational database.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="custom-binary-storage" type="custom-binary-storage">
<xs:annotation>
<xs:documentation>The binary files are stored in a custom system.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<!-- Attributes for 'repository' -->
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the repository, which must be unique within the subsystem.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where repository content will be stored.
If not provided, the repository name is used for the cache name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-container" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache container in which the cache can be found.
If not provided, the subsystem's default cache container will be used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jndi-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name in JNDI where this repository is to be
registered. If no value set, the repository will not be
bound to 'jcr/local/{repositoryName}' (where '{repositoryName}' is the name
of this repository).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="enable-monitoring" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>Specifies whether the repository is to maintain the metrics that can be used
to monitor the performance and activities. The default value is 'true', meaning monitoring is
enabled.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="security-domain" type="xs:string" default="modeshape-security">
<xs:annotation>
<xs:documentation>The name of the security domain that should be used for JAAS authentication.
The default is 'modeshape-security'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="anonymous-roles" type="roleNames" default="readonly readwrite admin">
<xs:annotation>
<xs:documentation>The space-separated names of the roles for anonymous users.
Anonymous logins will be disabled if the roles consists of an empty string.
By default, the roles are 'readonly', 'readwrite', and 'admin'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="anonymous-username" type="xs:string" default="<anonymous>">
<xs:annotation>
<xs:documentation>The username for all anonymous users.
The username '<anonymous>' is used by default
(that is, 'anonymous' surrounded by angle brackets").
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="use-anonymous-upon-failed-authentication" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>Indicates that failed authentication attempts will not result in a
LoginException but will instead fall back to anonymous access.
If anonymous access is not enabled, then failed login attempts will
throw a LoginException. The default value is 'false'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cluster-stack" type="xs:string">
<xs:annotation>
<xs:documentation>Defines the JGroups stack used by the repository when clustered.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cluster-name" type="xs:string" >
<xs:annotation>
<xs:documentation>Defines the name of the communication channel used by this and other clustered repositories</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="workspaces">
<xs:annotation>
<xs:documentation>The definition of the predefined workspaces that exist when the repository
is started. The 'default-workspace' need not be predefined, since the default workspace
must exist.</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="workspace" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The definition of a predefined workspace that exists when the repository is started.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="initial-content" type="initial-content" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The path to the file which should be imported as initial content for this workspace</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the workspace.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="initial-content" type="initial-content" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The path to the file which should be imported as initial content by default for all new workspaces</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="default-workspace" type="xs:string" use="optional" default="default">
<xs:annotation>
<xs:documentation>The name of the workspace that should be used when Sessions are created
without specifying an explicit workspace name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="allow-workspace-creation" type="xs:boolean" use="optional" default="true">
<xs:annotation>
<xs:documentation>Specifies whether users can create additional workspaces beyond the predefined, system, and default
workspaces. The default value is 'true'.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-container" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache container in which the workspace caches reside. If not provider,
a default configuration file is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="node-types">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="node-type" type="xs:string" minOccurs="1" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The uri of a CND file which will be loaded at repository startup</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="initial-content">
<xs:annotation>
<xs:documentation>Specifies the path to the initial content file that should be loaded</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:complexType name="authenticators">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="authenticator" type="authenticator" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The definition of an authenticator.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="authenticator">
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:attribute name="name" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the authenticator.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="sequencers">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="sequencer" type="sequencer" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The definition of a sequencer.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="sequencer">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="path-expression" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>An expression specifying the pattern for the input path of the properties to be sequenced and the resulting output location.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string" />
</xs:simpleType>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:attribute name="name" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the sequencer.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="path-expression" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The description of the sequencer.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="external-sources">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="source" type="source" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The definition of an external source.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="source">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="projection" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>An expressions that describes a projection path expression, in the format wsName:/projectedPath => externalPath</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string" />
</xs:simpleType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the external source.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:attribute name="cacheTtlSeconds" type="xs:integer" use="optional">
<xs:annotation>
<xs:documentation>The number of seconds which an external node should be held in the workspace cache. If not specified, the effective TTL is deferred to the workspace cache configuration. If negative, an entry will be cached forever.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="readonly" type="xs:boolean" use="optional" default="false">
<xs:annotation>
<xs:documentation>Flag which indicates whether the external source is readonly or supports writing as well. By default, a source support both reads and writes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="queryable" type="xs:boolean" use="optional" default="true">
<xs:annotation>
<xs:documentation>Flag which indicates whether the entire external content provided by this source should be queryable or not by the repository. By default, it is.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="text-extractors">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="text-extractor" type="text-extractor" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The definition of a text extractor.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="text-extractor">
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:attribute name="name" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the extractor.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="indexing">
<xs:attributeGroup ref="indexing-attributes" />
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="local-file-index-storage">
<xs:attributeGroup ref="persisted-indexing-attributes" />
<xs:attributeGroup ref="file-storage-attributes" />
<xs:attributeGroup ref="file-index-storage-attributes" />
</xs:complexType>
<xs:complexType name="master-file-index-storage">
<xs:attributeGroup ref="persisted-indexing-attributes" />
<xs:attributeGroup ref="file-storage-attributes" />
<xs:attributeGroup ref="file-index-storage-attributes" />
<xs:attributeGroup ref="file-master-slave-storage-attributes" />
<xs:attributeGroup ref="jms-backend-attributes" />
</xs:complexType>
<xs:complexType name="slave-file-index-storage">
<xs:attributeGroup ref="persisted-indexing-attributes" />
<xs:attributeGroup ref="file-storage-attributes" />
<xs:attributeGroup ref="file-index-storage-attributes" />
<xs:attributeGroup ref="file-master-slave-storage-attributes" />
<xs:attributeGroup ref="jms-backend-attributes" />
<xs:attribute name="copy-buffer-size" type="xs:int" default="16">
<xs:annotation>
<xs:documentation>The number of megabytes to move in a single low level copy instruction.
The default is '16' (or 16MB).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="retry-marker-lookup" type="xs:int" default="0">
<xs:annotation>
<xs:documentation>The number of times to look for the marker files in the source
directory before failing, waiting 5 seconds between each try. The default is '0'.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="retry-initialize-period" type="xs:int" default="0">
<xs:annotation>
<xs:documentation>The number of seconds before retrying initialization.
If the slave can't find the master index, it will try again (in the background)
until it's found, without preventing the application to start. Queries performed
before the index is initialized are not blocked but will return empty results.
A value of '0' is used by default, signaling that initialization will fail with
an exception rather than trying in the background. To prevent the application
from starting without an invalid index but still control an initialization timeout,
use 'retry-marker-lookup' instead.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="cache-index-storage">
<xs:attributeGroup ref="persisted-indexing-attributes" />
<xs:attribute name="lock-cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where index locks will be stored.
If not provided, the default will be '{repositoryName}-index-locks'
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="data-cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where index data will be stored.
If not provided, the default will be '{repositoryName}-index-data'
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="metadata-cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where index metadata will be stored.
If not provided, the default will be '{repositoryName}-index-metadata'
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-container" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache container in which the caches can be found
for storing the indexes. This should be different from the repository cache and should have batching enabled</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="chunk-size" type="xs:int" default="16834">
<xs:annotation>
<xs:documentation>The maximum size in bytes for each chunk of data. Larger sizes offer
better search performance but might be problematic during network replication or storage.
The default is 16KB, or 16834.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ram-index-storage">
</xs:complexType>
<xs:complexType name="custom-index-storage">
<xs:attributeGroup ref="persisted-indexing-attributes" />
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<xs:complexType name="file-binary-storage">
<xs:attributeGroup ref="file-storage-attributes" />
<xs:attributeGroup ref="binary-storage-attributes" />
</xs:complexType>
<xs:complexType name="cache-binary-storage">
<xs:attributeGroup ref="binary-storage-attributes" />
<xs:attribute name="data-cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where index data will be stored.
If not provided, the default will be '{repositoryName}-binary-data'
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="metadata-cache-name" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache where index metadata will be stored.
If not provided, the default will be '{repositoryName}-binary-metadata'
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cache-container" type="xs:string">
<xs:annotation>
<xs:documentation>The name of the Infinispan cache container in which the caches can be found
for storing the binary values. If not provided, the repository's cache container will be used.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="db-binary-storage">
<xs:attributeGroup ref="binary-storage-attributes" />
<xs:attribute name="data-source-jndi-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Specifies the JNDI name of the JDBC data source that should be used to store the
binary values.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="custom-binary-storage">
<xs:attributeGroup ref="implementation-class-attributes" />
<xs:attributeGroup ref="binary-storage-attributes" />
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- Global attribute groups -->
<xs:attributeGroup name="implementation-class-attributes">
<xs:attribute name="classname" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the Java implementation class.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="module" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the module containing the implementation class.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="binary-storage-attributes">
<xs:attribute name="min-value-size" type="xs:int" use="optional" default="4096">
<xs:annotation>
<xs:documentation>The size threshold that dictates whether binary values
should be stored in the binary store. Binary values smaller than this
value are stored with the node, whereas binary values with a size equal
to or greater than this limit will be stored separately from the node and in the
binary store, keyed by the SHA-1 hash of the value. This is a space and performance
optimization that stores each unique large value only once.
The default value is '4096' bytes, or 4 kilobytes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="min-string-size" type="xs:int" use="optional">
<xs:annotation>
<xs:documentation>The size threshold that dictates whether String values
should be stored in the binary store. String values smaller than this
value are stored with the node, whereas string values with a size equal
to or greater than this limit will be stored separately from the node and in the
binary store, keyed by the SHA-1 hash of the value. This is a space and performance
optimization that stores each unique large value only once.
The default value is the value of 'min-value-size'.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="file-storage-attributes">
<xs:attribute name="relative-to" type="xs:string" default="jboss.server.data.dir">
<xs:annotation>
<xs:documentation>The base directory in which to store the indexes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="path" type="xs:string">
<xs:annotation>
<xs:documentation>The system may maintain a set of indexes that
improve the performance of searching and querying the content.
These size of these indexes depend upon the size of the content
being stored, and thus may consume a significant amount of
space. This option defines the path on the file system
(within the "relative-to" location) where the indexes are to be stored
If specified, the value must be a valid path to a writable directory
on the file system. If the path specifies a non-existant location, the
repository may attempt to create the missing directories.
If the specified location is not a readable and writable
directory (or cannot be created as such), then this will
generate an exception when the repository is created.
If undefined, the path defaults to 'modeshape/{repositoryName}/indexes'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="persisted-indexing-attributes">
<xs:attribute name="format" type="index-format" use="optional" default="LUCENE_CURRENT">
<xs:annotation>
<xs:documentation>Specifies the Lucene version defining the format of the indexes.
The default value is 'LUCENE_CURRENT', but for production uses it should be explicitly
set to the specific Lucene version used when first creating the versions; changing this
value will require a manual rebuilt of all indexes.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="indexing-attributes">
<xs:attribute name="rebuild-upon-startup" type="rebuild-upon-startup-enum" use="optional" default="if_missing">
<xs:annotation>
<xs:documentation>Specifies whether the indexes need to be rebuilt immediately when
each ModeShape process starts up.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rebuild-upon-startup-mode" type="synchronous-enum" use="optional" default="sync">
<xs:annotation>
<xs:documentation>Specifies whether the rebuild process should be done synchronously or asynchronously</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rebuild-upon-startup-include-system-content" type="xs:boolean" use="optional" default="false">
<xs:annotation>
<xs:documentation>Specifies whether the index rebuild process should take system content into account or not</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="thread-pool" type="xs:string" use="optional" default="modeshape-workers">
<xs:annotation>
<xs:documentation>Name of the thread pool that should be used for background re-indexing.
Thread pools are named globally within a single ModeShape engine, and by default all
repositories use the same thread pool for sequencing and indexing.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="batch-size" type="xs:int" use="optional" default="-1">
<xs:annotation>
<xs:documentation>Advanced setting that specifies the maximum number of indexing
operation batched per transaction. Once the limit is reached indexing will be
triggered even though the context has not ended yet. A value of '-1' implies no maximum size.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="reader-strategy" type="reader-strategy-enum" use="optional" default="shared">
<xs:annotation>
<xs:documentation>Advanced setting that defines whether Lucene index readers can be shared.
With the 'shared' strategy, the same IndexReader will be used (for a given Lucene index)
across multiple queries and threads, provided that the IndexReader is still up-to-date.
If the IndexReader is not up-to-date, a new one is opened and provided.
With the 'not-shared' strategy, a new IndexReader is opened every time a query is executed,
which can be expensive.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mode" type="synchronous-enum" use="optional" default="sync">
<xs:annotation>
<xs:documentation>Specifies whether to apply the index changes synchronously or
asynchronously (in separate threads). Synchronous updates have the advantage that the
index is at all times in sync with the storec content. Asynchronous updates, on the
other hand, can help to minimize Session.save() times since index updates are executed
in the background, but may result in potential discrepancies between the saved changes
and query results.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="systemContentMode" type="systemContentIndexing-enum" use="optional" default="disabled">
<xs:annotation>
<xs:documentation>DEPRECATED. Use the [rebuild-upon-startup-mode, rebuild-upon-startup-include-system-content] attributes</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-thread-pool-size" type="xs:int" use="optional" default="1">
<xs:annotation>
<xs:documentation>Specifies the number of threads that may be used for asynchronous
application of updates. Defaults to '1', and is not used for synchronous updates.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="async-max-queue-size" type="xs:int" use="optional" default="0">
<xs:annotation>
<xs:documentation>Specifies the maximum size of the queue used for making asynchronous
updates. When the queue is filled, updates block until the queue catches up.
A value of '0' is the default and implies no limit to the queue size.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="analyzer-classname" type="xs:string" use="optional" default="org.apache.lucene.analysis.standard.StandardAnalyzer">
<xs:annotation>
<xs:documentation>The full-qualified name of the Java implementation class. By default, the
'org.apache.lucene.analysis.standard.StandardAnalyzer' class will be used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="analyzer-module" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The name of the module containing the implementation class, or
a blank module for the built-in analyzers.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="file-index-storage-attributes">
<xs:attribute name="access-type" type="file-system-access-type-enum" default="auto">
<xs:annotation>
<xs:documentation>Specifies the exact type of Lucene FSDirectory implementation to be used.
If set to 'auto' (the default), NIOFSDirectory will be used on non Windows systems and
SimpleFSDirectory will be used on Windows. If set to 'simple', then SimpleFSDirectory
will be used. If set to 'nio', then NIOFSDirectory will be used. If set to 'mmap',
then MMapDirectory will be used. Make sure to refer to Javadocs of these Directory
implementations before changing this setting. Even though NIOFSDirectory or MMapDirectory
can bring substantial performace boosts they also have constraints and limitations.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="locking-strategy" type="file-system-locking-strategy-enum" default="native">
<xs:annotation>
<xs:documentation>Species the type of locking used to prevent concurrent writes to the
indexes. The default locking strategy works well for most cases. If set to 'simple',
a marker file will be created using the Java File API (this file may need to be manually
removed if the process is terminated abormally). If set to 'native' (the default), a
marker file will be created using native OS file locks (which will never need to be
cleaned up). If set to 'single', an in-memory Java object is used for the lock, and
therefore not useful in a clustered repository. If 'none' is used, no locking is used
to prevent concurrent writes (use with caution).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="file-master-slave-storage-attributes">
<xs:attribute name="refresh-period" type="xs:int" default="3600">
<xs:annotation>
<xs:documentation>The number of seconds specifying the frequency of copying the master
index into the 'source-path' directory. The copy is incremental, so it only copies the
changes since the last copy. The recommended value for the refresh period is (at least)
50% higher that the time to copy the information, and defaults to 3600 seconds - 60 minutes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="source-relative-to" type="xs:string" default="jboss.server.data.dir">
<xs:annotation>
<xs:documentation>The base directory in which to store the copy of the indexes for master/slave refreshing.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="source-path" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The path within "source-relative-to" in which to store the copy of the indexes for master/slave refreshing.
If undefined, the path defaults to 'modeshape/{repositoryName}/indexes'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="jms-backend-attributes">
<xs:attribute name="connection-factory-jndi-name" type="xs:string" default="/ConnectionFactory">
<xs:annotation>
<xs:documentation>Defines the name in JNDI where the JMS connection factory can be found.
The default value is '/ConnectionFactory', which is the default in JBoss AS.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="queue-jndi-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Defines the name in JNDI where JMS queue can be found.
The queue will be used to post work messages.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="jgroups-backend-attributes">
<xs:attribute name="channel-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the JGroups channel used for indexing updates.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
<!-- Global simple types -->
<xs:simpleType name="index-format">
<xs:restriction base="xs:string">
<xs:pattern value="LUCENE_(3[0-9]{1,2}|CURRENT)" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="reader-strategy-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="shared" />
<xs:enumeration value="not-shared" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="synchronous-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="sync" />
<xs:enumeration value="async" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="systemContentIndexing-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="sync" />
<xs:enumeration value="async" />
<xs:enumeration value="disabled" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="rebuild-upon-startup-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="if_missing" />
<xs:enumeration value="always" />
<xs:enumeration value="never" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="file-system-access-type-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="auto" />
<xs:enumeration value="simple" />
<xs:enumeration value="nio" />
<xs:enumeration value="mmap" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="file-system-locking-strategy-enum">
<xs:restriction base="xs:string">
<xs:enumeration value="simple" />
<xs:enumeration value="native" />
<xs:enumeration value="single" />
<xs:enumeration value="none" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="roleNames">
<xs:annotation>
<xs:documentation>A list of role names.</xs:documentation>
</xs:annotation>
<xs:list itemType="xs:string"/>
</xs:simpleType>
</xs:schema>