-
Notifications
You must be signed in to change notification settings - Fork 188
/
capabilities-3.xsd
760 lines (694 loc) · 35.9 KB
/
capabilities-3.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
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2010-2018 Evolveum and contributors
~
~ This work is dual-licensed under the Apache License 2.0
~ and European Union Public License. See LICENSE file for details.
-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://midpoint.evolveum.com/xml/ns/public/resource/capabilities-3"
xmlns:tns="http://midpoint.evolveum.com/xml/ns/public/resource/capabilities-3"
xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
xmlns:q="http://prism.evolveum.com/xml/ns/public/query-3"
xmlns:a="http://prism.evolveum.com/xml/ns/public/annotation-3"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
elementFormDefault="qualified"
jaxb:extensionBindingPrefixes="xjc"
jaxb:version="2.0">
<xsd:annotation>
<xsd:documentation>
Capabilities schema.
Defines resource capabilities such as ability to enable/disable account,
ability to reset passwords, etc.
Version: 3.9
Recommended namespace prefix: cap
</xsd:documentation>
<xsd:appinfo>
<!-- jaxb:globalBindings are specified indirectly by import from common-2 -->
</xsd:appinfo>
</xsd:annotation>
<xsd:import namespace="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
schemaLocation="http://midpoint.evolveum.com/xml/ns/public/common/common-3">
<xsd:annotation>
<xsd:documentation>
Import of the common schema. Some datatypes are reused here.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<xsd:import namespace="http://prism.evolveum.com/xml/ns/public/query-3"
schemaLocation="http://prism.evolveum.com/xml/ns/public/query-3">
<xsd:annotation>
<xsd:documentation>
Prism query.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<!-- Abstract supertype -->
<xsd:complexType name="CapabilityType" abstract="true">
<xsd:annotation>
<xsd:documentation>
Abstract supertype for all (static schema) capabilities. It is in fact just a shortcut
to introduce common "enabled" flag. As custom capabilities are expected to be in a
dynamic schema this has probably very little conceptual value.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element ref="tns:enabled" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="enabled" type="xsd:boolean" default="true">
<xsd:annotation>
<xsd:documentation>
Element specifying whether the capability is enabled or disabled.
Enabled capability work as usual (this is the default). Disabled capability
acts as it is not there at all. This is used to disable undesirable
native capabilities.
Each capability definition should have this element. It is made a top-level
element in this XSD definition to make that easier.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<!-- Concrete capabilities -->
<xsd:complexType name="SchemaCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to discover resource schema.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="schema" type="tns:SchemaCapabilityType"/>
<xsd:complexType name="ActivationCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to process activation data, which means
enable/disable of accounts, dates for scheduled enable/disable
and similar things related to make the account active.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="status" type="tns:ActivationStatusCapabilityType" minOccurs="0">
</xsd:element>
<xsd:element name="validFrom" type="tns:ActivationValidityCapabilityType" minOccurs="0">
</xsd:element>
<xsd:element name="validTo" type="tns:ActivationValidityCapabilityType" minOccurs="0">
</xsd:element>
<xsd:element name="lockoutStatus" type="tns:ActivationLockoutStatusCapabilityType" minOccurs="0">
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="activation" type="tns:ActivationCapabilityType"/>
<xsd:complexType name="ActivationStatusCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to provide activation status (e.g. account enable and disable).
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="returnedByDefault" type="xsd:boolean" minOccurs="0" default="true"/>
<!-- TODO: "disable destroys password" -->
<xsd:element name="attribute" type="xsd:QName" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Name of the attribute to use for account enable/disable.
This is a configuration of simulated enable/disable capability.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="enableValue" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Value to set to the attribute when the account should be enabled.
This is a configuration of simulated enable/disable capability.
More than one value can be specified. All specified values will
be compared to the attribute when the activation status is read
from the resource (get operation). The value that matches will determine
the activation state. But only the first value will be used when
storing the activation state to the resource (add or modify operations).
All other values will be ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="disableValue" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Value to set to the attribute when the account should be disabled.
This is a configuration of simulated enable/disable capability.
More than one value can be specified. All specified values will
be compared to the attribute when the activation status is read
from the resource (get operation). The value that matches will determine
the activation state. But only the first value will be used when
storing the activation state to the resource (add or modify operations).
All other values will be ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ignoreAttribute" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
Flag that controls whether the original attribute should be ignored.
If set to true (or not present at all) the original attribute used as a source of
simulated capability is marked as "ignored" in the schema. If set to false then
the original attribute is still present in its original form in the schema.
This option is meaningful only for simulated enable/disable, i.e. in case that the
"attribute" element above is set.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="ActivationValidityCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to provide activation validity dates (validFrom, validTo)
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="returnedByDefault" type="xsd:boolean" minOccurs="0" default="true"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="ActivationLockoutStatusCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to provide lockout status (e.g. account temporarily disabled due to many failed login attempts).
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="returnedByDefault" type="xsd:boolean" minOccurs="0" default="true"/>
<xsd:element name="attribute" type="xsd:QName" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Name of the attribute to use for account lockout status.
This is a configuration of simulated lockout capability.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="normalValue" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Value to set to the attribute when the account is in a normal state (not locked out).
This is a configuration of simulated lockout capability.
More than one value can be specified. All specified values will
be compared to the attribute when the activation status is read
from the resource (get operation). The value that matches will determine
the activation state. But only the first value will be used when
storing the lockout state to the resource (add or modify operations).
All other values will be ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="lockedValue" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Value to set to the attribute when the account is locked out.
This is a configuration of simulated lockout capability.
More than one value can be specified. All specified values will
be compared to the attribute when the activation status is read
from the resource (get operation). The value that matches will determine
the lockout state. But only the first value will be used when
storing the activation state to the resource (add or modify operations).
All other values will be ignored.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ignoreAttribute" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
Flag that controls whether the original attribute should be ignored.
If set to true (or not present at all) the original attribute used as a source of
simulated capability is marked as "ignored" in the schema. If set to false then
the original attribute is still present in its original form in the schema.
This option is meaningful only for simulated enable/disable, i.e. in case that the
"attribute" element above is set.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="CredentialsCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to present credentials in a structured way.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="password" type="tns:PasswordCapabilityType" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="credentials" type="tns:CredentialsCapabilityType"/>
<xsd:complexType name="PasswordCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to present password in a structured way.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="returnedByDefault" type="xsd:boolean" minOccurs="0" default="true"/>
<xsd:element name="readable" type="xsd:boolean" minOccurs="0" default="false"/>
<!-- TODO: password expiration -->
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="LiveSyncCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to detect changes in almost real time (live synchronization).
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="preciseTokenValue" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If true then the connector ensures that the token value provided in each sync delta
is precise enough to guarantee correct restart of live sync after given delta.
(Some connectors provide token value of e.g. current timestamp, so they cannot distinguish
individual deltas. Others provide correct token values but do not guarantee correct ordering
of these deltas.)
EXPERIMENTAL
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="liveSync" type="tns:LiveSyncCapabilityType"/>
<xsd:complexType name="AsyncUpdateCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to process asynchronous updates. Note that this is currently supported only
by the built-in AsyncUpdateConnector.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="asyncUpdate" type="tns:AsyncUpdateCapabilityType"/>
<xsd:complexType name="AbstractWriteCapabilityType" abstract="true">
<xsd:annotation>
<xsd:documentation>
Base type for all write capabilities.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="manual" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
If set to true then there is NO online connection to the resource.
The operations are executed manually by a human operator. The resource
provides ability to execute the operations in an asynchronous way. But
this asynchronous operation contains a human in the loop.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="CreateCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes create capability.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:AbstractWriteCapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="create" type="tns:CreateCapabilityType"/>
<xsd:complexType name="ReadCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes read capability.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="cachingOnly" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
If set to true then the resource does NOT have native read capability.
However, the resource suggests that the native read capability has to be
approximated by the use of midPoint caching.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="returnDefaultAttributesOption" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If set to true then the resource supports "return default attributes" option
when specifying the list of attributes to return.
</xsd:documentation>
<xsd:appinfo>
<a:since>3.9</a:since>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="read" type="tns:ReadCapabilityType"/>
<xsd:complexType name="UpdateCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes update capability.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:AbstractWriteCapabilityType">
<xsd:sequence>
<xsd:element name="delta" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
<p>
If set to true then resource supports update operation that takes complete delta as an
argument. Or in other words: the resource can execute complex updates
that add/remove/replace values of several attributes in one operation.
</p>
<p>
If set to false then resource cannot execute complex updates in one
operation. Several operations may be needed, e.g. one operation to
add values, separate operation to delete values. This may cause
schema violations. E.g. deleting last value of a mandatory multi-valued
attribute just to immediately add new value. Such operation may fail.
</p>
</xsd:documentation>
<xsd:appinfo>
<a:since>3.9</a:since>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element name="addRemoveAttributeValues" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<p>
If set to true then resource supports update operation that can add
and remove individual attribute values.
</p>
<p>
This is an replacement for deprecated AddRemoveAttributeValuesCapabilityType.
If no value is provided for this element, then the presence or non-presence
of AddRemoveAttributeValuesCapabilityType determines its value.
</p>
</xsd:documentation>
<xsd:appinfo>
<a:since>4.0</a:since>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element name="attributeContentRequirement" type="tns:AttributeContentRequirementType" minOccurs="0" default="none">
<xsd:annotation>
<xsd:documentation>
<p>
Specifies requirement on attribute values that should be passed to an operation.
E.g. whether only changed attributes should be passed to update operation
or whether all the values should be passed.
</p>
</xsd:documentation>
<xsd:appinfo>
<a:since>4.1</a:since>
<a:experimental>true</a:experimental>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="update" type="tns:UpdateCapabilityType"/>
<xsd:simpleType name="AttributeContentRequirementType">
<xsd:annotation>
<xsd:documentation>
Specifies requirement on attribute values that should be passed to an operation.
E.g. whether only changed attributes should be passed to update operation
or whether all the values should be passed.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumClass/>
</xsd:appinfo>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="none">
<xsd:annotation>
<xsd:documentation>
There is no special requirement for attribute content. E.g. only the changed attributes
should be passed into the update operation.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="NONE"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
<!-- Later:
available - values that are currently available (without significant overhead).
identifiers - all the identifiers should be passed (primary, secondary, ...)
-->
<xsd:enumeration value="all">
<xsd:annotation>
<xsd:documentation>
The connector requires all the attributes of all attributes to be able to execute the operation.
MidPoint should take all necessary steps to retrieve needed to retrieve the values, even if that
means additional overhead.
E.g. update operation needs values for all attributes to be passed as "fake" modifications for
the connector to operate correctly.
All modification deltas will be replace deltas. Multi-value attribute deltas will contain all the values,
both all and new in a replace delta.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="ALL"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="DeleteCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes delete capability.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:AbstractWriteCapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="delete" type="tns:DeleteCapabilityType"/>
<xsd:complexType name="TestConnectionCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to test connection to the resource once the connector is configured.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="testConnection" type="tns:TestConnectionCapabilityType"/>
<xsd:complexType name="ScriptCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to execute scripts (short pieces of program) on the connector or resource.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="host" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="type" type="c:ProvisioningScriptHostType"/>
<xsd:element name="language" type="xsd:anyURI" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Specifies the script language(s) supported on this host.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="script" type="tns:ScriptCapabilityType"/>
<xsd:complexType name="PagedSearchCapabilityType">
<xsd:annotation>
<xsd:documentation>
How to handle paged searches.
Although deals primarily with GUI issues, may be useful for other kinds of access as well.
If not present, paged searches are not enabled for this resource/kind/intent/objectClass.
EXPERIMENTAL.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="defaultSortField" type="xsd:QName" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If no sorting is specified by client (higher levels), use this field as the default.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="defaultSortDirection" type="q:OrderDirectionType" minOccurs="0" >
<xsd:annotation>
<xsd:documentation>
If the defaultSortField is used, this element specified the sorting order
(ascending is the default).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="pagedSearch" type="tns:PagedSearchCapabilityType"/>
<xsd:complexType name="CountObjectsCapabilityType">
<xsd:annotation>
<xsd:documentation>
Ability to efficiently count objects.
Although deals primarily with GUI issues, may be useful for other kinds of access as well.
EXPERIMENTAL.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<xsd:element name="simulate" type="tns:CountObjectsSimulateType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Strategy to simulate count operation using a different operation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="countObjects" type="tns:CountObjectsCapabilityType"/>
<xsd:simpleType name="CountObjectsSimulateType">
<xsd:annotation>
<xsd:documentation>
Strategy to simulate count operation using a different operation.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumClass/>
</xsd:appinfo>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="pagedSearchEstimate">
<xsd:annotation>
<xsd:documentation>
Try a paged search with the page of one. Use the approximate number of entries
returned in search metadata as count approximation.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="PAGED_SEARCH_ESTIMATE"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="sequentialSearch">
<xsd:annotation>
<xsd:documentation>
Execute the actual search and sequentially count the entries.
WARNING: this may be very inefficient.
</xsd:documentation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="SEQUENTIAL_SEARCH"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="AddRemoveAttributeValuesCapabilityType">
<xsd:annotation>
<xsd:documentation>
Indication that ADD and REMOVE of attribute values is reliably supported.
If this capability is not present or disabled, READ+REPLACE mode is assumed.
(Can be overridden at the level of individual attributes via readReplaceMode property.)
BEWARE: READ+REPLACE is currently supported for attributes only - not for subjectToObject associations.
DEPRECATED: Use addRemoveAttributeValues element of Update capability instead.
</xsd:documentation>
<xsd:appinfo>
<a:deprecated>true</a:deprecated>
</xsd:appinfo>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="addRemoveAttributeValues" type="tns:AddRemoveAttributeValuesCapabilityType"/>
<xsd:complexType name="AuxiliaryObjectClassesCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to specify additional (auxiliary) object classes in addition to the
primary object class.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="auxiliaryObjectClasses" type="tns:AuxiliaryObjectClassesCapabilityType"/>
<xsd:complexType name="RunAsCapabilityType">
<xsd:annotation>
<xsd:documentation>
Describes capability to execute operations with specified identity.
</xsd:documentation>
<xsd:appinfo>
<a:since>3.9</a:since>
</xsd:appinfo>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="tns:CapabilityType">
<xsd:sequence>
<!-- TODO: settings whether authentication is required or whether this is just user switch (proxy) -->
<!-- TODO: if authentication is required then what credentials are needed? -->
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="runAs" type="tns:RunAsCapabilityType"/>
</xsd:schema>