OASIS/ebXML Registry Services Specification v2.0
March 2016
1
OASIS/ebXML Registry Services Specification v2.3
–Committee Working Draft
OASIS/ebXML Registry Technical Committee
March 2016
Copyright © OASIS, 2002. All Rights Reserved
OASIS/ebXML Registry Services Specification v2.0
2
March 2016
This page intentionally left blank.
Copyright © OASIS, 2002. All Rights Reserved
Page 2 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3
1 Status of this Document
4
This document is an OASIS Registry Technical Committee Working Draft - September 2002.
5
Distribution of this document is unlimited.
6
The document formatting is based on the Internet Society’s Standard RFC format.
7
8
9
10
11
12
13
14
15
This version:
http://www.oasis-open.org/committees/regrep/documents/2.3/specs/ebrs.pdf
Latest Technical Committee Approved version:
http://www.oasis-open.org/committees/regrep/documents/2.3/specs/ebrs.pdf
Latest OASIS Approved Standard:
http://www.oasis-open.org/committees/regrep/documents/2.0/specs/ebrs.pdf
Copyright © OASIS, 2002. All Rights Reserved
Page 3 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
16
2 OASIS/ebXML Registry Technical Committee
17
18
This is an OASIS/ebXML Registry Technical Committee draft document. The following
persons are members of the OASIS/ebXML Registry Technical Committee:
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Zachary Alexander, Individual Member
John Bekisz, Software AG, Inc.
Kathryn Breininger, Boeing
Lisa Carnahan, NIST
Joseph M. Chiusano, LMI
Suresh Damodaran, Sterling Commerce
Fred Federlein, Sun Microsystems
Sally Fuger, Individual Member
Michael Kass, NIST
Kyu-Chul Lee, Individual Member
Matthew MacKenzie, XML Global
Komal Mangtani, BEA Systems
Monica Martin, Drake Certivo, Inc.
Farrukh Najmi, Sun Microsystems
Sanjay Patil, IONA
Nikola Stojanovic, Individual Member
Scott Zimmerman, Storagepoint
36
Contributors
37
38
The following persons contributed to the content of this document, but were not a voting member
of the OASIS/ebXML Registry Technical Committee.
39
40
41
Anne Fischer, Individual
Len Gallagher, NIST
Sekhar Vajjhala, Sun Microsystems
42
Copyright © OASIS, 2002. All Rights Reserved
Page 4 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
43
Table of Contents
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
1
Status of this Document ........................................................................................................ 3
2
OASIS/ebXML Registry Technical Committee ................................................................. 4
Table of Contents .......................................................................................................................... 5
Table of Figures........................................................................................................................... 11
Table of Tables ............................................................................................................................ 13
3
Introduction ......................................................................................................................... 14
3.1 Summary of Contents of Document ................................................................14
3.2 General Conventions ........................................................................................14
3.3 Audience ..........................................................................................................14
4
Design Objectives ................................................................................................................ 15
4.1 Goals ................................................................................................................15
4.2 Caveats and Assumptions ................................................................................15
5
System Overview ................................................................................................................. 16
5.1 What The ebXML Registry Does ....................................................................16
5.2 How The ebXML Registry Works ...................................................................16
5.2.1 Schema Documents Are Submitted .....................................................16
5.2.2 Business Process Documents Are Submitted ......................................16
5.2.3 Seller’s Collaboration Protocol Profile Is Submitted...........................16
5.2.4 Buyer Discovers The Seller .................................................................16
5.2.5 CPA Is Established ..............................................................................17
5.3 Registry Users ..................................................................................................17
5.4 Where the Registry Services May Be Implemented ........................................18
5.5 Implementation Conformance .........................................................................18
5.5.1 Conformance as an ebXML Registry ..................................................18
5.5.2 Conformance as an ebXML Registry Client ........................................19
6
ebXML Registry Architecture ........................................................................................... 20
6.1 Registry Service Described ..............................................................................20
6.2 Abstract Registry Service ................................................................................21
6.2.1 LifeCycleManager Interface ................................................................21
6.2.2 QueryManager Interface ......................................................................22
6.3 Concrete Registry Services ..............................................................................22
6.4 SOAP Binding .................................................................................................23
6.4.1 WSDL Terminology Primer ................................................................23
6.4.2 Concrete Binding for SOAP ................................................................24
6.5 ebXML Message Service Binding ...................................................................24
6.5.1 Service and Action Elements ...............................................................24
6.5.2 Synchronous and Asynchronous Responses ........................................24
6.5.3 ebXML Registry Collaboration Profiles and Agreements ...................25
6.6 REST Binding ..................................................................................................25
6.6.1 Standard URI Parameters .....................................................................26
6.6.2 QueryManager REST Interface ...........................................................26
6.6.3 LifeCycleManager REST Interface .....................................................28
6.6.4 Security Considerations .......................................................................30
6.6.5 Exception Handling .............................................................................30
6.7 Registry Clients ................................................................................................30
Copyright © OASIS, 2002. All Rights Reserved
Page 5 of 167
OASIS/ebXML Registry Services Specification v2.0
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
7
8
March 2016
6.7.1 Registry Client Described ....................................................................30
6.7.2 Registry Communication Bootstrapping..............................................31
6.7.3 RegistryClient Interface .......................................................................32
6.7.4 Registry Response ................................................................................32
6.8 Interoperability Requirements .........................................................................33
6.8.1 Client Interoperability ..........................................................................33
Lifecycle Management Service .......................................................................................... 34
7.1 Lifecycle of a RegistryObject ..........................................................................34
7.2 RegistryObject Attributes ................................................................................34
7.3 The Submit Objects Protocol ...........................................................................35
7.3.1 SubmitObjectsRequest .........................................................................35
7.3.2 RegistryResponse .................................................................................36
7.3.3 Universally Unique ID Generation ......................................................37
7.3.4 ID Attribute And Object References ....................................................37
7.3.5 Audit Trail ............................................................................................38
7.3.6 Error Handling .....................................................................................38
7.3.7 Sample SubmitObjectsRequest ............................................................38
7.4 The Update Objects Protocol ...........................................................................41
7.4.1 Audit Trail ............................................................................................42
7.5 The Add Slots Protocol ....................................................................................42
7.5.1 AddSlotsRequest ..................................................................................43
7.6 The Remove Slots Protocol .............................................................................44
7.6.1 RemoveSlotsRequest ...........................................................................44
7.7 The Approve Objects Protocol.........................................................................45
7.7.1 ApproveObjectsRequest ......................................................................46
7.7.2 Audit Trail ............................................................................................47
7.8 The Deprecate Objects Protocol ......................................................................47
7.8.1 DeprecateObjectsRequest ....................................................................47
7.8.2 Audit Trail ............................................................................................48
7.9 The Remove Objects Protocol .........................................................................48
7.9.1 RemoveObjectsRequest .......................................................................49
Query Management Service ............................................................................................... 51
8.1 Ad Hoc Query Request/Response ....................................................................51
8.1.1 AdhocQueryRequest ............................................................................52
8.1.2 AdhocQueryResponse..........................................................................53
8.1.3 ReponseOption .....................................................................................54
8.1.4 Iterative Query Support........................................................................55
8.2 Filter Query Support ........................................................................................56
8.2.1 FilterQuery ...........................................................................................58
8.2.2 RegistryObjectQuery ...........................................................................59
8.2.3 RegistryEntryQuery .............................................................................72
8.2.4 AssociationQuery.................................................................................75
8.2.5 AuditableEventQuery ..........................................................................77
8.2.6 ClassificationQuery..............................................................................80
8.2.7 ClassificationNodeQuery .....................................................................82
8.2.8 ClassificationSchemeQuery .................................................................87
8.2.9 RegistryPackageQuery .........................................................................88
8.2.10 ExtrinsicObjectQuery ..........................................................................90
Copyright © OASIS, 2002. All Rights Reserved
Page 6 of 167
OASIS/ebXML Registry Services Specification v2.0
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
9
10
March 2016
8.2.11 OrganizationQuery...............................................................................91
8.2.12 ServiceQuery........................................................................................95
8.2.13 Registry Filters .....................................................................................97
8.2.14 XML Clause Constraint Representation ............................................101
8.3 SQL Query Support .......................................................................................105
8.3.1 SQL Query Syntax Binding To [ebRIM]...........................................106
8.3.2 Semantic Constraints On Query Syntax ............................................107
8.3.3 SQL Query Results ............................................................................107
8.3.4 Simple Metadata Based Queries ........................................................108
8.3.5 RegistryObject Queries ......................................................................108
8.3.6 RegistryEntry Queries ........................................................................108
8.3.7 Classification Queries ........................................................................109
8.3.8 Association Queries ...........................................................................110
8.3.9 Package Queries .................................................................................110
8.3.10 ExternalLink Queries .........................................................................111
8.3.11 Audit Trail Queries ............................................................................111
8.4 Content Retrieval ...........................................................................................111
8.4.1 Identification Of Content Payloads ....................................................111
8.4.2 GetContentResponse Message Structure ...........................................112
Content Management Services ........................................................................................ 114
9.1 Content Cataloging: Use Cases ......................................................................114
9.1.1 Find All CPPs Where Role is “Buyer” ..............................................114
9.1.2 Find All XML Schema’s That Use Specified Namespace.................114
9.1.3 Find All WSDL Descriptions with a SOAP Binding.........................114
9.2 Content Cataloguing Service .........................................................................114
9.2.1 Illustrative Example ...........................................................................115
9.3 Catalog Definition File ..................................................................................116
9.4 Content To Be Cataloged ...............................................................................116
9.5 Catalog Metadata ...........................................................................................117
9.6 Content Cataloguing Protocol ........................................................................117
9.6.1 CatalogContentRequest......................................................................117
9.6.2 CatalogContentResponse ...................................................................118
9.7 Publishing a Content Cataloguing Service ....................................................119
9.7.1 Multiple Cataloging Services and Catalog Definition Files ..............120
9.7.2 Restrictions On Publishing Content Cataloguing Services ................121
9.8 Dynamic Content Cataloguing .......................................................................121
9.8.1 Referential Integrity and Dynamic Content Cataloguing ..................121
9.8.2 Error Handling Model for Dynamic Content Cataloguing ................121
9.8.3 Updates and Dynamic Content Cataloguing ......................................122
9.8.4 Resolution Algorithm For Cataloging Service and Catalog Definition File
122
9.9 Dynamic Content-based Discovery ...............................................................122
9.10 Default XML Content Cataloging Service ....................................................123
9.10.1 Publishing of Default XML Content Cataloging Service ..................123
9.11 Canonical Catalog Definition Files ................................................................123
Event Notification ................................................................................................... 124
10.1 Use Cases .......................................................................................................124
10.1.1 New Service is Offered ......................................................................124
Copyright © OASIS, 2002. All Rights Reserved
Page 7 of 167
OASIS/ebXML Registry Services Specification v2.0
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
10.2
10.3
10.4
10.5
10.6
10.7
11
11.1
11.2
11.3
11.4
March 2016
10.1.2 Monitor Download of Content ...........................................................124
10.1.3 Monitor Price Changes ......................................................................124
10.1.4 Keep Replicas Consistent With Source Object ..................................124
Registry Events ..............................................................................................124
Subscribing to Events ....................................................................................125
10.3.1 Event Selection ..................................................................................125
10.3.2 Notification Action ............................................................................125
10.3.3 Subscription Authorization ................................................................125
10.3.4 Subscription Quotas ...........................................................................125
10.3.5 Subscription Expiration .....................................................................126
Unsubscribing from Events............................................................................126
Notification of Events ....................................................................................126
Retrieval of Events .........................................................................................126
10.6.1 GetNotificationsRequest ....................................................................126
10.6.2 GetNotificationsResponse..................................................................127
Purging of Events ...........................................................................................127
Cooperating Registries Support ............................................................................ 128
Cooperating Registries Use Cases .................................................................128
11.1.1 Inter-registry Object References ........................................................128
11.1.2 Federated Queries ..............................................................................128
11.1.3 Local Caching of Data from Another Registry ..................................128
11.1.4 Object Relocation...............................................................................129
Registry Federations ......................................................................................129
11.2.1 Federation Metadata...........................................................................129
11.2.2 Local Vs. Federated Queries ..............................................................130
11.2.3 Federated Lifecycle Management Operations ...................................131
11.2.4 Federations and Local Caching of Remote Data ...............................131
11.2.5 Caching of Federation Metadata ........................................................131
11.2.6 Time Synchronization Between Registry Peers .................................131
11.2.7 Federations and Security ....................................................................132
11.2.8 Federation Lifecycle Management Protocols ....................................132
Object Replication .........................................................................................133
11.3.1 Use Cases for Object Replication ......................................................133
11.3.2 Queries And Replicas ........................................................................134
11.3.3 Lifecycle Operations And Replicas ...................................................134
11.3.4 Object Replication and Federated Registries .....................................134
11.3.5 Creating a Local Replica ....................................................................134
11.3.6 Transactional Replication ..................................................................134
11.3.7 Keeping Replicas Current ..................................................................135
11.3.8 Write Operations on Local Replica....................................................135
11.3.9 Tracking Location of a Replica..........................................................135
11.3.10 Remote Object References to a Replica.........................................135
11.3.11 Removing a Local Replica .............................................................135
Object Relocation Protocol ............................................................................135
11.4.1 RelocateObjectsRequest ....................................................................138
11.4.2 AcceptObjectsRequest .......................................................................139
11.4.3 Object Relocation and Remote ObjectRefs .......................................139
11.4.4 Notification of Object Relocation ......................................................140
Copyright © OASIS, 2002. All Rights Reserved
Page 8 of 167
OASIS/ebXML Registry Services Specification v2.0
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
March 2016
11.4.5 Object Relocation and Timeouts ........................................................140
12
Registry Security ..................................................................................................... 141
12.1 Security Concerns ..........................................................................................141
12.2 Integrity of Registry Content .........................................................................141
12.2.1 Message Payload Signature ...............................................................141
12.2.2 Payload Signature Requirements .......................................................142
12.3 Authentication ................................................................................................143
12.3.1 Message Header Signature .................................................................144
12.4 Key Distribution and KeyInfo Element .........................................................145
12.5 Confidentiality ...............................................................................................146
12.5.1 On-the-wire Message Confidentiality ................................................146
12.5.2 Confidentiality of Registry Content ...................................................146
12.6 Authorization .................................................................................................146
12.7 Access Control ...............................................................................................146
12.7.1 Default Permission .............................................................................147
12.7.2 Actors / Role Mapping .......................................................................147
12.7.3 Default Access Control Policy ...........................................................147
12.7.4 Custom Access Control Policies ........................................................148
Appendix A
Web Service Architecture .......................................................................... 149
A.1 Registry Service Abstract Specification ........................................................149
A.2 Registry Service SOAP Binding ....................................................................149
Appendix B
ebXML Registry Schema Definitions ........................................................ 150
B.1 RIM Schema ..................................................................................................150
B.2 Query Schema ................................................................................................150
B.3 Registry Services Interface Schema...............................................................150
B.4 Examples of Instance Documents ..................................................................150
Appendix C
Interpretation of UML Diagrams .............................................................. 151
C.1 UML Class Diagram ......................................................................................151
C.2 UML Sequence Diagram ...............................................................................151
Appendix D
SQL Query................................................................................................... 152
D.1 SQL Query Syntax Specification ...................................................................152
D.2 Non-Normative BNF for Query Syntax Grammar ........................................152
D.3 Relational Schema For SQL Queries .............................................................153
Appendix E
Security Implementation Guideline .......................................................... 155
E.1 Security Concerns ..........................................................................................155
E.2 Authentication ................................................................................................156
E.3 Authorization .................................................................................................156
E.4 Registry Bootstrap .........................................................................................156
E.5 Content Submission – Client Responsibility .................................................156
E.6 Content Submission – Registry Responsibility .............................................156
E.7 Content Remove/Deprecate – Client Responsibility .....................................157
E.8 Content Remove/Deprecate – Registry Responsibility..................................157
E.9 Using ds:KeyInfo Field ..................................................................................157
Appendix F
Native Language Support (NLS) ............................................................... 159
F.1 Definitions......................................................................................................159
F.1.1 Coded Character Set (CCS): ..............................................................159
F.1.2 Character Encoding Scheme (CES): ..................................................159
Copyright © OASIS, 2002. All Rights Reserved
Page 9 of 167
OASIS/ebXML Registry Services Specification v2.0
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
March 2016
F.1.3 Character Set (charset):......................................................................159
F.2 NLS And Request / Response Messages .......................................................159
F.3 NLS And Storing of RegistryObject ..............................................................159
F.3.1 Character Set of LocalizedString .......................................................160
F.3.2 Language Information of LocalizedString .........................................160
F.4 NLS And Storing of Repository Items...........................................................160
F.4.1 Character Set of Repository Items .....................................................160
F.4.2 Language information of repository item ..........................................160
Appendix G
Registry Profile............................................................................................ 161
13
References ................................................................................................................ 162
14
Disclaimer ................................................................................................................ 164
15
Contact Information ............................................................................................... 165
16
Copyright Statement ............................................................................................... 166
17
Notes ......................................................................................................................... 167
Copyright © OASIS, 2002. All Rights Reserved
Page 10 of 167
OASIS/ebXML Registry Services Specification v2.0
295
Table of Figures
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







































March 2016
Figure 1: Actor Relationships ................................................................................................ 18
Figure 2: ebXML Registry Service Architecture ................................................................... 20
Figure 3: The Abstract ebXML Registry Service .................................................................. 21
Figure 4: A Concrete ebXML Registry Service ..................................................................... 23
Figure 5: Registry Architecture Supports Flexible Topologies ............................................. 31
Figure 6: Lifecycle of a RegistryObject ................................................................................. 34
Figure 7: Submit Objects Sequence Diagram ........................................................................ 35
Figure 8: SubmitObjectsRequest Syntax................................................................................ 35
Figure 9: RegistryResponse Syntax ....................................................................................... 37
Figure 10: Update Objects Sequence Diagram ...................................................................... 42
Figure 11: Add Slots Sequence Diagram ............................................................................... 43
Figure 12: AddSlotsRequest Syntax ...................................................................................... 43
Figure 13: Remove Slots Sequence Diagram ......................................................................... 44
Figure 14: RemoveSlotsRequest Syntax ................................................................................ 45
Figure 15: Approve Objects Sequence Diagram .................................................................... 46
Figure 16: ApproveObjectsRequest Syntax ........................................................................... 46
Figure 17: Deprecate Objects Sequence Diagram.................................................................. 47
Figure 18: DeprecateObjectsRequest Syntax ......................................................................... 48
Figure 19: Remove Objects Sequence Diagram .................................................................... 49
Figure 20: RemovalObjectsRequest Syntax ........................................................................... 49
Figure 21: Submit Ad Hoc Query Sequence Diagram ........................................................... 52
Figure 22: AdhocQueryRequest Syntax Update picture to show it inherits from
RegistryRequest?? .................................................................................................................. 52
Figure 23: AdhocQueryResponse Syntax Update picture to show it inherits from
RegistryResponse?? ............................................................................................................... 53
Figure 24: ResponseOption Syntax ........................................................................................ 54
Figure 25: Example ebRIM Binding ...................................................................................... 57
Figure 26: ebRIM Binding for RegistryObjectQuery ............................................................ 60
Figure 27: ebRIM Binding for RegistryEntryQuery .............................................................. 72
Figure 28: ebRIM Binding for AssociationQuery ................................................................. 75
Figure 29: ebRIM Binding for AuditableEventQuery ........................................................... 77
Figure 30: ebRIM Binding for ClassificationQuery .............................................................. 80
Figure 31: ebRIM Binding for ClassificationNodeQuery ...................................................... 82
Figure 32: ebRIM Binding for ClassificationSchemeQuery .................................................. 87
Figure 33: ebRIM Binding for RegistryPackageQuery ......................................................... 88
Figure 34: ebRIM Binding for ExtrinsicObjectQuery ........................................................... 90
Figure 35: ebRIM Binding for OrganizationQuery ............................................................... 92
Figure 36: ebRIM Binding for ServiceQuery ........................................................................ 96
Figure 37: The Clause Structure........................................................................................... 101
Figure 38: Abstract Content Cataloguing Service: Inputs and Outputs ............................... 115
Figure 39: Example of CPP cataloguing using Default XML Cataloging Service .............. 116
Copyright © OASIS, 2002. All Rights Reserved
Page 11 of 167
OASIS/ebXML Registry Services Specification v2.0
337
338
339
340
341
342
343
344
345
346
347
348
349
350
March 2016
 Figure 40: Content Cataloging Protocol .............................................................................. 117
 Figure 41: CatalogContentRequest Syntax .......................................................................... 118
 Figure 42: CatalogContentResponse Syntax ........................................................................ 119
 Figure 43: Cataloguing Service Configuration .................................................................... 120
 Figure 44: GetNotificationsRequest Syntax ......................................................................... 126
 Figure 45: GetNotificationsResponse Syntax ...................................................................... 127
 Figure 46: Inter-registry Object References ......................................................................... 128
 Figure 47: Registry Federations ........................................................................................... 129
 Figure 48: Federation Metadata Example ............................................................................ 130
 Figure 49: Object Replication .............................................................................................. 133
Figure 50: Object Relocation ...................................................................................................... 136
 Figure 51: Relocate Objects Protocol................................................................................... 137
 Figure 52: RelocateObjectsRequest XML Schema .............................................................. 138
Copyright © OASIS, 2002. All Rights Reserved
Page 12 of 167
OASIS/ebXML Registry Services Specification v2.0
351
Table of Tables
352
353
354
355
356
357
358
359
360
361
362
363











March 2016
Table 1: Registry Users .......................................................................................................... 17
Table 2: LifeCycle Manager Summary .................................................................................. 21
Table 3: Query Manager ........................................................................................................ 22
Table 4: Standard URI Parameters ......................................................................................... 26
Table 5: QueryManager REST Interface ............................................................................... 27
Table 6: LifeCycleManager REST Interface ......................................................................... 29
Table 7: RegistryClient Summary .......................................................................................... 32
Table 8: Path Filter Expressions for Use Cases ..................................................................... 85
Table 10: Role to Permissions Mapping .............................................................................. 147
147
Table 12: Default Actor to Role Mappings .......................................................................... 147
Copyright © OASIS, 2002. All Rights Reserved
Page 13 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
364
3 Introduction
365
3.1 Summary of Contents of Document
366
367
This document defines the interface to the ebXML Registry Services as well as interaction
protocols, message definitions and XML schema.
368
369
370
A separate document, ebXML Registry Information Model [ebRIM], provides information on
the types of metadata that are stored in the Registry as well as the relationships among the
various metadata classes.
371
3.2 General Conventions
372
The following conventions are used throughout this document:
373
374
UML diagrams are used as a way to concisely describe concepts. They are not intended to
convey any specific Implementation or methodology requirements.
375
376
377
The term “repository item” is used to refer to an object (e.g., an XML document or a DTD) that
resides in a repository for storage and safekeeping. Each repository item is described by a
RegistryObject instance. The RegistryObject catalogs the RepositoryItem with metadata.
378
379
380
381
382
The term "RegistryEntry" is used to refer to an object that provides metadata about a repository
item.
The keywords MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD
NOT, RECOMMENDED, MAY, and OPTIONAL, when they appear in this document, are to be
interpreted as described in RFC 2119 [Bra97].
383
384
Software practitioners MAY use this document in combination with other ebXML specification
documents when creating ebXML compliant software.
385
3.3 Audience
386
387
388
The target audience for this specification is the community of software developers who are:
 Implementers of ebXML Registry Services
 Implementers of ebXML Registry Clients
389
Related Documents
390
391
392
393
394
The following specifications provide some background and related information to the reader:
a) ebXML Registry Information Model [ebRIM]
b) ebXML Message Service Specification [ebMS]
c) ebXML Business Process Specification Schema [ebBPSS]
d) ebXML Collaboration-Protocol Profile and Agreement Specification [ebCPP]
Copyright © OASIS, 2002. All Rights Reserved
Page 14 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
395
4 Design Objectives
396
4.1 Goals
397
398
399
400
401
The goals of this version of the specification are to:
 Communicate functionality of Registry services to software developers
 Specify the interface for Registry clients and the Registry
 Provide a basis for future support of more complete ebXML Registry requirements
 Be compatible with other ebXML specifications
402
4.2 Caveats and Assumptions
403
404
405
This version of the Registry Services Specification is the second in a series of phased
deliverables. Later versions of the document will include additional capability as deemed
appropriate by the OASIS/ebXML Registry Technical Committee. It is assumed that:
406
407
408
409
410
411
412
Interoperability requirements dictate that at least one of the normative interfaces as referenced in
this specification must be supported.
1. All access to the Registry content is exposed via the interfaces defined for the Registry
Services.
2. The Registry makes use of a Repository for storing and retrieving persistent information
required by the Registry Services. This is an implementation detail that will not be
discussed further in this specification.
Copyright © OASIS, 2002. All Rights Reserved
Page 15 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
413
5 System Overview
414
5.1 What The ebXML Registry Does
415
416
417
418
The ebXML Registry provides a set of services that enable sharing of information between
interested parties for the purpose of enabling business process integration between such parties
based on the ebXML specifications. The shared information is maintained as objects in a
repository and managed by the ebXML Registry Services defined in this document.
419
5.2 How The ebXML Registry Works
420
421
422
This section describes at a high level some use cases illustrating how Registry clients may make
use of Registry Services to conduct B2B exchanges. It is meant to be illustrative and not
prescriptive.
423
424
425
426
427
428
The following scenario provides a high level textual example of those use cases in terms of
interaction between Registry clients and the Registry. It is not a complete listing of the use cases
that could be envisioned. It assumes for purposes of example, a buyer and a seller who wish to
conduct B2B exchanges using the RosettaNet PIP3A4 Purchase Order business protocol. It is
assumed that both buyer and seller use the same Registry service provided by a third party. Note
that the architecture supports other possibilities (e.g. each party uses its own private Registry).
429
5.2.1 Schema Documents Are Submitted
430
431
432
A third party such as an industry consortium or standards group submits the necessary schema
documents required by the RosettaNet PIP3A4 Purchase Order business protocol with the
Registry using the LifeCycleManager service of the Registry described in Section 7.3.
433
5.2.2 Business Process Documents Are Submitted
434
435
436
A third party, such as an industry consortium or standards group, submits the necessary business
process documents required by the RosettaNet PIP3A4 Purchase Order business protocol with
the Registry using the LifeCycleManager service of the Registry described in Section 7.3.
437
5.2.3 Seller’s Collaboration Protocol Profile Is Submitted
438
439
440
441
The seller publishes its Collaboration Protocol Profile or CPP as defined by [ebCPP] to the
Registry. The CPP describes the seller, the role it plays, the services it offers and the technical
details on how those services may be accessed. The seller classifies their Collaboration Protocol
Profile using the Registry’s flexible Classification capabilities.
442
5.2.4 Buyer Discovers The Seller
443
444
445
446
The buyer browses the Registry using Classification schemes defined within the Registry using a
Registry Browser GUI tool to discover a suitable seller. For example the buyer may look for all
parties that are in the Automotive Industry, play a seller role, support the RosettaNet PIP3A4
process and sell Car Stereos.
447
The buyer discovers the seller’s CPP and decides to engage in a partnership with the seller.
Copyright © OASIS, 2002. All Rights Reserved
Page 16 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
448
5.2.5 CPA Is Established
449
450
451
452
453
454
The buyer unilaterally creates a Collaboration Protocol Agreement or CPA as defined by
[ebCPP] with the seller using the seller’s CPP and their own CPP as input. The buyer proposes a
trading relationship to the seller using the unilateral CPA. The seller accepts the proposed CPA
and the trading relationship is established.
Once the seller accepts the CPA, the parties may begin to conduct B2B transactions as defined
by [ebMS].
455
5.3 Registry Users
456
457
458
We describe the actors who use the registry below. Some of the actors are defined in Section
12.7. Note that the same entity may represent different actors. For example, a Registration
Authority and Registry Administrator may have the same identity.
 Table 1: Registry Users
459
Actor
Function
ISO/IEC
11179
Comments
RegistrationAuthority
Hosts the RegistryObjects
Registry
Administrator
Evaluates and enforces
registry security policy.
Facilitates definition of the
registry security policy.
MAY have the same
identity as
Registration
Authority
Registered User
Has a contract with the
Registration Authority and
MUST be authenticated by
Registration Authority.
The contract could
be a ebXML CPA or
some other form of
contract.
Registry Guest
Has no contract with
Registration Authority. Does
not have to be authenticated
for Registry access. Cannot
change contents of the
Registry (MAY be permitted
to read some
RegistryObjects.)
A Registered User who does
lifecycle operations on
permitted RegistryObjects.
A Registered User who has
only read access
Creates Registry Objects
Note that a Registry
Guest is not a
Registry Reader.
Submitting
Organization
Registry Reader
Responsible
Organization
Copyright © OASIS, 2002. All Rights Reserved
Registration
Authority (RA)
Submitting
Organization
(SO)
Responsible
Organization
(RO)
RO MAY have the
same identity as SO
Page 17 of 167
OASIS/ebXML Registry Services Specification v2.0
Registry Client
March 2016
Registered User or Registered
Guest
460
461
 Figure 1: Actor Relationships
462
463
Note:
In the current version of the specification the following are true.
464
A Submitting Organization and a Responsible Organization are the same.
465
Registration of a user happens out-of-band, i.e, by means not specified in this specification.
466
A Registry Administrator and Registration Authority are the same.
467
5.4 Where the Registry Services May Be Implemented
468
469
The Registry Services may be implemented in several ways including, as a public web site, as a
private web site, hosted by an ASP or hosted by a VPN provider.
470
5.5 Implementation Conformance
471
472
473
474
475
476
477
An implementation is a conforming ebXML Registry if the implementation meets the conditions
in Section 5.5.1. An implementation is a conforming ebXML Registry Client if the
implementation meets the conditions in Section 5.5.2. An implementation is a conforming
ebXML Registry and a conforming ebXML Registry Client if the implementation conforms to
the conditions of Section 5.5.1 and Section 5.5.2. An implementation shall be a conforming
ebXML Registry, a conforming ebXML Registry Client, or a conforming ebXML Registry and
Registry Client.
478
5.5.1 Conformance as an ebXML Registry
479
480
An implementation conforms to this specification as an ebXML Registry if it meets the
following conditions:
Copyright © OASIS, 2002. All Rights Reserved
Page 18 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
481
1. Conforms to the ebXML Registry Information Model [ebRIM].
482
2. Supports the syntax and semantics of the Registry Interfaces and Security Model.
483
3. Supports the defined ebXML Registry Schema (Appendix B).
484
4. Optionally supports the syntax and semantics of Section 8.3, SQL Query Support.
485
5.5.2 Conformance as an ebXML Registry Client
486
487
An implementation conforms to this specification, as an ebXML Registry Client if it meets the
following conditions:
488
1. Supports the ebXML CPA and bootstrapping process.
489
2. Supports the syntax and the semantics of the Registry Client Interfaces.
490
3. Supports the defined ebXML Error Message DTD.
491
492
4. Supports the defined ebXML Registry Schema (Appendix B).
Copyright © OASIS, 2002. All Rights Reserved
Page 19 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
493
6 ebXML Registry Architecture
494
495
496
The ebXML Registry architecture consists of an ebXML Registry Service and ebXML Registry
Clients. The ebXML Registry Service provides the methods for managing a repository. An
ebXML Registry Client is an application used to access the Registry.
497
498
 Figure 2: ebXML Registry Service Architecture
499
6.1 Registry Service Described
500
501
502
503
504
505
506
The ebXML Registry Service is comprised of a robust set of interfaces designed to
fundamentally manage the objects and inquiries associated with the ebXML Registry. The two
primary interfaces for the Registry Service consist of:
 A Lifecycle Management interface that provides a collection of methods for managing
objects within the Registry.
 A Query Management Interface that controls the discovery and retrieval of information from
the Registry.
507
508
509
A registry client program utilizes the services of the registry by invoking methods on one of the
above interfaces defined by the Registry Service. This specification defines the interfaces
exposed by the Registry Service as well as the interface for the Registry Client.
Copyright © OASIS, 2002. All Rights Reserved
Page 20 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
510
6.2 Abstract Registry Service
511
The architecture defines the ebXML Registry as an abstract registry service that is defined as:
512
1. A set of interfaces that must be supported by the registry.
513
2. The set of methods that must be supported by each interface.
514
3. The parameters and responses that must be supported by each method.
515
516
517
The abstract registry service neither defines any specific implementation for the ebXML
Registry, nor does it specify any specific protocols used by the registry. Such implementation
details are described by concrete registry services that realize the abstract registry service.
518
519
520
The abstract registry service (Figure 3) shows how an abstract ebXML Registry must provide
two key functional interfaces called QueryManager1 (QM) and LifeCycleManager2
(LM).
521
522
 Figure 3: The Abstract ebXML Registry Service
523
524
Appendix A provides hyperlinks to the abstract service definition in the Web Service Description
Language (WSDL) syntax.
525
6.2.1 LifeCycleManager Interface
526
527
528
529
530
This is the interface exposed by the Registry Service that implements the object lifecycle
management functionality of the Registry. Its methods are invoked by the Registry Client. For
example, the client may use this interface to submit objects, to classify and associate objects and
to deprecate and remove objects. For this specification the semantic meaning of submit, classify,
associate, deprecate and remove is found in [ebRIM].
531
 Table 2: LifeCycle Manager Summary
Method Summary of LifeCycleManager
RegistryResponse acceptObjects(AcceptObjectsRequest req)
Accepts one or more objects to a registry during object
relocation.
RegistryResponse approveObjects(ApproveObjectsRequest req)
Approves one or more previously submitted objects.
RegistryResponse deprecateObjects(DeprecateObjectsRequest req)
Deprecates one or more previously submitted objects.
1
Known as ObjectQueryManager in V1.0
2
Known as ObjectManager in V1.0
Copyright © OASIS, 2002. All Rights Reserved
Page 21 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
RegistryResponse removeObjects(RemoveObjectsRequest req)
Removes one or more previously submitted objects from
the Registry.
RegistryResponse submitObjects(SubmitObjectsRequest req)
Submits one or more objects and possibly related
metadata such as Associations and Classifications.
RegistryResponse updateObjects(UpdateObjectsRequest req)
Updates one or more previously submitted objects.
RegistryResponse addSlots(AddSlotsRequest req)
Add slots to one or more registry entries.
RegistryResponse relocateObjects(RelocateObjectsRequest req)
Relocate one or more objects from one registry to
another.
RegistryResponse removeSlots(RemoveSlotsRequest req)
Remove specified slots from one or more registry entries.
532
6.2.2 QueryManager Interface
533
534
535
This is the interface exposed by the Registry that implements the Query management service of
the Registry. Its methods are invoked by the Registry Client. For example, the client may use this
interface to perform browse and drill down queries or ad hoc queries on registry content.
536
 Table 3: Query Manager
Method Summary of QueryManager
GetContentResponse getContent(GetContentRequest req)
Submit an ad hoc query request. This method is being
deprecated and may go away in version 4.
GetNotificationsResponse getNotifications(GetNotificationsRequest req)
Submit a request to get event notifications.
AdhocQueryResponse submitAdhocQuery(AdhocQueryRequest req)
Submit an ad hoc query request.
RegistryObject getRegistryObject(String id)
Submit a request to get the RegistryObject that matches
the specified id.
RepositoryItem getRepositoryItem(String id)
Submit a request to get the repository item that matches
the specified id. This is the same as the id of the
ExtrinsicObject that catalogs this repository item.
537
538
6.3 Concrete Registry Services
539
540
The architecture allows the abstract registry service to be mapped to one or more concrete
registry services defined as:
Copyright © OASIS, 2002. All Rights Reserved
Page 22 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
541
542


543
544
545
546
This specification describes the following concrete bindings for the abstract registry service:
 A SOAP binding using the HTTP protocol
 An ebXML Messaging Service (ebMS) binding
 A REST binding
547
548
549
550
A registry must implement at least one concrete binding between SOAP and ebMS concrete
bindings for the abstract registry service as shown in Figure 4. In addition a registry must
implement the REST binding for the abstract registry service as shown in Figure 4. Need to
update fig 4 and following text to include REST??
Implementations of the interfaces defined by the abstract registry service.
Bindings of these concrete interfaces to specific communication protocols.
551
552
553

 Figure 4: A Concrete ebXML Registry Service
554
555
556
Figure 4 shows a concrete implementation of the abstract ebXML Registry (RegistryService) on
the left side. The RegistryService provides the QueryManager and LifeCycleManager interfaces
available with multiple protocol bindings (SOAP and ebMS).
557
558
559
560
Figure 4 also shows two different clients of the ebXML Registry on the right side. The top client
uses SOAP interface to access the registry while the lower client uses ebMS interface. Clients
use the appropriate concrete interface within the RegistryService service based upon their
protocol preference.
561
6.4 SOAP Binding
562
6.4.1 WSDL Terminology Primer
563
564
565
566
567
568
569
This section provides a brief introduction to Web Service Description Language (WSDL) since
the SOAP binding is described using WSDL syntax. WSDL provides the ability to describe a
web service in abstract as well as with concrete bindings to specific protocols. In WSDL, an
abstract service consists of one or more port types or end-points. Each port type consists
of a collection of operations. Each operation is defined in terms of messages that define
what data is exchanged as part of that operation. Each message is typically defined in terms of
elements within an XML Schema definition.
570
571
572
573
An abstract service is not bound to any specific protocol (e.g. SOAP). In WSDL, an abstract
service may be used to define a concrete service by binding it to a specific protocol. This binding
is done by providing a binding definition for each abstract port type that defines additional
protocols specific details. Finally, a concrete service definition is defined as a collection of
Copyright © OASIS, 2002. All Rights Reserved
Page 23 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
574
ports, where each port simply adds address information such as a URL for each concrete port.
575
6.4.2 Concrete Binding for SOAP
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
This section assumes that the reader is somewhat familiar with SOAP and WSDL. The SOAP
binding to the ebXML Registry is defined as a web service description in WSDL as follows:
 A single service element with name “RegistryService” defines the concrete SOAP binding
for the registry service.
 The service element includes two port definitions, where each port corresponds with one of
the interfaces defined for the abstract registry service. Each port includes an HTTP URL for
accessing that port.
 Each port definition also references a binding element, one for each interface defined in the
WSDL for the abstract registry service.
596
597
The complete WSDL description for the SOAP binding can be obtained via a hyperlink in
Appendix A.
598
6.5 ebXML Message Service Binding
599
6.5.1 Service and Action Elements
600
601
602
603
604
605
606
607
608
609
610
When using the ebXML Messaging Services Specification, ebXML Registry Service elements
correspond to Messaging Service elements as follows:
 The value of the Service element in the MessageHeader is an ebXML Registry Service
interface name (e.g., “LifeCycleManager”). The type attribute of the Service element should
have a value of “ebXMLRegistry”.
 The value of the Action element in the MessageHeader is an ebXML Registry Service
method name (e.g., “submitObjects”).
611
612
613
Note that the above allows the Registry Client only one interface/method pair per message. This
implies that a Registry Client can only invoke one method on a specified interface for a given
request to a registry.
614
6.5.2 Synchronous and Asynchronous Responses
615
All methods on interfaces exposed by the registry return a response message.
<service name = "RegistryService">
<port name = "QueryManagerSOAPBinding" binding = "tns:QueryManagerSOAPBinding">
<soap:address location = "http://your_URL_to_your_QueryManager"/>
</port>
<port name = "LifeCycleManagerSOAPBinding" binding = "tns:LifeCycleManagerSOAPBinding">
<soap:address location = "http://your_URL_to_your_QueryManager"/>
</port>
</service>
<eb:Service eb:type=”ebXMLRegistry”>LifeCycleManger</eb:Service>
<eb:Action>submitObjects</eb:Action>
Copyright © OASIS, 2002. All Rights Reserved
Page 24 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
616
6.5.2.1
617
618
619
620
621
622
When a message is sent asynchronously, the Registry will return two response messages. The
first message will be an immediate response to the request and does not reflect the actual
response for the request. This message will contain:
 MessageHeader
 RegistryResponse element including:
o status attribute with value Unavailable
623
624
625
626
627
628
629
630
The Registry delivers the actual Registry response element with non-empty content
asynchronously at a later time. The delivery is accomplished by the Registry invoking the
onResponse method on the RegistryClient interface as implemented by the registry client
application. The onResponse method includes a RegistryResponse element as shown below:
 MessageHeader
 RegistryResponse element including:
o Status attribute (Success, Failure)
o Optional RegistryErrorList
631
6.5.2.2
632
633
634
635
636
637
When a message is sent synchronously, the Message Service Handler will hold open the
communication mechanism until the Registry returns a response. This message will contain:
 MessageHeader
 RegistryResponse element including:
o Status attribute (Success, Failure)
o Optional RegistryErrorList
638
6.5.3 ebXML Registry Collaboration Profiles and Agreements
639
640
641
642
The ebXML CPP specification [ebCPP] defines a Collaboration-Protocol Profile (CPP) and a
Collaboration-Protocol Agreement (CPA) as mechanisms for two parties to share information
regarding their respective business processes. That specification assumes that a CPA has been
agreed to by both parties in order for them to engage in B2B interactions.
643
644
645
646
This specification does not mandate the use of a CPA between the Registry and the Registry
Client. However if the Registry does not use a CPP, the Registry shall provide an alternate
mechanism for the Registry Client to discover the services and other information provided by a
CPP. This alternate mechanism could be a simple URL.
647
648
649
The CPA between clients and the Registry should describe the interfaces that the Registry and
the client expose to each other for Registry-specific interactions. The definition of the Registry
CPP template and a Registry Client CPP template are beyond the scope of this document.
650
6.6 REST Binding
651
652
653
654
The ebXML Registry abstract interface defines a REST binding that enables access to the
registry over HTTP protocol.
REST [RESTThesis], which stands for Representational State Transfer, is an architectural style
for distributed hypermedia systems. The REST architectural style suggests that:
Asynchronous response
Synchronous response
Copyright © OASIS, 2002. All Rights Reserved
Page 25 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
655
656
657
658
659
660
661
662
663
664
o A service be accessible over HTTP
o All access to the service capabilities and resources are via URIs
REST is more of a concept than a technology or a specification. It is easily implemented using
standard facilities found on a web server or development environment.
The REST binding maps the abstract registry interfaces to a REST styled HTTP interface. It
defines the URI parameters and their usage patterns that must be used to specify the interface,
method and invocation parameters in order to invoke a method on a registry interface such as the
QueryManager interface.
The REST binding also defines the return values that are synchronously sent back to the client as
the HTTP response for the HTTP request.
665
6.6.1 Standard URI Parameters
666
667
668
This section defines the normative URI parameters that must be supported by the REST
Interface. A Registry may implement additional URI parameters in addition to these parameters.
URI Parameter
Name
Required
Description
Example
YES
Defines the interface or object
Example: QueryManager
to call methods on.
method
YES
Defines the method to be
carried out on the given
interface.
Example:
submitAdhocQueryRequest
param-<key>
NO
Defines named parameters to
be passed into a method call.
Example: param-id=888-9998877h
interface
 Table 4: Standard URI Parameters
669
670
671
6.6.2 QueryManager REST Interface
672
673
674
675
676
The REST Interface to QueryManager must be supported by all registries.
The REST Interface to QueryManager defines that the interface parameter must be
"QueryManager". In addition the following method parameters are defined by the QueryManager
REST Interface.
Parameters
Method
getNotifications
Return Value
GetNotificationsRequest GetNotificationsResponse
Id
getRegistryObject
Copyright © OASIS, 2002. All Rights Reserved
HTTP
Request
Type
POST
An instance of a leaf class that
is a concrete sub-class of
GET
RegistryObject that matches the
specified id.
Page 26 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
Parameters
Method
Return Value
Id
getRepositoryItem
submitAdhocQueryRequest
AdhocQueryRequest
RepositoryItem that matches
the specified id. Note that a
RepositoryItem may be
arbitrary content (e.g. a GIF
image).
HTTP
Request
Type
GET
AdhocQueryResponse for the
POST
specified AdhocQueryRequest.
 Table 5: QueryManager REST Interface
677
678
679
680
Note that in the examples that follow name space declarations are omitted to conserve space.
Also note that some lines may be wrapped due to lack of space.
681
6.6.2.1
682
683
684
685
686
The following example shows a getRegistryObject request.
687
6.6.2.2
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
The following example shows an ExtrinsicObject, which is a specialized sub-class of
RegistryObject being returned as a response to the getRegistryObject method invocation.
703
6.6.2.3
704
705
706
707
708
The following example shows a getRepositoryItem request.
Sample getRegistryObject Request
GET /rest?interface=QueryManager&method=getRegistryObject&param-id=
urn:uuid:a1137d00-091a-471e-8680-eb75b27b84b6 HTTP/1.1
Sample getRegistryObject Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
<ExtrinsicObject id = "urn:uuid:a1137d00-091a-471e-8680-eb75b27b84b6"
objectType="urn:uuid:32bbb291-0291-486d-a80d-cdd6cd625c57">
<Name>
<LocalizedString value = "Sample Object"/>
</Name>
</ExtrinsicObject>
Sample getRepositoryItem Request
GET /rest?interface=QueryManager&method=getRepositoryItem&param-id=
urn:uuid:a1137d00-091a-471e-8680-eb75b27b84b6 HTTP/1.1
Copyright © OASIS, 2002. All Rights Reserved
Page 27 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
709
6.6.2.4
710
711
712
713
714
715
716
717
718
719
720
721
The following example assumes that the repository item was a Collaboration Protocol Profile as
defined by [ebCPP].
722
6.6.2.5
723
724
725
726
727
728
729
730
731
732
733
734
735
736
The following example shows how an HTTP POST request is used to invoke the
submitAdhocQueryRequest method of QueryManager.
737
6.6.2.6
738
739
740
741
742
743
744
745
746
747
748
749
The following example shows an AdhocQueryResponse that is returned in response to an
AdhocQueryRequest.
750
6.6.3 LifeCycleManager REST Interface
751
752
753
754
755
The REST Interface to LifeCycleManager may be supported by a registry.
The REST Interface to LifeCycleManager defines that the interface parameter must be
"LifeCycleManager". In addition the following method parameters are defined by the
LifeCycleManager REST Interface.
Sample getRepositoryItem Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
< CollaborationProtocolProfile>
...
</CollaborationProtocolProfile>
Sample submitAdhocQueryRequest Request
POST /rest?interface=QueryManager&method=submitAdhocQueryRequest HTTP/1.1
User-Agent: Foo-ebXML/1.0
Host: www.registryserver.com
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
<AdhocQueryRequest>
...
</AdhocQueryRequest>
Sample submitAdhocQueryRequest Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
<AdhocQueryResponse>
...
</AdhocQueryResponse>
Copyright © OASIS, 2002. All Rights Reserved
Page 28 of 167
OASIS/ebXML Registry Services Specification v2.0
Method
acceptObjects
Parameters
AcceptObjectsRequest
March 2016
Return Value
HTTP Request Type
RegistryResponse
POST
approveObjects ApproveObjectsRequest RegistryResponse
POST
deprecateObjects DeprecateObjectsRequest RegistryResponse
POST
relocateObjects
RelocateObjectsRequest RegistryResponse
POST
removeObjects
RemoveObjectsRequest
RegistryResponse
POST
submitObjects
SubmitObjectsRequest
RegistryResponse
POST
updateObjects
UpdateObjectsRequest
RegistryResponse
POST
addSlots
AddSlotsRequest
RegistryResponse
POST
removeSlots
RemoveSlotsRequest
RegistryResponse
POST
 Table 6: LifeCycleManager REST Interface
756
757
758
759
Note that in the examples that follow name space declarations are omitted to conserve space.
Also note that some lines may be wrapped due to lack of space.
760
6.6.3.1
761
762
763
764
765
766
767
768
769
770
771
772
773
774
The following example shows how an HTTP POST request is used to invoke the submitObjects
method in LifeCycleManager.
775
6.6.3.2
776
777
778
779
780
781
782
783
784
785
786
787
The following example shows a sample response returned by the submitObjects method in
LifeCycleManager.
Sample submitObjects Request
POST /rest?interface=LifeCycleManager&method=submitObjects HTTP/1.1
User-Agent: Foo-ebXML/1.0
Host: www.registryserver.com
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
<SubmitObjectsRequest>
...
</SubmitObjectRequest>
Sample submitObjects Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 555
<?xml version="1.0"?>
<RegistryResponse>
...
</RegistryResponse>
Copyright © OASIS, 2002. All Rights Reserved
Page 29 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
788
6.6.4 Security Considerations
789
790
791
792
793
The REST interface supports the same mechanisms that are specified in chapter 12.
Authentication may be performed by the registry on a per message basis by verifying any digital
signatures present, as well as at the HTTP transport level using Basic or Digest authentication.
The details of how authentication credentials are specified for the REST interface to
LifeCycleManager are left to be implementation specific.
794
6.6.5 Exception Handling
795
796
797
798
799
800
801
802
803
804
Exception handling is consistent with exception handling in other registry interface bindings.
Errors must be reported in a RegistryErrorList, and sent back to the client on the same
connection as the request.
When errors occur, the HTTP status code and message should correspond to the error(s) being
reported in the RegistryErrorList. For example, if the RegistryErrorList reports that an
object wasn't found, therefore cannot be returned, an appropriate error code should be 404, with a
message of "ObjectNotFoundException". A detailed list of HTTP status codes can be found in
[RFC2616]. The mapping between registry exceptions and HTTP status codes is currently
unspecified.
805
6.7 Registry Clients
806
6.7.1 Registry Client Described
807
808
809
810
811
812
813
814
815
816
The Registry Client interfaces may be local to the registry or local to the user. Figure 5 depicts
the two possible topologies supported by the registry architecture with respect to the Registry
and Registry Clients. The picture on the left side shows the scenario where the Registry provides
a web based “thin client” application for accessing the Registry that is available to the user using
a common web browser. In this scenario the Registry Client interfaces reside across the Internet
and are local to the Registry from the user’s view. The picture on the right side shows the
scenario where the user is using a “fat client” Registry Browser application to access the registry.
In this scenario the Registry Client interfaces reside within the Registry Browser tool and are
local to the Registry from the user’s view. The Registry Client interfaces communicate with the
Registry over the Internet in this scenario.
817
818
819
820
821
A third topology made possible by the registry architecture is where the Registry Client
interfaces reside in a server side business component such as a Purchasing business component.
In this topology there may be no direct user interface or user intervention involved. Instead, the
Purchasing business component may access the Registry in an automated manner to select
possible sellers or service providers based on current business needs.
Copyright © OASIS, 2002. All Rights Reserved
Page 30 of 167
OASIS/ebXML Registry Services Specification v2.0
822
823
March 2016
 Figure 5: Registry Architecture Supports Flexible Topologies
824
6.7.2 Registry Communication Bootstrapping
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
Before a client can access the services of a Registry, there must be some communication
bootstrapping between the client and the registry. The most essential aspect of this bootstrapping
process is for the client to discover addressing information (e.g. an HTTP URL) to each of the
concrete service interfaces of the Registry. The client may obtain the addressing information by
discovering the ebXML Registry in a public registry such as UDDI or within another ebXML
Registry.
 In case of SOAP binding, all the info needed by the client (e.g. Registry URLs) is available
in a WSDL desription for the registry. This WSDL conforms to the template WSDL
description in Appendix A.1. This WSDL description may be discovered in a in a registry of
registries.
 In case of ebMS binding, the information exchange between the client and the registry may
be accomplished in a registry specific manner, which may involve establishing a CPA
between the client and the registry. Once the information exchange has occurred the Registry
and the client will have addressing information (e.g. URLs) for the other party.
 In case of REST binding the client may obtain the base URL to the registry by a lookup in a
registry of registries.
842
6.7.2.1
843
844
845
Each ebXML Registry must provide a WSDL description for its RegistryService as defined by
Appendix A.1. A client uses the WSDL description to determine the address information of the
RegistryService in a protocol specific manner. For example the SOAP/HTTP based ports of the
Communication Bootstrapping for SOAP Binding
Copyright © OASIS, 2002. All Rights Reserved
Page 31 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
846
RegistryService may be accessed via a URL specified in the WSDL for the registry.
847
848
The use of WSDL enables the client to use automated tools such as a WSDL compiler to
generate stubs that provide access to the registry in a language specific manner.
849
850
851
At minimum, any client may access the registry over SOAP/HTTP using the address information
within the WSDL, with minimal infrastructure requirements other than the ability to make
synchronous SOAP call to the SOAP based ports on the RegistryService.
852
6.7.2.2
853
854
855
856
857
858
859
860
861
862
Since there is no previously established CPA between the Registry and the RegistryClient, the
client must know at least one Transport-specific communication address for the Registry. This
communication address is typically a URL to the Registry, although it could be some other type
of address such as an email address. For example, if the communication used by the Registry is
HTTP, then the communication address is a URL. In this example, the client uses the Registry’s
public URL to create an implicit CPA with the Registry. When the client sends a request to the
Registry, it provides a URL to itself. The Registry uses the client’s URL to form its version of an
implicit CPA with the client. At this point a session is established within the Registry. For the
duration of the client’s session with the Registry, messages may be exchanged bi-directionally as
required by the interaction protocols defined in this specification.
863
6.7.2.3
864
865
Communication between a client and the REST interface is established based upon the base URL
of the REST interface to the registry. No other communication bootstrapping is required.
866
6.7.3 RegistryClient Interface
867
868
869
870
871
This is the principal interface implemented by a Registry client. The client provides this interface
when creating a connection to the Registry. It provides the methods that are used by the Registry
to deliver asynchronous responses to the client. Note that a client need not provide a
RegistryClient interface if the [CPA] between the client and the registry does not support
asynchronous responses.
872
The registry sends all asynchronous responses to operations via the onResponse method.
Communication Bootstrapping for ebXML Message Service Binding
Communication Bootstrapping for REST Binding
 Table 7: RegistryClient Summary
873
Method Summary of RegistryClient
void onResponse(RegistryResponse resp)
Notifies client of the response sent by registry to previously submitted request.
874
6.7.4 Registry Response
875
876
The RegistryResponse is a common class defined by the Registry interface that is used by the
registry to provide responses to client requests.
Copyright © OASIS, 2002. All Rights Reserved
Page 32 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
877
6.8 Interoperability Requirements
878
6.8.1 Client Interoperability
879
880
881
882
The architecture requires that any ebXML compliant registry client can access any ebXML
compliant registry service in an interoperable manner. An ebXML Registry must implement a
REST binding and either or both of the ebMS and SOAP/HTTP bindings.
Copyright © OASIS, 2002. All Rights Reserved
Page 33 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
883
7 Lifecycle Management Service
884
885
886
887
888
889
This section defines the Lifecycle Management service of the Registry. The Lifecycle
Management Service is a sub-service of the Registry service. It provides the functionality
required by RegistryClients to manage the lifecycle of repository items (e.g. XML documents
required for ebXML business processes). The Lifecycle Management Service can be used with
all types of repository items as well as the metadata objects specified in [ebRIM] such as
Classification and Association.
890
891
892
The minimum-security policy for an ebXML registry is to accept content from any client if a
certificate issued by a Certificate Authority recognized by the ebXML registry digitally signs the
content.
893
7.1 Lifecycle of a RegistryObject
894
895
896
The main purpose of the LifeCycleManagement service is to manage the lifecycle of
RegistryObjects. Figure 6 shows the typical lifecycle of a RegistryObject. Fix picture to show a
link from Submitted to Removed from RegistryObject??
897
898
 Figure 6: Lifecycle of a RegistryObject
899
7.2 RegistryObject Attributes
900
901
902
903
904
A repository item is associated with a set of standard metadata defined as attributes of the
RegistryObject class and its sub-classes as described in [ebRIM]. These attributes reside outside
of the actual repository item and catalog descriptive information about the repository item. XML
elements called ExtrinsicObject and other elements (See Appendix B.1 for details) encapsulate
all object metadata attributes defined in [ebRIM] as XML attributes.
Copyright © OASIS, 2002. All Rights Reserved
Page 34 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
905
7.3 The Submit Objects Protocol
906
907
908
This section describes the protocol of the Registry Service that allows a RegistryClient to submit
one or more RegistryObjects and/or repository items using the LifeCycleManager on behalf of a
Submitting Organization. It is expressed in UML notation as described in Appendix C.
909
910
 Figure 7: Submit Objects Sequence Diagram
911
For details on the schema for the Business documents shown in this process refer to Appendix B.
912
7.3.1 SubmitObjectsRequest
913
914
The SubmitObjectsRequest is used by a client to submit RegistryObjects and/or repository items
to the registry.
915
7.3.1.1
Syntax:
916
917
918
919
920
921
 Figure 8: SubmitObjectsRequest Syntax
7.3.1.2
Parameters:

indexingOption: Change to catalog. This parameter specifies the submitter’s
preference governing the indexing of the objects submitted via this request. Valid
values are:
922
923
NoIndexing: This specifies that the registry must not index any of the
objects submitted via this request.
924
925
IndexModificationNotAllowed: This specifies that the registry may index
any of the objects submitted via this request as long as the original objects
Copyright © OASIS, 2002. All Rights Reserved
Page 35 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
926
are not modified by the indexing operations.
927
928
929
IndexModificationAllowed: This specifies that the registry may index any
of the objects submitted via this request even if the original objects are are
modified by the indexing operations.

930
931
LeafRegistryObjectsList: This parameter specifies a collection of RegistryObject
instances that are being submitted to the registry.
932
933
7.3.1.3
934
This request returns a RegistryResponse. See section 7.3.2 for details.
935
7.3.1.4
936
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
937
938

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
939
940

ObjectNotFoundException: Indicates that the requestor referenced an object
within the request that was not found.
941
942

ObjectExistsException: Indicates that the requestor tried to submit an object using
an id that matched the id of an existing object in the registry.
943
944

InvalidRequestException: Indicates that the requestor attempted to perform an
operation which was semantically invalid.
945
946

UnsupportedCapabilityException: Indicates that the requestor attempted to
submit some content that is not supported by the registry.
947
948

QuotaExceededException: Indicates that the requestor attempted to submit more
content than the quota allowed for them by the registry.
949
950
7.3.2 RegistryResponse
951
952
953
The RegistryResponse is sent by the registry as a response to several different requests. It is a
simple response that can signal the status of a request and any errors or exceptions that may have
occurred during the processing of that request.
954
955
7.3.2.1
Syntax:
956
Copyright © OASIS, 2002. All Rights Reserved
Page 36 of 167
OASIS/ebXML Registry Services Specification v2.0
 Figure 9: RegistryResponse Syntax
957
958
March 2016
7.3.2.2
Parameters:
959
960

requestId: This parameter specifies the id of the request that generated this
response. It is used to correlate the response with its request.
961
962

status: This parameter specifies the status of the request. Valid values are as
follows:
963
964
965
966
967
968
969
Success: Request was processed successfully.
Failure: Errors were encountered during the processing of the request.
Unavailable: The results are unavailable. This is useful in asynchronous
responses.

RegistryErrorList: This parameter specifies a collection of RegistryErrors.
RegistryError is defined in ??. A RegistryErrorList includes a highestSeverity
attribute which logs the ErrorType for the most severe error that occurred.
970
971
7.3.3 Universally Unique ID Generation
972
973
974
As specified by [ebRIM], all objects in the registry have a unique id. The id must be a
Universally Unique Identifier (UUID) and must conform to the format of a URN that specifies a
DCE 128 bit UUID as specified in [UUID].
975
(e.g. urn:uuid:a2345678-1234-1234-123456789012)
976
977
978
979
980
981
The registry usually generates this id. The client may optionally supply the id attribute for
submitted objects. If the client supplies the id and it conforms to the format of a URN that
specifies a DCE 128 bit UUID then the registry assumes that the client wishes to specify the id
for the object. In this case, the registry must honour a client-supplied id and use it as the id
attribute of the object in the registry. If the id is not unique within the registry, the registry must
return ObjectExistsException.
982
983
984
If the client does not supply an id for a submitted object then the registry must generate a
universally unique id. Whether the client generates the id or whether the registry generates it, it
must be generated using the DCE 128 bit UUID generation algorithm as specified in [UUID].
985
7.3.4 ID Attribute And Object References
986
987
988
989
990
991
992
993
994
995
The id attribute of an object may be used by other objects to reference the first object. Such
references are common both within the SubmitObjectsRequest as well as within the registry.
Within a SubmitObjectsRequest, the id attribute may be used to refer to an object within the
SubmitObjectsRequest as well as to refer to an object within the registry. An object in the
SubmitObjectsRequest that needs to be referred to within the request document may be assigned
an id by the submitter so that it can be referenced within the request. The submitter may give the
object a proper UUID URN, in which case the id is permanently assigned to the object within the
registry. Alternatively, the submitter may assign an arbitrary id (not a proper UUID URN) as
long as the id is unique within the request document. In this case the id serves as a linkage
mechanism within the request document but must be ignored by the registry and replaced with a
Copyright © OASIS, 2002. All Rights Reserved
Page 37 of 167
OASIS/ebXML Registry Services Specification v2.0
996
March 2016
registry generated UUID upon submission.
997
998
999
1000
When an object in a SubmitObjectsRequest needs to reference an object that is already in the
registry, the request must contain an ObjectRef whose id attribute is the id of the object in the
registry. This id is by definition a proper UUID URN. An ObjectRef may be viewed as a proxy
within the request for an object that is in the registry.
1001
7.3.5 Audit Trail
1002
1003
The RS must create AuditableEvent objects with eventType Created for each RegistryObject
created via a SubmitObjectsRequest.
1004
7.3.6 Error Handling
1005
1006
1007
1008
1009
1010
1011
1012
Need to move to a generic section on error handling??
A request is atomic and either succeeds or fails in total. In the event of success, the registry sends
a RegistryResponse with a status of “Success” back to the client. In the event of failure, the
registry sends a RegistryResponse with a status of “Failure” back to the client. In the event of an
immediate response for an asynchronous request, the registry sends a RegistryResponse with a
status of “Unavailable” back to the client. Failure occurs when one or more Error conditions are
raised in the processing of the submitted objects. Warning messages do not result in failure of
the request.
1013
7.3.7 Sample SubmitObjectsRequest
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
The following example shows several different use cases in a single SubmitObjectsRequest. It
does not show the complete SOAP or [ebMS] Message with the message header and additional
payloads in the message for the repository items.
A SubmitObjectsRequest includes a RegistryObjectList which contains any number of objects
that are being submitted. It may also contain any number of ObjectRefs to link objects being
submitted to objects already within the registry.
<?xml version = "1.0" encoding = "UTF-8"?>
<SubmitObjectsRequest
xmlns = "urn:oasis:names:tc:ebxml-regrep:registry:xsd:2.0"
xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation = "urn:oasis:names:tc:ebxml-regrep:rim:xsd:2.0 file:///C:/osws/ebxmlrrspec/misc/schema/rim.xsd urn:oasis:names:tc:ebxml-regrep:registry:xsd:2.0
file:///C:/osws/ebxmlrr-spec/misc/schema/rs.xsd"
xmlns:rim = "urn:oasis:names:tc:ebxml-regrep:rim:xsd:2.0"
xmlns:rs = "urn:oasis:names:tc:ebxml-regrep:registry:xsd:2.0"
>
<rim:LeafRegistryObjectList>
<!-The following 3 objects package specified ExtrinsicObject in specified
RegistryPackage, where both the RegistryPackage and the ExtrinsicObject are
being submitted
-->
<rim:RegistryPackage id = "acmePackage1" >
<rim:Name>
<rim:LocalizedString value = "RegistryPackage #1"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's package #1"/>
</rim:Description>
Copyright © OASIS, 2002. All Rights Reserved
Page 38 of 167
OASIS/ebXML Registry Services Specification v2.0
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
March 2016
</rim:RegistryPackage>
<rim:ExtrinsicObject id = "acmeCPP1" >
<rim:Name>
<rim:LocalizedString value = "Widget Profile" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's profile for selling widgets" />
</rim:Description>
</rim:ExtrinsicObject>
<rim:Association id = "acmePackage1-acmeCPP1-Assoc" associationType = "Packages" sourceObject
= "acmePackage1" targetObject = "acmeCPP1" />
<!-The following 3 objects package specified ExtrinsicObject in specified RegistryPackage,
Where the RegistryPackage is being submitted and the ExtrinsicObject is
already in registry
-->
<rim:RegistryPackage id = "acmePackage2" >
<rim:Name>
<rim:LocalizedString value = "RegistryPackage #2"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's package #2"/>
</rim:Description>
</rim:RegistryPackage>
<rim:ObjectRef id = "urn:uuid:a2345678-1234-1234-123456789012"/>
<rim:Association id = "acmePackage2-alreadySubmittedCPP-Assoc" associationType = "Packages"
sourceObject = "acmePackage2" targetObject = "urn:uuid:a2345678-1234-1234-123456789012"/>
<!-The following 3 objects package specified ExtrinsicObject in specified RegistryPackage,
where the RegistryPackage and the ExtrinsicObject are already in registry
-->
<rim:ObjectRef id = "urn:uuid:b2345678-1234-1234-123456789012"/>
<rim:ObjectRef id = "urn:uuid:c2345678-1234-1234-123456789012"/>
<!-- id is unspecified implying that registry must create a uuid for this object -->
<rim:Association associationType = "Packages" sourceObject = "urn:uuid:b2345678-1234-1234123456789012" targetObject = "urn:uuid:c2345678-1234-1234-123456789012"/>
<!-The following 3 objects externally link specified ExtrinsicObject using
specified ExternalLink, where both the ExternalLink and the ExtrinsicObject
are being submitted
-->
<rim:ExternalLink id = "acmeLink1" >
<rim:Name>
<rim:LocalizedString value = "Link #1"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's Link #1"/>
</rim:Description>
</rim:ExternalLink>
<rim:ExtrinsicObject id = "acmeCPP2" >
<rim:Name>
<rim:LocalizedString value = "Sprockets Profile" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's profile for selling sprockets"/>
</rim:Description>
</rim:ExtrinsicObject>
<rim:Association id = "acmeLink1-acmeCPP2-Assoc" associationType = "ExternallyLinks"
sourceObject = "acmeLink1" targetObject = "acmeCPP2"/>
Copyright © OASIS, 2002. All Rights Reserved
Page 39 of 167
OASIS/ebXML Registry Services Specification v2.0
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
March 2016
<!-The following 2 objects externally link specified ExtrinsicObject using specified
ExternalLink, where the ExternalLink is being submitted and the ExtrinsicObject
is already in registry. Note that the targetObject points to an ObjectRef in a
previous line
-->
<rim:ExternalLink id = "acmeLink2">
<rim:Name>
<rim:LocalizedString value = "Link #2"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "ACME's Link #2"/>
</rim:Description>
</rim:ExternalLink>
<rim:Association id = "acmeLink2-alreadySubmittedCPP-Assoc" associationType =
"ExternallyLinks" sourceObject = "acmeLink2" targetObject = "urn:uuid:a2345678-1234-1234123456789012"/>
<!-The following 3 objects externally identify specified ExtrinsicObject using specified
ExternalIdentifier, where the ExternalIdentifier is being submitted and the
ExtrinsicObject is already in registry. Note that the targetObject points to an
ObjectRef in a previous line
-->
<rim:ClassificationScheme id = "DUNS-id" isInternal="false" nodeType="UniqueCode" >
<rim:Name>
<rim:LocalizedString value = "DUNS"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "This is the DUNS scheme"/>
</rim:Description>
</rim:ClassificationScheme>
<rim:ExternalIdentifier id = "acmeDUNSId" identificationScheme="DUNS-id" value =
"13456789012">
<rim:Name>
<rim:LocalizedString value = "DUNS" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "DUNS ID for ACME"/>
</rim:Description>
</rim:ExternalIdentifier>
<rim:Association id = "acmeDUNSId-alreadySubmittedCPP-Assoc" associationType =
"ExternallyIdentifies" sourceObject = "acmeDUNSId" targetObject = "urn:uuid:a2345678-1234-1234123456789012"/>
<!-The following show submission of a brand new classification scheme in its entirety
-->
<rim:ClassificationScheme id = "Geography-id" isInternal="true" nodeType="UniqueCode" >
<rim:Name>
<rim:LocalizedString value = "Geography"/>
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "This is a sample Geography scheme"/>
</rim:Description>
<rim:ClassificationNode id = "NorthAmerica-id" parent = "Geography-id" code =
"NorthAmerica" >
<rim:ClassificationNode id = "UnitedStates-id" parent = "NorthAmerica-id" code =
"UnitedStates" />
<rim:ClassificationNode id = "Canada-id" parent = "NorthAmerica-id" code = "Canada" />
</rim:ClassificationNode>
<rim:ClassificationNode id = "Asia-id" parent = "Geography-id" code = "Asia" >
<rim:ClassificationNode id = "Japan-id" parent = "Asia-id" code = "Japan" >
Copyright © OASIS, 2002. All Rights Reserved
Page 40 of 167
OASIS/ebXML Registry Services Specification v2.0
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
March 2016
<rim:ClassificationNode id = "Tokyo-id" parent = "Japan-id" code = "Tokyo" />
</rim:ClassificationNode>
</rim:ClassificationNode>
</rim:ClassificationScheme>
<!-The following show submission of a Automotive sub-tree of ClassificationNodes that
gets added to an existing classification scheme named 'Industry'
that is already in the registry
-->
<rim:ObjectRef id = "urn:uuid:d2345678-1234-1234-123456789012"/>
<rim:ClassificationNode id = "automotiveNode" parent = "urn:uuid:d2345678-1234-1234123456789012">
<rim:Name>
<rim:LocalizedString value = "Automotive" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "The Automotive sub-tree under Industry scheme"/>
</rim:Description>
</rim:ClassificationNode>
<rim:ClassificationNode id = "partSuppliersNode" parent = "automotiveNode">
<rim:Name>
<rim:LocalizedString value = "Parts Supplier" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "The Parts Supplier node under the Automotive node" />
</rim:Description>
</rim:ClassificationNode>
<rim:ClassificationNode id = "engineSuppliersNode" parent = "automotiveNode">
<rim:Name>
<rim:LocalizedString value = "Engine Supplier" />
</rim:Name>
<rim:Description>
<rim:LocalizedString value = "The Engine Supplier node under the Automotive node" />
</rim:Description>
</rim:ClassificationNode>
<!-The following show submission of 2 Classifications of an object that is already in
the registry using 2 ClassificationNodes. One ClassificationNode
is being submitted in this request (Japan) while the other is already in the registry.
-->
<rim:Classification id = "japanClassification" classifiedObject = "urn:uuid:a2345678-12341234-123456789012" classificationNode = "Japan-id">
<rim:Description>
<rim:LocalizedString value = "Classifies object by /Geography/Asia/Japan node"/>
</rim:Description>
</rim:Classification>
<rim:Classification id = "classificationUsingExistingNode" classifiedObject =
"urn:uuid:a2345678-1234-1234-123456789012" classificationNode = "urn:uuid:e2345678-1234-1234123456789012">
<rim:Description>
<rim:LocalizedString value = "Classifies object using a node in the registry" />
</rim:Description>
</rim:Classification>
<rim:ObjectRef id = "urn:uuid:e2345678-1234-1234-123456789012"/>
</rim:LeafRegistryObjectList>
</SubmitObjectsRequest>
1259
7.4 The Update Objects Protocol
1260
Reformat to new format later??
Copyright © OASIS, 2002. All Rights Reserved
Page 41 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1261
1262
1263
This section describes the protocol of the Registry Service that allows a Registry Client to update
one or more existing RegistryObjects and/or repository items in the registry on behalf of a
Submitting Organization. It is expressed in UML notation as described in Appendix C.
1264
1265
 Figure 10: Update Objects Sequence Diagram
1266
1267
1268
1269
1270
1271
For details on the schema for the Business documents shown in this process refer to Appendix B.
The UpdateObjectsRequest message includes a LeafRegistryObjectList element. The
LeafRegistryObjectList element specifies one or more RegistryObjects. Each object in the list
must be a current RegistryObject. RegistryObjects must include all attributes, even those the
user does not intend to change. A missing attribute is interpreted as a request to set that attribute
to NULL.
1272
7.4.1 Audit Trail
1273
1274
The RS must create AuditableEvents object with eventType Updated for each RegistryObject
updated via an UpdateObjectsRequest.
1275
7.5 The Add Slots Protocol
1276
1277
1278
This section describes the protocol of the Registry Service that allows a client to add slots to a
previously submitted RegistryObject using the LifeCycleManager. Slots provide a dynamic
mechanism for extending RegistryObjects as defined by [ebRIM].
Copyright © OASIS, 2002. All Rights Reserved
Page 42 of 167
OASIS/ebXML Registry Services Specification v2.0
1279
1280
March 2016
 Figure 11: Add Slots Sequence Diagram
1281
1282
7.5.1 AddSlotsRequest
1283
The AddSlotsRequest is used by a client to add slots to an existing RegistryObject in the registry.
1284
7.5.1.1
Syntax:
1285
1286
1287
 Figure 12: AddSlotsRequest Syntax
7.5.1.2
Parameters:
1288
1289

ObjectRef: This parameter specifies a reference to a RegistryObject instance to
which the requestor wishes to add slots via this request.
1290
1291
1292

Slot: This parameter specifies one or more Slot objects. Each Slot contains a
ValueList with one or more Values. Each Slot also has a slot name and a slotType
as described [ebRIM].
1293
Copyright © OASIS, 2002. All Rights Reserved
Page 43 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1294
7.5.1.3
1295
This request returns a RegistryResponse. See section 7.3.2 for details.
1296
7.5.1.4
1297
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1298
1299

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1300
1301

ObjectNotFoundException: Indicates that the requestor referenced an object
within the request that was not found.
1302
1303

SlotExistsException: Indicates that the requestor tried to add a Slot using a name
that matched the name of an existing Slot in the RegistryObject.
1304
1305

InvalidRequestException: Indicates that the requestor attempted to perform an
operation which was semantically invalid.
1306
1307
7.6 The Remove Slots Protocol
1308
1309
This section describes the protocol of the Registry Service that allows a client to remove slots to
a previously submitted RegistryObject using the LifeCycleManager.
1310
1311
 Figure 13: Remove Slots Sequence Diagram
1312
7.6.1 RemoveSlotsRequest
1313
1314
The RemoveSlotsRequest is used by a client to remove slots from an existing RegistryObject in
the registry.
Copyright © OASIS, 2002. All Rights Reserved
Page 44 of 167
OASIS/ebXML Registry Services Specification v2.0
1315
7.6.1.1
Syntax:
1316
1317
1318
March 2016
 Figure 14: RemoveSlotsRequest Syntax
7.6.1.2
Parameters:
1319
1320

ObjectRef: This parameter specifies a reference to a RegistryObject instance
from which the requestor wishes to remove slots via this request.
1321
1322
1323

Slot: This parameter specifies one or more Slot objects. Each slot being removed
is identified by its name attribute. Any Values specified with the ValueList for the
Slot can be silently ignored.
1324
1325
7.6.1.3
1326
This request returns a RegistryResponse. See section 7.3.2 for details.
1327
7.6.1.4
1328
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1329
1330

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1331
1332

ObjectNotFoundException: Indicates that the requestor referenced an object
within the request that was not found.
1333
1334

SlotNotFoundException: Indicates that the requestor attempted to remove a Slot
by name where no Slot existed that matches the specified name.
1335
1336
1337

InvalidRequestException: Indicates that the requestor attempted to perform an
operation which was semantically invalid.
1338
7.7 The Approve Objects Protocol
1339
1340
This section describes the protocol of the Registry Service that allows a client to approve one or
more previously submitted RegistryEntry objects using the LifeCycleManager.
Copyright © OASIS, 2002. All Rights Reserved
Page 45 of 167
OASIS/ebXML Registry Services Specification v2.0
1341
1342
March 2016
 Figure 15: Approve Objects Sequence Diagram
1343
7.7.1 ApproveObjectsRequest
1344
1345
The ApproveObjectsRequest is used by a client to approve one or more existing RegistryEntry
instances in the registry.
1346
7.7.1.1
Syntax:
1347
1348
1349
 Figure 16: ApproveObjectsRequest Syntax
7.7.1.2
Parameters:

1350
1351
1352
ObjectRefList: This parameter specifies a collection of reference to existing
RegistryEntry instances in the registry. These are the objects that the requestor
wishes to approve via this request.
1353
1354
7.7.1.3
1355
This request returns a RegistryResponse. See section 7.3.2 for details.
1356
7.7.1.4
1357
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1358
1359

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1360

ObjectNotFoundException: Indicates that the requestor referenced an object
Copyright © OASIS, 2002. All Rights Reserved
Page 46 of 167
OASIS/ebXML Registry Services Specification v2.0
1361
1362
1363
1364
1365
March 2016
within the request that was not found.

InvalidRequestException: Indicates that the requestor attempted to perform an
operation that was semantically invalid. A specific case where this exception must
be returned is if the requestor attempts to approve a RegistryObject that is not an
instance of a RegistryEntry sub-class.
1366
1367
7.7.2 Audit Trail
1368
1369
The RS must create AuditableEvent objects with eventType Approved for each RegistryEntry
instance approved via an ApproveObjectsRequest.
1370
7.8 The Deprecate Objects Protocol
1371
1372
1373
1374
1375
This section describes the protocol of the Registry Service that allows a client to deprecate one or
more previously submitted RegistryEntry instances using the LifeCycleManager. Once a
RegistryEntry is deprecated, no new references (e.g. new Associations, Classifications and
ExternalLinks) to that object can be submitted. However, existing references to a deprecated
object continue to function normally. What about UnDeprecate. Check ebxmlrr spec bug list??
1376
1377
 Figure 17: Deprecate Objects Sequence Diagram
1378
7.8.1 DeprecateObjectsRequest
1379
1380
The DeprecateObjectsRequest is used by a client to deprecate one or more existing
RegistryEntry instances in the registry.
Copyright © OASIS, 2002. All Rights Reserved
Page 47 of 167
OASIS/ebXML Registry Services Specification v2.0
1381
7.8.1.1
Syntax:
1382
1383
1384
March 2016
 Figure 18: DeprecateObjectsRequest Syntax
7.8.1.2
Parameters:

1385
1386
1387
ObjectRefList: This parameter specifies a collection of reference to existing
RegistryObject instances in the registry. These are the objects that the requestor
wishes to deprecate via this request.
1388
1389
7.8.1.3
1390
This request returns a RegistryResponse. See section 7.3.2 for details.
1391
7.8.1.4
1392
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1393
1394

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1395
1396

ObjectNotFoundException: Indicates that the requestor referenced an object
within the request that was not found.
1397
1398
1399
1400

InvalidRequestException: Indicates that the requestor attempted to perform an
operation which was semantically invalid. A specific case where this exception
must be returned is if the requestor attempts to deprecate a RegistryObject that is
not an instance of a RegistryEntry sub-class.
1401
1402
7.8.2 Audit Trail
1403
1404
The RS must create AuditableEvents object with eventType Deprecated for each RegistryEntry
deprecated via a DeprecateObjectsRequest.
1405
7.9 The Remove Objects Protocol
1406
1407
This section describes the protocol of the Registry Service that allows a client to remove one or
more RegistryObject instances and/or repository items using the LifeCycleManager.
1408
The remove object protocol is expressed in UML notation as described in Appendix C.
Copyright © OASIS, 2002. All Rights Reserved
Page 48 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1409
1410
 Figure 19: Remove Objects Sequence Diagram
1411
For details on the schema for the business documents shown in this process refer to Appendix B.
1412
7.9.1 RemoveObjectsRequest
1413
1414
The RemoveObjectsRequest is used by a client to remove one or more existing RegistryObject
and/or repository items from the registry.
1415
7.9.1.1
Syntax:
1416
1417
1418
1419
1420
 Figure 20: RemovalObjectsRequest Syntax
7.9.1.2
Parameters:

deletionScope: This parameter indicates the scope of impact of the
RemoveObjectsRequest. Its valid values may be as follows:
1421
1422
1423
1424
1425
DeleteRepositoryItemOnly: This deletionScope specifies that the request
should delete the repository items for the specified registry entries but not
delete the specified registry entries. This is useful in keeping references to
the registry entries valid. A registry must set the status of the
ExtrinsicObject instance to Withdrawn in this case.
1426
1427
1428
1429
1430
DeleteAll: This deletionScope specifies that the request should delete both
the RegistryObject and the repository item for the specified registry
entries. Only if all references (e.g. Associations, Classifications,
ExternalLinks) to a RegistryObject have been removed, can that
RegistryObject then be removed using a RemoveObjectsRequest with
Copyright © OASIS, 2002. All Rights Reserved
Page 49 of 167
OASIS/ebXML Registry Services Specification v2.0
1431
March 2016
deletionScope DeleteAll.

1432
1433
1434
ObjectRefList: This parameter specifies a collection of reference to existing
RegistryObject instances in the registry. These are the objects that the requestor
wishes to remove via this request.
1435
1436
7.9.1.3
1437
This request returns a RegistryResponse. See section 7.3.2 for details.
1438
7.9.1.4
1439
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1440
1441

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1442
1443

ObjectNotFoundException: Indicates that the requestor referenced an object
within the request that was not found.
1444
1445
1446
1447
1448

InvalidRequestException: Indicates that the requestor attempted to perform an
operation that was semantically invalid. A specific case where this exception must
be returned is if the requestor attempts to specify deletionScope of
DeleteRepositoryItemOnly when the object is not an instance of an
ExtrinsicObject.
1449
1450
1451

ReferencesExistException: Indicates that the requestor attempted to remove a
RegistryObject while references to it still exist.
Copyright © OASIS, 2002. All Rights Reserved
Page 50 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1452
8 Query Management Service
1453
1454
1455
1456
1457
1458
This section describes the capabilities of the Registry Service that allow a client
(QueryManagerClient) to search for or query different kinds of registry objects in the ebXML
Registry using the QueryManager interface of the Registry. The Registry supports the following
query capabilities:
 Filter Query
 SQL Query
1459
1460
1461
1462
The Filter Query mechanism in Section 8.2 must be supported by every Registry implementation.
The SQL Query mechanism is an optional feature and may be provided by a registry
implementation. However, if a vendor provides an SQL query capability to an ebXML Registry
it must conform to this document. As such this capability is a normative yet optional capability.
1463
1464
In a future version of this specification, the W3C XQuery syntax may be considered as another
query syntax.
1465
1466
The Registry will hold a self-describing capability profile that identifies all supported
AdhocQuery options. This profile is described in Appendix G.
1467
8.1 Ad Hoc Query Request/Response
1468
1469
1470
A client submits an ad hoc query to the QueryManager by sending an AdhocQueryRequest. The
AdhocQueryRequest contains a sub-element that defines a query in one of the supported
Registry query mechanisms.
1471
1472
1473
1474
1475
The QueryManager sends an AdhocQueryResponse either synchronously or asynchronously
back to the client. The AdhocQueryResponse returns a collection of objects whose element type
depends upon the responseOption attribute of the AdhocQueryRequest. These may be objects
representing leaf classes in [ebRIM], references to objects in the registry as well as intermediate
classes in [ebRIM] such as RegistryObject and RegistryEntry.
1476
1477
Any errors in the query request messages are indicated in the corresponding
AdhocQueryResponse message.
Copyright © OASIS, 2002. All Rights Reserved
Page 51 of 167
OASIS/ebXML Registry Services Specification v2.0
1478
1479
March 2016

 Figure 21: Submit Ad Hoc Query Sequence Diagram
1480
1481
For details on the schema for the business documents shown in this process refer to Appendix
B.2. Update picture to show that it returns AdhocQueryResponse??
1482
8.1.1 AdhocQueryRequest
1483
The AdhocQueryRequest is used to submit queries to the registry.
1484
8.1.1.1
1485
1486
1487
Syntax:
 Figure 22: AdhocQueryRequest Syntax Update picture to show it inherits from RegistryRequest??
8.1.1.2
Parameters:
1488

FilterQuery: This parameter specifies a registry Filter Query.
1489
1490
1491
1492
1493

maxResults: This optional parameter specifies a limit on the maximum number of
results the client wishes the query to return. If unspecified, the registry should
return either all the results, or in case the result set size exceeds a registry specific
limit, the registry should return a sub-set of results that are within the bounds of
the registry specific limit. See section 8.1.4.1 for an illustrative example.
1494
1495

ResponseOption: This required parameter allows the client to control the format
and content of the AdhocQueryResponse to this request. See section 8.1.3 for
Copyright © OASIS, 2002. All Rights Reserved
Page 52 of 167
OASIS/ebXML Registry Services Specification v2.0
1496
March 2016
details.
1497

SQLQuery: This parameter specifies a registry SQL Query.
1498
1499
1500
1501

startIndex: This optional integer value is used to indicate which result must be
returned as the first result when iterating over a large result set. The default
value is 0, which returns the result set starting with index 0 (first result). See
section 8.1.4.1 for an illustrative example.
1502
1503
8.1.1.3
1504
This request returns an AdhocQueryResponse. See section 9.6.2 for details.
1505
8.1.1.4
1506
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
1507
1508

AuthorizationException: Indicates that the requestor attempted to perform an
operation for which she was not authorized.
1509
1510

InvalidQueryException: signifies that the query syntax or semantics was invalid.
Client must fix the query syntax or semantic and re-submit the query.
1511
1512

TimeoutException: signifies that the processing time exceeded a registry specific
limit. Move to generic exceptions lists somehwhere??
1513
8.1.2 AdhocQueryResponse
1514
The AdhocQueryRequest sent by the registry as a response to AdhocQueryRequest.
1515
1516
1517
1518
1519
8.1.2.1
Syntax:
 Figure 23: AdhocQueryResponse Syntax Update picture to show it inherits from RegistryResponse??
8.1.2.2
Parameters:
1520

FilterQueryResult: This parameter specifies the result of a registry Filter Query.
1521

SQLQueryResult: This parameter specifies the result of a registry SQL Query.
1522
1523
1524
1525

startIndex: This optional integer value is used to indicate the index for the first
result in the result set returned by the query, within the complete result set
matching the query. By default, this value is 0. See section 8.1.4.1 for an
illustrative example.
Copyright © OASIS, 2002. All Rights Reserved
Page 53 of 167
OASIS/ebXML Registry Services Specification v2.0

1526
1527
1528
1529
1530
March 2016
totalResultCount: This optional parameter specifies the size of the complete
result set matching the query within the registry. When this value is unspecified,
the client should assume that value is the size of the result set contained within the
result. See section 8.1.4.1 for an illustrative example.
1531
8.1.3 ReponseOption
1532
1533
A client specifies an ResponseOption structure within an AdhocQueryRequest to indicate the
format of the results within the corresponding AdhocQueryResponse.
1534
1535
8.1.3.1
Syntax:
1536
1537
 Figure 24: ResponseOption Syntax
1538
1539
8.1.3.2
Parameters:
1540
1541
1542
1543

returnComposedObjects: This optional parameter specifies whether the
RegistryObjects returned should include composed objects such as
Classifications, ExternalIdentifiers etc. The default is to return all composed
objects.
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561

returnType: This optional enumeration parameter specifies the type of
RegistryObject to return within the response. Enumeration values for returnType
are explained in section 0. Values for returnType are as follows:




ObjectRef - This option specifies that the AdhocQueryResponse may contain
a collection of ObjectRef XML elements as defined in [ebRIM Schema].
Purpose of this option is to return references to registry objects.
RegistryObject - This option specifies that the AdhocQueryResponse may
contain a collection of RegistryObject XML elements as defined in [ebRIM
Schema]. In this case all attributes of the registry objects are returned
(objectType, name, description, …).
RegistryEntry - This option specifies that the AdhocQueryResponse may
contain a collection of RegistryEntry or RegistryObject XML elements as
defined in [ebRIM Schema], which correspond to RegistryEntry or
RegistryObject attributes.
LeafClass - This option specifies that the AdhocQueryResponse may contain a
collection of XML elements that correspond to leaf classes as defined in
[ebRIM Schema].
Copyright © OASIS, 2002. All Rights Reserved
Page 54 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1562
1563
1564
1565
1566
1567

1568
1569
1570
If “returnType” specified does not match a result returned by the query, then the
registry must use the closest matching semantically valid returnType that matches
the result.
1571
1572
1573
1574
This can be illustrated with a case when OrganizationQuery is asked to return
LeafClassWithRepositoryItem. As this is not possible, QueryManager will
assume LeafClass option instead. If OrganizationQuery is asked to retrieve a
RegistryEntry as a return type then RegistryObject metadata will be returned.
LeafClassWithRepositoryItem - This option specifies that the
AdhocQueryResponse may contain a collection of ExtrinsicObject XML
elements as defined in [ebRIM Schema] accompanied with their repository
items or RegistryEntry or RegistryObject and their attributes. Linking of
ExtrinsicObject and its repository item is accomplished using the technique
explained in Section 8.4 -Content Retrieval.
1575
8.1.4 Iterative Query Support
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
The iterative query feature is a normative optional feature of the registry. The
AdhocQueryRequest and AdhocQueryResponse support the ability to iterate over a large result
set matching a logical query by allowing multiple AdhocQueryRequest requests to be submitted
such that each query requests a different sliding window within the result set. This feature
enables the registry to handle queries that match a very large result set, in a scalable manner.
The iterative queries feature is not a true Cursor capability as found in databases. The registry is
not required to maintain transactional consistency or state between iterations of a query. Thus it
is possible for new objects to be added or existing objects to be removed from the complete
result set in between iterations. As a consequence it is possible to have a result set element be
skipped or duplicated between iterations.
Note that while it is not required, it may be possible for implementations to be smart and
implement a transactionally consistent iterative query feature. It is likely that a future version of
this specification will require a transactionally consistent iterative query capability.
1589
8.1.4.1
1590
1591
1592
1593
1594
1595
Consider the case where there are 1007 Organizations in a registry. The user wishes to submit a
query that matches all 1007 Organizations. The user wishes to do the query iteratively such that
Organizations are retrieved in chunks of 100. The following table illustrates the parameters of
the AdhocQueryRequest and those of the AdhocQueryResponses for each iterative query in this
example.
Query Iteration Example
AdhocQueryRequest Parameters
Copyright © OASIS, 2002. All Rights Reserved
AdhocQueryResponse Parameters
Page 55 of 167
OASIS/ebXML Registry Services Specification v2.0
startIndex
0
100
200
300
400
500
600
700
800
900
1000
maxResults
100
100
100
100
100
100
100
100
100
100
100
startIndex
0
100
200
300
400
500
600
700
800
900
1000
March 2016
totalResultCount
1007
1007
1007
1007
1007
1007
1007
1007
1007
1007
1007
# of
Results
100
100
100
100
100
100
100
100
100
100
7
1596
1597
1598
1599
8.2 Filter Query Support
-
Need to update for info model changes in V3. Filter Query changes to support new
objects like Subscriptions.??
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
FilterQuery is an XML syntax that provides simple query capabilities for any ebXML
conforming Registry implementation. Each query alternative is directed against a single class
defined by the ebXML Registry Information Model (ebRIM). There are two types of filter
queries depending on which classes are queried on.
 Firstly, there are RegistryObjectQuery and RegistryEntryQuery. They allow for generic
queries that might return different subclasses of the class that is queried on. The result of
such a query is a set of XML elements that correspond to instances of any class that satisfies
the responseOption defined previously in Section 8.1.3. An example might be that
RegistryObjectQuery with responseOption LeafClass will return all attributes of all instances
that satisfy the query. This implies that response might return XML elements that correspond
to classes like ClassificationScheme, RegistryPackage, Organization and Service.
 Secondly, FilterQuery supports queries on selected ebRIM classes in order to define the exact
traversals of these classes. Responses to these queries are accordingly constrained.
1613
1614
1615
1616
A client submits a FilterQuery as part of an AdhocQueryRequest. The QueryManager sends an
AdhocQueryResponse back to the client, enclosing the appropriate FilterQueryResult specified
herein. The sequence diagrams for AdhocQueryRequest and AdhocQueryResponse are specified
in Section 8.1.
1617
1618
1619
1620
1621
Each FilterQuery alternative is associated with an ebRIM Binding that identifies a hierarchy of
classes derived from a single class and its associations with other classes as defined by ebRIM.
Each choice of a class pre-determines a virtual XML document that can be queried as a tree. For
example, let C be a class, let Y and Z be classes that have direct associations to C, and let V be a
class that is associated with Z. The ebRIM Binding for C might be as in Figure 25
Copyright © OASIS, 2002. All Rights Reserved
Page 56 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1622
1623
 Figure 25: Example ebRIM Binding
1624
1625
1626
1627
1628
1629
Label1 identifies an association from C to Y, Label2 identifies an association from C to Z, and
Label3 identifies an association from Z to V. Labels can be omitted if there is no ambiguity as to
which ebRIM association is intended. The name of the query is determined by the root class, i.e.
this is an ebRIM Binding for a CQuery. The Y node in the tree is limited to the set of Y instances
that are linked to C by the association identified by Label1. Similarly, the Z and V nodes are
limited to instances that are linked to their parent node by the identified association.
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
Each FilterQuery alternative depends upon one or more class filters, where a class filter is a
restricted predicate clause over the attributes of a single class. Class methods that are defined in
ebRIM and that return simple types constitute “visible attributes” that are valid choices for
predicate clauses. Names of those attributes will be same as name of the corresponding method
just without the prefix ‘get’. For example, in case of “getLevelNumber” method the
corresponding visible attribute is “levelNumber”. The supported class filters are specified in
Section 8.2.13 and the supported predicate clauses are defined in Section 8.2.14. A FilterQuery
will be composed of elements that traverse the tree to determine which branches satisfy the
designated class filters, and the query result will be the set of instances that support such a
branch.
1640
1641
1642
1643
1644
1645
1646
In the above example, the CQuery element will have three subelements, one a CFilter on the C
class to eliminate C instances that do not satisfy the predicate of the CFilter, another a YFilter on
the Y class to eliminate branches from C to Y where the target of the association does not satisfy
the YFilter, and a third to eliminate branches along a path from C through Z to V. The third
element is called a branch element because it allows class filters on each class along the path
from C to V. In general, a branch element will have subelements that are themselves class filters,
other branch elements, or a full-blown query on the class in the path.
1647
1648
1649
1650
1651
If an association from a class C to a class Y is one-to-zero or one-to-one, then at most one
branch, filter or query element on Y is allowed. However, if the association is one-to-many, then
multiple branch, filter or query elements are allowed. This allows one to specify that an instance
of C must have associations with multiple instances of Y before the instance of C is said to
satisfy the branch element.
1652
1653
1654
1655
The FilterQuery syntax is tied to the structures defined in ebRIM. Since ebRIM is intended to be
stable, the FilterQuery syntax is stable. However, if new structures are added to the ebRIM, then
the FilterQuery syntax and semantics can be extended at the same time. Also, FilterQuery syntax
follows the inheritance hierarchy of ebRIM, which means that subclass queries inherit from their
Copyright © OASIS, 2002. All Rights Reserved
Page 57 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1656
1657
1658
respective superclass queries. Structures of XML elements that match the ebRIM classes are
explained in [ebRIM Schema]. Names of Filters, Queries and Branches correspond to names in
ebRIM whenever possible.
1659
1660
1661
The ebRIM Binding paragraphs in Sections 8.2.2 through 8.2.12 below identify the virtual
hierarchy for each FilterQuery alternative. The Semantic Rules for each query alternative specify
the effect of that binding on query semantics.
1662
8.2.1 FilterQuery
1663
1664
1665
1666
Purpose
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
Definition
To identify a set of queries that traverse specific registry class. Each alternative assumes a
specific binding to ebRIM. The status is a success indication or a collection of warnings and/or
exceptions.
<element name="FilterQuery">
<complexType>
<choice minOccurs="1" maxOccurs="1">
<element ref="tns:RegistryObjectQuery" />
<element ref="tns:RegistryEntryQuery" />
<element ref=”tns:AssociationQuery” />
<element ref="tns:AuditableEventQuery" />
<element ref=”tns:ClassificationQuery” />
<element ref="tns:ClassificationNodeQuery" />
<element ref="tns:ClassificationSchemeQuery" />
<element ref="tns:RegistryPackageQuery" />
<element ref="tns:ExtrinsicObjectQuery" />
<element ref="tns:OrganizationQuery" />
<element ref="tns:ServiceQuery" />
</choice>
</complexType>
</element>
<element name="FilterQueryResult">
<complexType>
<choice minOccurs="1" maxOccurs="1">
<element ref="tns:RegistryObjectQueryResult" />
<element ref="tns:RegistryEntryQueryResult" />
<element ref=”tns:AssociationQueryResult” />
<element ref="tns:AuditableEventQueryResult" />
<element ref=”tns:ClassificationQueryResult” />
<element ref="tns:ClassificationNodeQueryResult" />
<element ref="tns:ClassificationSchemeQueryResult" />
<element ref="tns:RegistryPackageQueryResult" />
<element ref="tns:ExtrinsicObjectQueryResult" />
<element ref="tns:OrganizationQueryResult" />
<element ref="tns:ServiceQueryResult" />
</choice>
</complexType>
</element>
Copyright © OASIS, 2002. All Rights Reserved
Page 58 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1705
Semantic Rules
1706
1. The semantic rules for each FilterQuery alternative are specified in subsequent subsections.
1707
1708
1709
2. Semantic rules specify the procedure for implementing the evaluation of Filter Queries.
Implementations do not necessarily have to follow the same procedure provided that the
same effect is achieved.
1710
1711
1712
3. Each FilterQueryResult is a set of XML elements to identify each instance of the result set.
Each XML attribute carries a value derived from the value of an attribute specified in the
Registry Information Model [ebRIM Schema].
1713
1714
1715
4. For each FilterQuery subelement there is only one corresponding FilterQueryResult
subelement that must be returned as a response. Class name of the FilterQueryResult
subelement has to match the class name of the FilterQuery subelement.
1716
1717
5. If a Branch or Query element for a class has no sub-elements then every persistent instance
of that class satisfies the Branch or Query.
1718
1719
1720
1721
1722
6. If an error condition is raised during any part of the execution of a FilterQuery, then the
status attribute of the XML RegistryResult is set to “failure” and no AdHocQueryResult
element is returned; instead, a RegistryErrorList element must be returned with its
highestSeverity element set to “error”. At least one of the RegistryError elements in the
RegistryErrorList will have its severity attribute set to “error”.
1723
1724
1725
1726
1727
7. If no error conditions are raised during execution of a FilterQuery, then the status attribute of
the XML RegistryResult is set to “success” and an appropriate FilterQueryResult element
must be included. If a RegistryErrorList is also returned, then the highestSeverity attribute of
the RegistryErrorList is set to “warning” and the serverity attribute of each RegistryError is
set to “warning”.
1728
8.2.2 RegistryObjectQuery
1729
Purpose
1730
1731
To identify a set of registry object instances as the result of a query over selected registry
metadata.
1732
ebRIM Binding
Copyright © OASIS, 2002. All Rights Reserved
Page 59 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
Registry Object
Source
Targe
t
Slot
External
Identifier
Association
Slot Value
Classification
Association
Targe
t
Source
Classification
Scheme
Registry Object or its
subclass
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
Classification
Node
Registry Object or its
subclass
 Figure 26: ebRIM Binding for RegistryObjectQuery
Definition
<complexType name="RegistryObjectQueryType">
<sequence>
<element ref="tns:RegistryObjectFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:ExternalIdentifierFilter" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:AuditableEventQuery" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:NameBranch" minOccurs="0" maxOccurs="1" />
<element ref="tns:DescriptionBranch" minOccurs="0" maxOccurs="1" />
<element ref="tns:ClassifiedByBranch" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:SlotBranch" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:SourceAssociationBranch" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:TargetAssociationBranch" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</complexType>
<element name="RegistryObjectQuery" type="tns:RegistryObjectQueryType" />
<complexType name="LeafRegistryObjectListType">
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="tns:ObjectRef" />
<element ref="tns:Association" />
<element ref="tns:AuditableEvent" />
<element ref="tns:Classification" />
<element ref="tns:ClassificationNode" />
<element ref="tns:ClassificationScheme" />
<element ref="tns:ExternalIdentifier" />
<element ref="tns:ExternalLink" />
<element ref="tns:ExtrinsicObject" />
<element ref="tns:Organization" />
<element ref="tns:RegistryPackage" />
<element ref="tns:Service" />
<element ref="tns:ServiceBinding" />
<element ref="tns:SpecificationLink" />
<element ref="tns:User" />
</choice>
</complexType>
Copyright © OASIS, 2002. All Rights Reserved
Page 60 of 167
OASIS/ebXML Registry Services Specification v2.0
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
March 2016
<complexType name="RegistryObjectListType">
<complexContent>
<extension base="tns:LeafRegistryObjectListType">
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="tns:RegistryEntry" />
<element ref="tns:RegistryObject" />
</choice>
</extension>
</complexContent>
</complexType>
<element name="RegistryObjectQueryResult" type="rim:RegistryObjectListType" />
<complexType name="InternationalStringBranchType">
<sequence>
<element ref="tns:LocalizedStringFilter" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</complexType>
<complexType name="AssociationBranchType">
<sequence>
<element ref="tns:AssociationFilter" minOccurs="0" maxOccurs="1" />
<choice minOccurs="0" maxOccurs="1">
<element ref="tns:ExternalLinkFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:ExternalIdentifierFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryObjectQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryEntryQuery" minOccurs="0" maxOccurs="1" />
<element ref=”tns:AssociationQuery” minOccurs=”0” maxOccurs=”1” />
<element ref=”tns:ClassificationQuery” minOccurs=”0” maxOccurs=”1” />
<element ref="tns:ClassificationSchemeQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:ClassificationNodeQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:OrganizationQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:AuditableEventQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryPackageQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:ExtrinsicObjectQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:ServiceQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:UserBranch" minOccurs="0" maxOccurs="1" />
<element ref="tns:ServiceBindingBranch" minOccurs="0" maxOccurs="1" />
<element ref="tns:SpecificationLinkBranch" minOccurs="0" maxOccurs="1" />
</choice>
</sequence>
</complexType>
<element name="SourceAssociationBranch" type="tns:AssociationBranchType" />
<element name="TargetAssociationBranch" type="tns:AssociationBranchType" />
<element name="ClassifiedByBranch">
<complexType>
<sequence>
<element ref="tns:ClassificationFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:ClassificationSchemeQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:ClassificationNodeQuery" minOccurs="0" maxOccurs="1" />
</sequence>
</complexType>
</element>
<element name="SlotBranch">
<complexType>
Copyright © OASIS, 2002. All Rights Reserved
Page 61 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
<sequence>
<element ref="tns:SlotFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:SlotValueFilter" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</complexType>
</element>
1865
Semantic Rules
1866
1867
1868
1. Let RO denote the set of all persistent RegistryObject instances in the Registry. The
following steps will eliminate instances in RO that do not satisfy the conditions of the
specified filters.
<element name = "UserBranch">
<complexType>
<sequence>
<element ref = "tns:UserFilter" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:PostalAddressFilter" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:TelephoneNumberFilter" minOccurs = "0" maxOccurs="unbounded"/>
<element ref = "tns:EmailAddressFilter" minOccurs = "0" maxOccurs="unbounded"/>
<element ref = "tns:OrganizationQuery" minOccurs = "0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<complexType name="ServiceBindingBranchType">
<sequence>
<element ref="tns:ServiceBindingFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:SpecificationLinkBranch" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:ServiceBindingTargetBranch" minOccurs="0" maxOccurs="1" />
</sequence>
</complexType>
<element name=”ServiceBindingBranch” type=”tns:ServiceBindingBranchType” />
<element name=”ServiceBindingTargetBranch” type=”tns:ServiceBindingBranchType” />
<element name="SpecificationLinkBranch">
<complexType>
<sequence>
<element ref="tns:SpecificationLinkFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryObjectQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryEntryQuery" minOccurs="0" maxOccurs="1" />
</sequence>
</complexType>
</element>
1869
a) If RO is empty then go to number 2 below.
1870
1871
1872
b) If a RegistryObjectFilter is not specified then go to the next step; otherwise, let x be a
registry object in RO. If x does not satisfy the RegistryObjectFilter, then remove x from
RO. If RO is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 62 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1873
1874
1875
1876
1877
1878
1879
c) If an ExternalIdentifierFilter element is not specified, then go to the next step; otherwise,
let x be a remaining registry object in RO. If x is not linked to at least one
ExternalIdentifier instance, then remove x from RO; otherwise, treat each
ExternalIdentifierFilter element separately as follows: Let EI be the set of
ExternalIdentifier instances that satisfy the ExternalIdentifierFilter and are linked to x. If
EI is empty, then remove x from RO. If RO is empty then continue to the next numbered
rule.
1880
1881
1882
1883
d) If an AuditableEventQuery is not specified then go to the next step; otherwise, let x be a
remaining registry object in RO. If x doesn’t have an auditable event that satisfy
AuditableEventQuery as specified in Section 8.2.5 then remove x from RO. If RO is
empty then continue to the next numbered rule.
1884
1885
1886
1887
1888
1889
e) If a NameBranch is not specified then go to the next step; otherwise, let x be a remaining
registry object in RO. If x does not have a name then remove x from RO. If RO is empty
then continue to the next numbered rule; otherwise treat NameBranch as follows: If any
LocalizedStringFilter that is specified is not satisfied by all of the LocalizedStrings that
constitute the name of the registry object then remove x from RO. If RO is empty then
continue to the next numbered rule.
1890
1891
1892
1893
1894
1895
f) If a DescriptionBranch is not specified then go to the next step; otherwise, let x be a
remaining registry object in RO. If x does not have a description then remove x from RO.
If RO is empty then continue to the next numbered rule; otherwise treat
DescriptionBranch as follows: If any LocalizedStringFilter that is specified is not
satisfied by all of the LocalizedStrings that constitute the description of the registry
object then remove x from RO. If RO is empty then continue to the next numbered rule.
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
g) If a ClassifiedByBranch element is not specified, then go to the next step; otherwise, let x
be a remaining registry object in RO. If x is not the classifiedObject of at least one
Classification instance, then remove x from RO; otherwise, treat each
ClassifiedByBranch element separately as follows: If no ClassificationFilter is specified
within the ClassifiedByBranch, then let CL be the set of all Classification instances that
have x as the classifiedObject; otherwise, let CL be the set of Classification instances that
satisfy the ClassificationFilter and have x as the classifiedObject. If CL is empty, then
remove x from RO and continue to the next numbered rule. Otherwise, if CL is not
empty, and if a ClassificationSchemeQuery is specified, then replace CL by the set of
remaining Classification instances in CL whose defining classification scheme satisfies
the ClassificationSchemeQuery. If the new CL is empty, then remove x from RO and
continue to the next numbered rule. Otherwise, if CL remains not empty, and if a
ClassificationNodeQuery is specified, then replace CL by the set of remaining
Classification instances in CL for which a classification node exists and for which that
classification node satisfies the ClassificationNodeQuery. If the new CL is empty, then
remove x from RO. If RO is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 63 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
h) If a SlotBranch element is not specified, then go to the next step; otherwise, let x be a
remaining registry object in RO. If x is not linked to at least one Slot instance, then
remove x from RO. If RO is empty then continue to the next numbered rule; otherwise,
treat each SlotBranch element separately as follows: If a SlotFilter is not specified within
the SlotBranch, then let SL be the set of all Slot instances for x; otherwise, let SL be the
set of Slot instances that satisfy the SlotFilter and are Slot instances for x. If SL is empty,
then remove x from RO and continue to the next numbered rule. Otherwise, if SL
remains not empty, and if a SlotValueFilter is specified, replace SL by the set of
remaining Slot instances in SL for which every specified SlotValueFilter is valid. If SL is
empty, then remove x from RO. If RO is empty then continue to the next numbered rule.
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
i) If a SourceAssociationBranch element is not specified then go to the next step; otherwise,
let x be a remaining registry object in RO. If x is not the source object of at least one
Association instance, then remove x from RO. If RO is empty then continue to the next
numbered rule; otherwise, treat each SourceAssociationBranch element separately as
follows:
If no AssociationFilter is specified within the SourceAssociationBranch, then let AF be
the set of all Association instances that have x as a source object; otherwise, let AF be the
set of Association instances that satisfy the AssociationFilter and have x as the source
object. If AF is empty, then remove x from RO.
If RO is empty then continue to the next numbered rule.
If an ExternalLinkFilter is specified within the SourceAssociationBranch, then let ROT
be the set of ExternalLink instances that satisfy the ExternalLinkFilter and are the target
object of some element of AF. If ROT is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule.
If an ExternalIdentifierFilter is specified within the SourceAssociationBranch, then let
ROT be the set of ExternalIdentifier instances that satisfy the ExternalIdentifierFilter and
are the target object of some element of AF. If ROT is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
If a RegistryObjectQuery is specified within the SourceAssociationBranch, then let ROT
be the set of RegistryObject instances that satisfy the RegistryObjectQuery and are the
target object of some element of AF. If ROT is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule.
If a RegistryEntryQuery is specified within the SourceAssociationBranch, then let ROT
be the set of RegistryEntry instances that satisfy the RegistryEntryQuery and are the
target object of some element of AF. If ROT is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule.
If a ClassificationSchemeQuery is specified within the SourceAssociationBranch, then let
ROT be the set of ClassificationScheme instances that satisfy the
ClassificationSchemeQuery and are the target object of some element of AF. If ROT is
empty, then remove x from RO. If RO is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 64 of 167
OASIS/ebXML Registry Services Specification v2.0
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
March 2016
If a ClassificationNodeQuery is specified within the SourceAssociationBranch, then let
ROT be the set of ClassificationNode instances that satisfy the ClassificationNodeQuery
and are the target object of some element of AF. If ROT is empty, then remove x from
RO. If RO is empty then continue to the next numbered rule.
If an OrganizationQuery is specified within the SourceAssociationBranch, then let ROT
be the set of Organization instances that satisfy the OrganizationQuery and are the target
object of some element of AF. If ROT is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule.
If an AuditableEventQuery is specified within the SourceAssociationBranch, then let
ROT be the set of AuditableEvent instances that satisfy the AuditableEventQuery and are
the target object of some element of AF. If ROT is empty, then remove x from RO. If RO
is empty then continue to the next numbered rule.
If a RegistryPackageQuery is specified within the SourceAssociationBranch, then let
ROT be the set of RegistryPackage instances that satisfy the RegistryPackageQuery and
are the target object of some element of AF. If ROT is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
If an ExtrinsicObjectQuery is specified within the SourceAssociationBranch, then let
ROT be the set of ExtrinsicObject instances that satisfy the ExtrinsicObjectQuery and are
the target object of some element of AF. If ROT is empty, then remove x from RO. If RO
is empty then continue to the next numbered rule.
If a ServiceQuery is specified within the SourceAssociationBranch, then let ROT be the
set of Service instances that satisfy the ServiceQuery and are the target object of some
element of AF. If ROT is empty, then remove x from RO. If RO is empty then continue
to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 65 of 167
OASIS/ebXML Registry Services Specification v2.0
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
March 2016
If a UserBranch is specified within the SourceAssociationBranch then let ROT be the set
of User instances that are the target object of some element of AF. If ROT is empty, then
remove x from RO. If RO is empty then continue to the next numbered rule. Let u be the
member of ROT. If a UserFilter element is specified within the UserBranch, and if u does
not satisfy that filter, then remove u from ROT. If ROT is empty, then remove x from
RO. If RO is empty then continue to the next numbered rule. If a PostalAddressFilter
element is specified within the UserBranch, and if the postal address of u does not satisfy
that filter, then remove u from ROT. If ROT is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule. If TelephoneNumberFilter(s) are
specified within the UserBranch and if any of the TelephoneNumberFilters isn’t satisfied
by all of the telephone numbers of u then remove u from ROT. If ROT is empty, then
remove x from RO. If RO is empty then continue to the next numbered rule. If an
OrganizationQuery element is specified within the UserBranch, then let o be the
Organization instance that is identified by the organization that u is affiliated with. If o
doesn’t satisfy OrganizationQuery as defined in Section 8.2.11 then remove u from ROT.
If ROT is empty, then remove x from RO. If RO is empty then continue to the next
numbered rule.
If a ClassificationQuery is specified within the SourceAssociationBranch, then let ROT
be the set of Classification instances that satisfy the ClassificationQuery and are the
target object of some element of AF. If ROT is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule (Rule 2).
If a ServiceBindingBranch is specified within the SourceAssociationBranch, then let
ROT be the set of ServiceBinding instances that are the target object of some element of
AF. If ROT is empty, then remove x from RO. If RO is empty then continue to the next
numbered rule. Let sb be the member of ROT. If a ServiceBindingFilter element is
specified within the ServiceBindingBranch, and if sb does not satisfy that filter, then
remove sb from ROT. If ROT is empty then remove x from RO. If RO is empty then
continue to the next numbered rule. If a SpecificationLinkBranch is specified within the
ServiceBindingBranch then consider each SpecificationLinkBranch element separately as
follows:
Let sb be a remaining service binding in ROT. Let SL be the set of all specification link
instances sl that describe specification links of sb. If a SpecificationLinkFilter element is
specified within the SpecificationLinkBranch, and if sl does not satisfy that filter, then
remove sl from SL. If SL is empty then remove sb from ROT. If ROT is empty then
remove x from RO. If RO is empty then continue to the next numbered rule. If a
RegistryObjectQuery element is specified within the SpecificationLinkBranch then let sl
be a remaining specification link in SL. Treat RegistryObjectQuery element as follows:
Let RO be the result set of the RegistryObjectQuery as defined in Section 8.2.2. If sl is
not a specification link for at least one registry object in RO, then remove sl from SL. If
SL is empty then remove sb from ROT. If ROT is empty then remove x from RO. If RO
is empty then continue to the next numbered rule. If a RegistryEntryQuery element is
specified within the SpecificationLinkBranch then let sl be a remaining specification link
in SL. Treat RegistryEntryQuery element as follows: Let RE be the result set of the
RegistryEntryQuery as defined in Section 8.2.3. If sl is not a specification link for at least
Copyright © OASIS, 2002. All Rights Reserved
Page 66 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
one registry entry in RE, then remove sl from SL. If SL is empty then remove sb from
ROT. If ROT is empty then remove x from RO. If RO is empty then continue to the next
numbered rule. If a ServiceBindingTargetBranch is specified within the
ServiceBindingBranch, then let SBT be the set of ServiceBinding instances that satisfy
the ServiceBindingTargetBranch and are the target service binding of some element of
ROT. If SBT is empty then remove sb from ROT. If ROT is empty, then remove x from
RO. If RO is empty then continue to the next numbered rule.
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
j) If a TargetAssociationBranch element is not specified then go to the next step; otherwise,
let x be a remaining registry object in RO. If x is not the target object of some
Association instance, then remove x from RO. If RO is empty then continue to the next
numbered rule; otherwise, treat each TargetAssociationBranch element separately as
follows:
If a SpecificationLinkBranch is specified within the SourceAssociationBranch, then let
ROT be the set of SpecificationLink instances that are the target object of some element
of AF. If ROT is empty, then remove x from RO. If RO is empty then continue to the
next numbered rule. Let sl be the member of ROT. If a SpecificationLinkFilter element is
specified within the SpecificationLinkBranch, and if sl does not satisfy that filter, then
remove sl from ROT. If ROT is empty then remove x from RO. If RO is empty then
continue to the next numbered rule. If a RegistryObjectQuery element is specified within
the SpecificationLinkBranch then let sl be a remaining specification link in ROT. Treat
RegistryObjectQuery element as follows: Let RO be the result set of the
RegistryObjectQuery as defined in Section 8.2.2. If sl is not a specification link for some
registry object in RO, then remove sl from ROT. If ROT is empty then remove x from
RO. If RO is empty then continue to the next numbered rule. If a RegistryEntryQuery
element is specified within the SpecificationLinkBranch then let sl be a remaining
specification link in ROT. Treat RegistryEntryQuery element as follows: Let RE be the
result set of the RegistryEntryQuery as defined in Section 8.2.3. If sl is not a specification
link for at least one registry entry in RE, then remove sl from ROT. If ROT is empty then
remove x from RO. If RO is empty then continue to the next numbered rule.
If an AssociationQuery is specified within the SourceAssociationBranch, then let ROT be
the set of Association instances that satisfy the AssociationQuery and are the target object
of some element of AF. If ROT is empty, then remove x from RO. If RO is empty then
continue to the next numbered rule (Rule 2).
If no AssociationFilter is specified within the TargetAssociationBranch, then let AF be
the set of all Association instances that have x as a target object; otherwise, let AF be the
set of Association instances that satisfy the AssociationFilter and have x as the target
object. If AF is empty, then remove x from RO. If RO is empty then continue to the next
numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 67 of 167
OASIS/ebXML Registry Services Specification v2.0
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
March 2016
If an ExternalLinkFilter is specified within the TargetAssociationBranch, then let ROS be
the set of ExternalLink instances that satisfy the ExternalLinkFilter and are the source
object of some element of AF. If ROS is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule.
If an ExternalIdentifierFilter is specified within the TargetAssociationBranch, then let
ROS be the set of ExternalIdentifier instances that satisfy the ExternalIdentifierFilter and
are the source object of some element of AF. If ROS is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
If a RegistryObjectQuery is specified within the TargetAssociationBranch, then let ROS
be the set of RegistryObject instances that satisfy the RegistryObjectQuery and are the
source object of some element of AF. If ROS is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule.
If a RegistryEntryQuery is specified within the TargetAssociationBranch, then let ROS
be the set of
RegistryEntry instances that satisfy the RegistryEntryQuery and are the source object of
some element of AF. If ROS is empty, then remove x from RO. If RO is empty then
continue to the next numbered rule.
If a ClassificationSchemeQuery is specified within the TargetAssociationBranch, then let
ROS be the set of ClassificationScheme instances that satisfy the
ClassificationSchemeQuery and are the source object of some element of AF. If ROS is
empty, then remove x from RO. If RO is empty then continue to the next numbered rule.
If a ClassificationNodeQuery is specified within the TargetAssociationBranch, then let
ROS be the set of ClassificationNode instances that satisfy the ClassificationNodeQuery
and are the source object of some element of AF. If ROS is empty, then remove x from
RO. If RO is empty then continue to the next numbered rule.
If an OrganizationQuery is specified within the TargetAssociationBranch, then let ROS
be the set of Organization instances that satisfy the OrganizationQuery and are the source
object of some element of AF. If ROS is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule.
If an AuditableEventQuery is specified within the TargetAssociationBranch, then let
ROS be the set of AuditableEvent instances that satisfy the AuditableEventQuery and are
the source object of some element of AF. If ROS is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
If a RegistryPackageQuery is specified within the TargetAssociationBranch, then let
ROS be the set of RegistryPackage instances that satisfy the RegistryPackageQuery and
are the source object of some element of AF. If ROS is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 68 of 167
OASIS/ebXML Registry Services Specification v2.0
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
March 2016
If an ExtrinsicObjectQuery is specified within the TargetAssociationBranch, then let
ROS be the set of ExtrinsicObject instances that satisfy the ExtrinsicObjectQuery and are
the source object of some element of AF. If ROS is empty, then remove x from RO. If
RO is empty then continue to the next numbered rule.
If a ServiceQuery is specified within the TargetAssociationBranch, then let ROS be the
set of Service instances that satisfy the ServiceQuery and are the source object of some
element of AF. If ROS is empty, then remove x from RO. If RO is empty then continue
to the next numbered rule.
If a UserBranch is specified within the TargetAssociationBranch then let ROS be the set
of User instances that are the source object of some element of AF. If ROS is empty, then
remove x from RO. If RO is empty then continue to the next numbered rule. Let u be the
member of ROS. If a UserFilter element is specified within the UserBranch, and if u does
not satisfy that filter, then remove u from ROS. If ROS is empty, then remove x from
RO. If RO is empty then continue to the next numbered rule. If a PostalAddressFilter
element is specified within the UserBranch, and if the postal address of u does not satisfy
that filter, then remove u from ROS. If ROS is empty, then remove x from RO. If RO is
empty then continue to the next numbered rule. If TelephoneNumberFilter(s) are
specified within the UserBranch and if any of the TelephoneNumberFilters isn’t satisfied
by all of the telephone numbers of u then remove u from ROS. If ROS is empty, then
remove x from RO. If RO is empty then continue to the next numbered rule. If an
OrganizationQuery element is specified within the UserBranch, then let o be the
Organization instance that is identified by the organization that u is affiliated with. If o
doesn’t satisfy OrganizationQuery as defined in Section 8.2.11 then remove u from ROS.
If ROS is empty, then remove x from RO. If RO is empty then continue to the next
numbered rule.
If a ClassificationQuery is specified within the TargetAssociationBranch, then let ROS be
the set of Classification instances that satisfy the ClassificationQuery and are the source
object of some element of AF. If ROS is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule (Rule 2).
If a ServiceBindingBranch is specified within the TargetAssociationBranch, then let ROS
be the set of ServiceBinding instances that are the source object of some element of AF.
If ROS is empty, then remove x from RO. If RO is empty then continue to the next
numbered rule. Let sb be the member of ROS. If a ServiceBindingFilter element is
specified within the ServiceBindingBranch, and if sb does not satisfy that filter, then
remove sb from ROS. If ROS is empty then remove x from RO. If RO is empty then
continue to the next numbered rule. If a SpecificationLinkBranch is specified within the
ServiceBindingBranch then consider each SpecificationLinkBranch element separately as
follows:
Copyright © OASIS, 2002. All Rights Reserved
Page 69 of 167
OASIS/ebXML Registry Services Specification v2.0
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
March 2016
Let sb be a remaining service binding in ROS. Let SL be the set of all specification link
instances sl that describe specification links of sb. If a SpecificationLinkFilter element is
specified within the SpecificationLinkBranch, and if sl does not satisfy that filter, then
remove sl from SL. If SL is empty then remove sb from ROS. If ROS is empty then
remove x from RO. If RO is empty then continue to the next numbered rule. If a
RegistryObjectQuery element is specified within the SpecificationLinkBranch then let sl
be a remaining specification link in SL. Treat RegistryObjectQuery element as follows:
Let RO be the result set of the RegistryObjectQuery as defined in Section 8.2.2. If sl is
not a specification link for some registry object in RO, then remove sl from SL. If SL is
empty then remove sb from ROS. If ROS is empty then remove x from RO. If RO is
empty then continue to the next numbered rule. If a RegistryEntryQuery element is
specified within the SpecificationLinkBranch then let sl be a remaining specification link
in SL. Treat RegistryEntryQuery element as follows: Let RE be the result set of the
RegistryEntryQuery as defined in Section 8.2.3. If sl is not a specification link for some
registry entry in RE, then remove sl from SL. If SL is empty then remove sb from ROS.
If ROS is empty then remove x from RO. If RO is empty then continue to the next
numbered rule.
If a SpecificationLinkBranch is specified within the TargetAssociationBranch, then let
ROS be the set of SpecificationLink instances that are the source object of some element
of AF. If ROS is empty, then remove x from RO. If RO is empty then continue to the
next numbered rule. Let sl be the member of ROS. If a SpecificationLinkFilter element is
specified within the SpecificationLinkBranch, and if sl does not satisfy that filter, then
remove sl from ROS. If ROS is empty then remove x from RO. If RO is empty then
continue to the next numbered rule. If a RegistryObjectQuery element is specified within
the SpecificationLinkBranch then let sl be a remaining specification link in ROS. Treat
RegistryObjectQuery element as follows: Let RO be the result set of the
RegistryObjectQuery as defined in Section 8.2.2. If sl is not a specification link for some
registry object in RO, then remove sl from ROS. If ROS is empty then remove x from
RO. If RO is empty then continue to the next numbered rule. If a RegistryEntryQuery
element is specified within the SpecificationLinkBranch then let sl be a remaining
specification link in ROS. Treat RegistryEntryQuery element as follows: Let RE be the
result set of the RegistryEntryQuery as defined in Section 8.2.3. If sl is not a specification
link for some registry entry in RE, then remove sl from ROS. If ROS is empty then
remove x from RO. If RO is empty then continue to the next numbered rule. If a
ServiceBindingTargetBranch is specified within the ServiceBindingBranch, then let SBT
be the set of ServiceBinding instances that satisfy the ServiceBindingTargetBranch and
are the target service binding of some element of ROT. If SBT is empty then remove sb
from ROT. If ROT is empty, then remove x from RO. If RO is empty then continue to the
next numbered rule.
If an AssociationQuery is specified within the TargetAssociationBranch, then let ROS be
the set of Association instances that satisfy the AssociationQuery and are the source
object of some element of AF. If ROS is empty, then remove x from RO. If RO is empty
then continue to the next numbered rule (Rule 2).
2.
If RO is empty, then raise the warning: registry object query result is empty; otherwise, set
RO to be the result of the RegistryObjectQuery.
Copyright © OASIS, 2002. All Rights Reserved
Page 70 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2214
2215
3.
Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2216
Examples
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
A client application needs all items that are classified by two different classification schemes,
one based on "Industry" and another based on "Geography". Both schemes have been defined by
ebXML and are registered as "urn:ebxml:cs:industry" and "urn:ebxml:cs:geography",
respectively. The following query identifies registry entries for all registered items that are
classified by Industry as any subnode of "Automotive" and by Geography as any subnode of
"Asia/Japan".
<AdhocQueryRequest>
<ResponseOption returnType = "RegistryEntry"/>
<FilterQuery>
<RegistryObjectQuery>
<ClassifiedByBranch>
<ClassificationFilter>
<Clause>
<SimpleClause leftArgument = "path">
<StringClause stringPredicate = "Equal">//Automotive</StringClause>
</SimpleClause>
</Clause>
</ClassificationFilter>
<ClassificationSchemeQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">urn:ebxml:cs:industry</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</ClassificationSchemeQuery>
</ClassifiedByBranch>
<ClassifiedByBranch>
<ClassificationFilter>
<Clause>
<SimpleClause leftArgument = "path">
<StringClause stringPredicate = "StartsWith">/Geography-id/Asia/Japan</StringClause>
</SimpleClause>
</Clause>
</ClassificationFilter>
<ClassificationSchemeQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">urn:ebxml:cs:geography</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</ClassificationSchemeQuery>
</ClassifiedByBranch>
Copyright © OASIS, 2002. All Rights Reserved
Page 71 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2268
2269
2270
2271
</RegistryObjectQuery>
</FilterQuery>
</AdhocQueryRequest>
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
A client application wishes to identify all RegistryObject instances that are classified by some
internal classification scheme and have some given keyword as part of the description of one of
the classification nodes of that classification scheme. The following query identifies all such
RegistryObject instances. The query takes advantage of the knowledge that the classification
scheme is internal, and thus that all of its nodes are fully described as ClassificationNode
instances.
2300
8.2.3 RegistryEntryQuery
2301
Purpose
2302
2303
To identify a set of registry entry instances as the result of a query over selected registry
metadata.
<AdhocQueryRequest>
<ResponseOption returnType = "RegistryObject"/>
<FilterQuery>
<RegistryObjectQuery>
<ClassifiedByBranch>
<ClassificationNodeQuery>
<DescriptionBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">transistor</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</DescriptionBranch>
</ClassificationNodeQuery>
</ClassifiedByBranch>
</RegistryObjectQuery>
</FilterQuery>
</AdhocQueryRequest>
2304
Registry Entry
Registry
Object
2305
2306
ebRIM Binding
2307
2308
Definition
 Figure 27: ebRIM Binding for RegistryEntryQuery
Copyright © OASIS, 2002. All Rights Reserved
Page 72 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
<complexType name="RegistryEntryQueryType">
<complexContent>
<extension base="tns:RegistryObjectQueryType">
<sequence>
<element ref="tns:RegistryEntryFilter" minOccurs="0" maxOccurs="1" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="RegistryEntryQuery" type="tns:RegistryEntryQueryType" />
2333
Semantic Rules
2334
2335
1. Let RE denote the set of all persistent RegistryEntry instances in the Registry. The following
steps will eliminate instances in RE that do not satisfy the conditions of the specified filters.
<element name="RegistryEntryQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:ClassificationScheme" />
<element ref="rim:ExtrinsicObject" />
<element ref="rim:RegistryEntry" />
<element ref="rim:RegistryObject" />
<element ref="rim:RegistryPackage" />
</choice>
</complexType>
</element>
2336
a) If RE is empty then continue to the next numbered rule.
2337
2338
2339
b) If a RegistryEntryFilter is not specified then go to the next step; otherwise, let x be a
registry entry in RE. If x does not satisfy the RegistryEntryFilter, then remove x from RE.
If RE is empty then continue to the next numbered rule.
2340
2341
c) Let RE be the set of remaining RegistryEntry instances. Evaluate inherited
RegistryObjectQuery over RE as explained in Section 8.2.2.
2342
2343
2. If RE is empty, then raise the warning: registry entry query result is empty; otherwise, set RE
to be the result of the RegistryEntryQuery.
2344
2345
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2346
Examples
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
A client wishes to establish a trading relationship with XYZ Corporation and wants to know if
they have registered any of their business documents in the Registry. The following query
returns a set of registry entry identifiers for currently registered items submitted by any
organization whose name includes the string "XYZ". It does not return any registry entry
identifiers for superseded, replaced, deprecated, or withdrawn items.
<AdhocQueryRequest>
<ResponseOption returnType = "ObjectRef"/>
<FilterQuery>
<RegistryEntryQuery>
Copyright © OASIS, 2002. All Rights Reserved
Page 73 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
<TargetAssociationBranch>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument = "associationType">
<StringClause stringPredicate = "Equal">SubmitterOf</StringClause>
</SimpleClause>
</Clause>
</AssociationFilter>
<OrganizationQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Contains">XYZ</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</OrganizationQuery>
</TargetAssociationBranch>
<RegistryEntryFilter>
<Clause>
<SimpleClause leftArgument = "status">
<StringClause stringPredicate = "Equal">Approved</StringClause>
</SimpleClause>
</Clause>
</RegistryEntryFilter>
</RegistryEntryQuery>
</FilterQuery>
</AdhocQueryRequest>
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
A client is using the United Nations Standard Product and Services Classification (UNSPSC)
scheme and wants to identify all companies that deal with products classified as "Integrated
circuit components", i.e. UNSPSC code "321118". The client knows that companies have
registered their Collaboration Protocol Profile (CPP) documents in the Registry, and that each
such profile has been classified by UNSPSC according to the products the company deals with.
However, the client does not know if the UNSPSC classification scheme is internal or external to
this registry. The following query returns a set of approved registry entry instances for CPP’s of
companies that deal with integrated circuit components.
<AdhocQueryRequest>
<ResponseOption returnType = "RegistryEntry"/>
<FilterQuery>
<RegistryEntryQuery>
<ClassifiedByBranch>
<ClassificationFilter>
<Clause>
<SimpleClause leftArgument = "code">
<StringClause stringPredicate = "Equal">321118</StringClause>
</SimpleClause>
</Clause>
</ClassificationFilter>
<ClassificationSchemeQuery>
<NameBranch>
<LocalizedStringFilter>
Copyright © OASIS, 2002. All Rights Reserved
Page 74 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">urn:org:un:spsc:cs2001</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</ClassificationSchemeQuery>
</ClassifiedByBranch>
<RegistryEntryFilter>
<Clause>
<CompoundClause connectivePredicate = "And">
<Clause>
<SimpleClause leftArgument = "objectType">
<StringClause stringPredicate = "Equal">CPP</StringClause>
</SimpleClause>
</Clause>
<Clause>
<SimpleClause leftArgument = "status">
<StringClause stringPredicate = "Equal">Approved</StringClause>
</SimpleClause>
</Clause>
</CompoundClause>
</Clause>
</RegistryEntryFilter>
</RegistryEntryQuery>
</FilterQuery>
</AdhocQueryRequest>
2441
8.2.4 AssociationQuery
2442
Purpose
2443
To identify a set of association instances as the result of a query over selected registry metadata.
2444
2445
ebRIM Binding
Association
Registry
Object
 Figure 28: ebRIM Binding for AssociationQuery
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
Definition
<complexType name = "AssociationQueryType">
<complexContent>
<extension base = "tns:RegistryObjectQueryType">
<sequence>
<element ref = "tns:AssociationFilter" minOccurs = "0" maxOccurs = "1"/>
</sequence>
</extension>
</complexContent>
Copyright © OASIS, 2002. All Rights Reserved
Page 75 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
</complexType>
<element name = "AssociationQuery" type = "tns:AssociationQueryType"/>
2470
Semantic Rules
2471
2472
1. Let A denote the set of all persistent Association instances in the Registry. The following
steps will eliminate instances in A that do not satisfy the conditions of the specified filters.
<element name="AssociationQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:Association" />
</choice>
</complexType>
</element>
2473
a) If A is empty then continue to the next numbered rule.
2474
2475
2476
2477
b) If an AssociationFilter element is not directly contained in the AssociationQuery element,
then go to the next step; otherwise let x be an association instance in A. If x does not
satisfy the AssociationFilter then remove x from A. If A is empty then continue to the
next numbered rule.
2478
2479
c) Let A be the set of remaining Association instances. Evaluate inherited
RegistryObjectQuery over A as explained in Section 8.2.2.
2480
2481
2. If A is empty, then raise the warning: association query result is empty; otherwise, set A to
be the result of the AssociationQuery.
2482
2483
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2484
Examples
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
A client application wishes to identify a set of associations that are ‘equivalentTo’ a set of other
associations.
<AdhocQueryRequest">
<ResponseOption returnType="LeafClass" />
<FilterQuery>
<AssociationQuery>
<SourceAssociationBranch>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument="associationType">
<StringClause stringPredicate="Equal">EquivalentTo</StringClause>
</SimpleClause>
</Clause>
</AssociationFilter>
<AssociationQuery>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument="associationType">
<StringClause stringPredicate="StartsWith">Sin</StringClause>
</SimpleClause>
Copyright © OASIS, 2002. All Rights Reserved
Page 76 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
</Clause>
</AssociationFilter>
</AssociationQuery>
</SourceAssociationBranch>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument="associationType">
<StringClause stringPredicate="StartsWith">Son</StringClause>
</SimpleClause>
</Clause>
</AssociationFilter>
</AssociationQuery>
</FilterQuery>
</AdhocQueryRequest>
2521
8.2.5 AuditableEventQuery
2522
Purpose
2523
2524
To identify a set of auditable event instances as the result of a query over selected registry
metadata.
2525
ebRIM Binding
Auditable Event
Registry
Object
Registry
Object
Registry
Entry
User
Postal
Address
Telephone
Number
Organization
 Figure 29: ebRIM Binding for AuditableEventQuery
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
Definition
<complexType name="AuditableEventQueryType">
<complexContent>
<extension base="tns:RegistryObjectQueryType">
<sequence>
<element ref="tns:AuditableEventFilter" minOccurs="0" />
<element ref="tns:RegistryObjectQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryEntryQuery" minOccurs="0" maxOccurs="1" />
<element ref="tns:UserBranch" minOccurs="0" maxOccurs="1" />
</sequence>
</extension>
</complexContent>
Copyright © OASIS, 2002. All Rights Reserved
Page 77 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
</complexType>
<element name="AuditableEventQuery" type="tns:AuditableEventQueryType" />
2553
Semantic Rules
2554
2555
2556
1. Let AE denote the set of all persistent AuditableEvent instances in the Registry. The
following steps will eliminate instances in AE that do not satisfy the conditions of the
specified filters.
<element name="AuditableEventQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:AuditableEvent" />
</choice>
</complexType>
</element>
2557
a) If AE is empty then continue to the next numbered rule.
2558
2559
2560
b) If an AuditableEventFilter is not specified then go to the next step; otherwise, let x be an
auditable event in AE. If x does not satisfy the AuditableEventFilter, then remove x from
AE. If AE is empty then continue to the next numbered rule.
2561
2562
2563
2564
2565
c) If a RegistryObjectQuery element is not specified then go to the next step; otherwise, let
x be a remaining auditable event in AE. Treat RegistryObjectQuery element as follows:
Let RO be the result set of the RegistryObjectQuery as defined in Section 8.2.2. If x is
not an auditable event for some registry object in RO, then remove x from AE. If AE is
empty then continue to the next numbered rule.
2566
2567
2568
2569
2570
d) If a RegistryEntryQuery element is not specified then go to the next step; otherwise, let x
be a remaining auditable event in AE. Treat RegistryEntryQuery element as follows: Let
RE be the result set of the RegistryEntryQuery as defined in Section 8.2.3. If x is not an
auditable event for some registry entry in RE, then remove x from AE. If AE is empty
then continue to the next numbered rule.
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
e) If a UserBranch element is not specified then go to the next step; otherwise, let x be a
remaining auditable event in AE. Let u be the user instance that invokes x. If a UserFilter
element is specified within the UserBranch, and if u does not satisfy that filter, then
remove x from AE. If a PostalAddressFilter element is specified within the UserBranch,
and if the postal address of u does not satisfy that filter, then remove x from AE. If
TelephoneNumberFilter(s) are specified within the UserBranch and if any of the
TelephoneNumberFilters isn’t satisfied by all of the telephone numbers of u then remove
x from AE. If EmailAddressFilter(s) are specified within the UserBranch and if any of
the EmailAddressFilters isn’t satisfied by all of the email addresses of u then remove x
from AE. If an OrganizationQuery element is specified within the UserBranch, then let o
be the Organization instance that is identified by the organization that u is affiliated with.
If o doesn’t satisfy OrganizationQuery as defined in Section 8.2.11 then remove x from
AE. If AE is empty then continue to the next numbered rule.
2584
2585
f) Let AE be the set of remaining AuditableEvent instances. Evaluate inherited
RegistryObjectQuery over AE as explained in Section 8.2.2.
Copyright © OASIS, 2002. All Rights Reserved
Page 78 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2586
2587
2. If AE is empty, then raise the warning: auditable event query result is empty; otherwise set
AE to be the result of the AuditableEventQuery.
2588
2589
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2590
Examples
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
A Registry client has registered an item and it has been assigned a name "urn:path:myitem". The
client is now interested in all events since the beginning of the year that have impacted that item.
The following query will return a set of AuditableEvent instances for all such events.
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
A client company has many registered objects in the Registry. The Registry allows events
submitted by other organizations to have an impact on your registered items, e.g. new
classifications and new associations. The following query will return a set of identifiers for all
auditable events, invoked by some other party, that had an impact on an item submitted by
“myorg”.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<AuditableEventQuery>
<AuditableEventFilter>
<Clause>
<SimpleClause leftArgument = "timestamp">
<RationalClause logicalPredicate = "GE">
DateTimeClause>2000-01-01T00:00:00-05:00</DateTimeClause>
</RationalClause>
</SimpleClause>
</Clause>
</AuditableEventFilter>
<RegistryEntryQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">urn:path:myitem</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</RegistryEntryQuery>
</AuditableEventQuery>
</FilterQuery>
</AdhocQueryRequest
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<AuditableEventQuery>
<RegistryEntryQuery>
<TargetAssociationBranch>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument = "associationType">
Copyright © OASIS, 2002. All Rights Reserved
Page 79 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
<StringClause stringPredicate = "Equal">SubmitterOf</StringClause>
</SimpleClause>
</Clause>
</AssociationFilter>
<OrganizationQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">myorg</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</OrganizationQuery>
</TargetAssociationBranch>
</RegistryEntryQuery>
<UserBranch>
<OrganizationQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "-Equal">myorg</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</OrganizationQuery>
</UserBranch>
</AuditableEventQuery>
</FilterQuery>
</AdhocQueryRequest>
2672
8.2.6 ClassificationQuery
2673
Purpose
2674
2675
To identify a set of classification instances as the result of a query over selected registry
metadata.
2676
ebRIM Binding
Classification
Registry
Object
Registry Object
Registry
Entry
Classification
Scheme
2677
Classification
Node
 Figure 30: ebRIM Binding for ClassificationQuery
Copyright © OASIS, 2002. All Rights Reserved
Page 80 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
Definition
2705
Semantic Rules
2706
2707
1. Let C denote the set of all persistent Classification instances in the Registry. The following
steps will eliminate instances in C that do not satisfy the conditions of the specified filters.
<complexType name = "ClassificationQueryType">
<complexContent>
<extension base = "tns:RegistryObjectQueryType">
<sequence>
<element ref = "tns:ClassificationFilter" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:ClassificationSchemeQuery" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:ClassificationNodeQuery" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:RegistryObjectQuery" minOccurs = "0" maxOccurs="1"/>
<element ref = "tns:RegistryEntryQuery" minOccurs = "0" maxOccurs="1"/>
</sequence>
</extension>
</complexContent>
</complexType>
<element name = "ClassificationQuery" type = "tns:ClassificationQueryType"/>
<element name="ClassificationQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:Classification" />
</choice>
</complexType>
</element>
2708
a) If C is empty then continue to the next numbered rule.
2709
2710
2711
2712
b) If a ClassificationFilter element is not directly contained in the ClassificationQuery
element, then go to the next step; otherwise let x be an classification instance in C. If x
does not satisfy the ClassificationFilter then remove x from C. If C is empty then
continue to the next numbered rule.
2713
2714
2715
2716
c) If a ClassificationSchemeQuery is not specified then go to the next step; otherwise, let x
be a remaining classification in C. If the defining classification scheme of x does not
satisfy the ClassificationSchemeQuery as defined in Section 8.2.8, then remove x from C.
If C is empty then continue to the next numbered rule.
2717
2718
2719
2720
d) If a ClassificationNodeQuery is not specified then go to the next step; otherwise, let x be
a remaining classification in C. If the classification node of x does not satisfy the
ClassificationNodeQuery as defined in Section 8.2.7, then remove x from C. If C is
empty then continue to the next numbered rule.
2721
2722
2723
2724
2725
e) If a RegistryObjectQuery element is not specified then go to the next step; otherwise, let
x be a remaining classification in C. Treat RegistryObjectQuery element as follows: Let
RO be the result set of the RegistryObjectQuery as defined in Section 8.2.2. If x is not a
classification of at least one registry object in RO, then remove x from C. If C is empty
then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 81 of 167
OASIS/ebXML Registry Services Specification v2.0
2726
2727
2728
2729
2730
March 2016
f) If a RegistryEntryQuery element is not specified then go to the next step; otherwise, let x
be a remaining classification in C. Treat RegistryEntryQuery element as follows: Let RE
be the result set of the RegistryEntryQuery as defined in Section 8.2.3. If x is not a
classification of at least one registry entry in RE, then remove x from C. If C is empty
then continue to the next numbered rule.
2731
2732
2. If C is empty, then raise the warning: classification query result is empty; otherwise
otherwise, set C to be the result of the ClassificationQuery.
2733
2734
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2735
8.2.7 ClassificationNodeQuery
2736
Purpose
2737
2738
To identify a set of classification node instances as the result of a query over selected registry
metadata.
2739
ebRIM Binding
Classification
Node
Registry
Object
Parent
Classification
Scheme
Classification
Node
Classification
Node
 Figure 31: ebRIM Binding for ClassificationNodeQuery
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
Children
Definition
<complexType name="ClassificationNodeQueryType">
<complexContent>
<extension base="tns:RegistryObjectQueryType">
<sequence>
<element ref="tns:ClassificationNodeFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:ClassificationSchemeQuery" minOccurs="0" maxOccurs="1" />
<element name="ClassificationNodeParentBranch" type="ClassificationNodeQueryType" minOccurs="0"
maxOccurs="1" />
<element name="ClassificationNodeChildrenBranch" type="ClassificationNodeQueryType"
minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="ClassificationNodeQuery" type="tns:ClassificationNodeQueryType" />
Copyright © OASIS, 2002. All Rights Reserved
Page 82 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
<element name="ClassificationNodeQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:ClassificationNode" />
</choice>
</complexType>
</element>
2769
Semantic Rules
2770
2771
2772
1. Let CN denote the set of all persistent ClassificationNode instances in the Registry. The
following steps will eliminate instances in CN that do not satisfy the conditions of the
specified filters.
2773
a) If CN is empty then continue to the next numbered rule.
2774
2775
2776
b) If a ClassificationNodeFilter is not specified then go to the next step; otherwise, let x be a
classification node in CN. If x does not satisfy the ClassificationNodeFilter then remove
x from CN. If CN is empty then continue to the next numbered rule.
2777
2778
2779
2780
c) If a ClassificationSchemeQuery is not specified then go to the next step; otherwise, let x
be a remaining classification node in CN. If the defining classification scheme of x does
not satisfy the ClassificationSchemeQuery as defined in Section 8.2.8, then remove x
from CN. If CN is empty then continue to the next numbered rule.
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
d) If a ClassificationNodeParentBranch element is not specified, then go to the next step;
otherwise, let x be a remaining classification node in CN and execute the following
paragraph with n=x.
Let n be a classification node instance. If n does not have a parent node (i.e. if n is a base
level node), then remove x from CN and go to the next step; otherwise, let p be the parent
node of n. If a ClassificationNodeFilter element is directly contained in the
ClassificationNodeParentBranch and if p does not satisfy the ClassificationNodeFilter,
then remove x from CN. If CN is empty then continue to the next numbered rule. If a
ClassificationSchemeQuery element is directly contained in the
ClassificationNodeParentBranch and if defining classification scheme of p does not
satisfy the ClassificationSchemeQuery, then remove x from CN. If CN is empty then
continue to the next numbered rule.
If another ClassificationNodeParentBranch element is directly contained within this
ClassificationNodeParentBranch element, then repeat the previous paragraph with n=p.
2795
2796
2797
2798
2799
2800
e) If a ClassificationNodeChildrenBranch element is not specified, then continue to the next
numbered rule; otherwise, let x be a remaining classification node in CN. If x is not the
parent node of some ClassificationNode instance, then remove x from CN and if CN is
empty continue to the next numbered rule; otherwise, treat each
ClassificationNodeChildrenBranch element separately and execute the following
paragraph with n = x.
Copyright © OASIS, 2002. All Rights Reserved
Page 83 of 167
OASIS/ebXML Registry Services Specification v2.0
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
March 2016
Let n be a classification node instance. If a ClassificationNodeFilter element is not
specified within the ClassificationNodeChildrenBranch element then let CNC be the set
of all classification nodes that have n as their parent node; otherwise, let CNC be the set
of all classification nodes that satisfy the ClassificationNodeFilter and have n as their
parent node. If CNC is empty, then remove x from CN and if CN is empty continue to the
next numbered rule; otherwise, let c be any member of CNC. If a
ClassificationSchemeQuery element is directly contained in the
ClassificationNodeChildrenBranch and if the defining classification scheme of c does not
satisfy the ClassificationSchemeQuery then remove c from CNC. If CNC is empty then
remove x from CN. If CN is empty then continue to the next numbered rule; otherwise,
let y be an element of CNC and continue with the next paragraph.
If the ClassificationNodeChildrenBranch element is terminal, i.e. if it does not directly
contain another ClassificationNodeChildrenBranch element, then continue to the next
numbered rule; otherwise, repeat the previous paragraph with the new
ClassificationNodeChildrenBranch element and with n = y.
f) Let CN be the set of remaining ClassificationNode instances. Evaluate inherited
RegistryObjectQuery over CN as explained in Section 8.2.2.
2818
2819
2. If CN is empty, then raise the warning: classification node query result is empty; otherwise
set CN to be the result of the ClassificationNodeQuery.
2820
2821
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2822
Path Filter Expression usage in ClassificationNodeFilter
2823
2824
2825
The path filter expression is used to match classification nodes in ClassificationNodeFilter
elements involving the path attribute of the ClassificationNode class as defied by the getPath
method in [ebRIM].
2826
2827
The path filter expressions are based on a very small and proper sub-set of location path syntax
of XPath.
2828
2829
2830
2831
The path filter expression syntax includes support for matching multiple nodes by using wild
card syntax as follows:
 Use of ‘*’ as a wildcard in place of any path element in the pathFilter
 Use of ‘//’ syntax to denote any descendent of a node in the pathFilter
2832
2833
2834
2835
2836
2837
2838
2839
It is defined by the following BNF grammar:
2840
2841
2842
In the above grammer, schemeId is the id attribute of the ClassificationScheme instance. In the
above grammar nodeCode is defined by NCName production as defined by
http://www.w3.org/TR/REC-xml-names/#NT-NCName.
2843
2844
2845
The semantic rules for the ClassificationNodeFilter element allow the use of path attribute as a
filter that is based on the EQUAL clause. The pattern specified for matching the EQUAL clause
is a PATH Filter expression.
pathFilter ::= '/' schemeId nodePath
nodePath ::= slashes nodeCode
| slashes ‘*’
| slashes nodeCode ( nodePath )?
Slashes ::= ‘/’ | ‘//’
Copyright © OASIS, 2002. All Rights Reserved
Page 84 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
This is illustrated in the following example that matches all second level nodes in
ClassificationScheme with id ‘Geography-id’ and with code ‘Japan’:
2859
Use Cases and Examples of Path Filter Expressions
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
The following table lists various use cases and examples using the sample Geography scheme
below:
<ClassificationNodeQuery>
<ClassificationNodeFilter>
<Clause>
<SimpleClause leftArgument = "path">
<StringClause stringPredicate = "Equal">//Geography-id/*/Japan</StringClause>
</SimpleClause>
</Clause>
</ClassificationNodeFilter>
</ClassificationNodeQuery>
<ClassificationScheme id='Geography-id' name="Geography”/>
<ClassificationNode id="NorthAmerica-id" parent="Geography-id" code=NorthAmerica" />
<ClassificationNode id="UnitedStates-id" parent="NorthAmerica-id" code="UnitedStates" />
<ClassificationNode id="Asia-id" parent="Geography-id" code="Asia" />
<ClassificationNode id="Japan-id" parent="Asia-id" code="Japan" />
<ClassificationNode id="Tokyo-id" parent="Japan-id" code="Tokyo" />
 Table 8: Path Filter Expressions for Use Cases
2872
Use Case
PATH Expression
Description
Match all nodes in first
level that have a specified
value
/Geography-id/NorthAmerica
Find all children of first
level node whose code is
“NorthAmerica”
Match all nodes whose first level
/Geography-id/NorthAmerica/* path element has code
"NorthAmerica"
Match all nodes that have
a specified value
regardless of level
/ Geography-id//Japan
Find all nodes with code ''Japan”
Match all nodes in the
second level that have a
specified value
/Geography-id/*/Japan
Find all second level nodes with
code 'Japan'
Match all nodes in the
3rd level that have a
specified value
/ Geography-id/*/*/Tokyo
Find all third level nodes with
code 'Tokyo'
Find all first level nodes whose
code is 'NorthAmerica'
2873
Examples
2874
2875
A client application wishes to identify all of the classification nodes in the first three levels of a
classification scheme hierarchy. The client knows that the name of the underlying classification
Copyright © OASIS, 2002. All Rights Reserved
Page 85 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
scheme is “urn:ebxml:cs:myscheme”. The following query identifies all nodes at the first three
levels.
2907
2908
If, instead, the client wishes all levels returned, they could simply delete the
ClassificationNodeFilter element from the query.
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
The following query finds all children nodes of a first level node whose code is NorthAmerica.
2926
2927
2928
2929
2930
The following query finds all third level nodes with code of Tokyo.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<ClassificationNodeQuery>
<ClassificationNodeFilter>
<Clause>
<SimpleClause leftArgument = "levelNumber">
<RationalClause logicalPredicate = "LE">
<IntClause>3</IntClause>
</RationalClause>
</SimpleClause>
</Clause>
</ClassificationNodeFilter>
<ClassificationSchemeQuery>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">urn:ebxml:cs:myscheme</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</ClassificationSchemeQuery>
</ClassificationNodeQuery>
</FilterQuery>
</AdhocQueryRequest>
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<ClassificationNodeQuery>
<ClassificationNodeFilter>
<Clause>
<SimpleClause leftArgument = "path">
<StringClause stringPredicate = "Equal">/Geography-id/NorthAmerica/*</StringClause>
</SimpleClause>
</Clause>
</ClassificationNodeFilter>
</ClassificationNodeQuery>
</FilterQuery>
</AdhocQueryRequest>
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass" returnComposedObjects = "True"/>
<FilterQuery>
Copyright © OASIS, 2002. All Rights Reserved
Page 86 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
<ClassificationNodeQuery>
<ClassificationNodeFilter>
<Clause>
<SimpleClause leftArgument = "path">
<StringClause stringPredicate = "Equal">/Geography-id/*/*/Tokyo</StringClause>
</SimpleClause>
</Clause>
</ClassificationNodeFilter>
</ClassificationNodeQuery>
</FilterQuery>
</AdhocQueryRequest>
2943
8.2.8 ClassificationSchemeQuery
2944
Purpose
2945
2946
To identify a set of classification scheme instances as the result of a query over selected registry
metadata.
2947
ebRIM Binding
Classification Scheme
Registry
Entry
 Figure 32: ebRIM Binding for ClassificationSchemeQuery
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
Definition
2962
Semantic Rules
2963
2964
2965
1. Let CS denote the set of all persistent ClassificationScheme instances in the Registry. The
following steps will eliminate instances in CS that do not satisfy the conditions of the
specified filters.
<complexType name="ClassificationSchemeQueryType">
<complexContent>
<extension base="tns:RegistryEntryQueryType">
<sequence>
<element ref="tns:ClassificationSchemeFilter" minOccurs="0" maxOccurs="1" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="ClassificationSchemeQuery" type="tns:ClassificationSchemeQueryType" />
2966
a) If CS is empty then continue to the next numbered rule.
2967
2968
2969
b) If a ClassificationSchemeFilter is not specified then go to the next step; otherwise, let x
be a classification scheme in CS. If x does not satisfy the ClassificationSchemeFilter,
then remove x from CS. If CS is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 87 of 167
OASIS/ebXML Registry Services Specification v2.0
2970
2971
March 2016
c) Let CS be the set of remaining ClassificationScheme instances. Evaluate inherited
RegistryEntryQuery over CS as explained in Section 8.2.3.
2972
2973
2. If CS is empty, then raise the warning: classification scheme query result is empty; otherwise,
set CS to be the result of the ClassificationSchemeQuery.
2974
2975
3. Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
2976
Examples
2977
2978
2979
2980
2981
2982
2983
A client application wishes to identify all classification scheme instances in the Registry.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<ClassificationSchemeQuery/>
</FilterQuery>
</AdhocQueryRequest>
2984
2985
8.2.9 RegistryPackageQuery
2986
Purpose
2987
2988
To identify a set of registry package instances as the result of a query over selected registry
metadata.
2989
ebRIM Binding
Registry
Package
Registry
Entry
Registry
Object
 Figure 33: ebRIM Binding for RegistryPackageQuery
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
Registry
Entry
Definition
<complexType name="RegistryPackageQueryType">
<complexContent>
<extension base="tns:RegistryEntryQueryType">
<sequence>
<element ref="tns:RegistryPackageFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:RegistryObjectQuery" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:RegistryEntryQuery" minOccurs="0" maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="RegistryPackageQuery" type="tns:RegistryPackageQueryType" />
<element name="RegistryPackageQueryResult">
Copyright © OASIS, 2002. All Rights Reserved
Page 88 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryEntry" />
<element ref="rim:RegistryObject" />
<element ref="rim:RegistryPackage" />
</choice>
</complexType>
</element>
3017
Semantic Rules
3018
3019
3020
1. Let RP denote the set of all persistent RegistryPackage instances in the Registry. The
following steps will eliminate instances in RP that do not satisfy the conditions of the
specified filters.
3021
a)
If RP is empty then continue to the next numbered rule.
3022
3023
3024
3025
b)
If a RegistryPackageFilter is not specified, then continue to the next numbered rule;
otherwise, let x be a registry package instance in RP. If x does not satisfy the
RegistryPackageFilter then remove x from RP. If RP is empty then continue to the next
numbered rule.
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
c)
If a RegistryObjectQuery element is directly contained in the RegistryPackageQuery
element then treat each RegistryObjectQuery as follows: let RO be the set of
RegistryObject instances returned by the RegistryObjectQuery as defined in Section 8.2.2
and let PO be the subset of RO that are members of the package x. If PO is empty, then
remove x from RP. If RP is empty then continue to the next numbered rule. If a
RegistryEntryQuery element is directly contained in the RegistryPackageQuery element
then treat each RegistryEntryQuery as follows: let RE be the set of RegistryEntry
instances returned by the RegistryEntryQuery as defined in Section 8.2.3 and let PE be
the subset of RE that are members of the package x. If PE is empty, then remove x from
RP. If RP is empty then continue to the next numbered rule.
3036
3037
d)
Let RP be the set of remaining RegistryPackage instances. Evaluate inherited
RegistryEntryQuery over RP as explained in Section 8.2.3.
3038
3039
2.
If RP is empty, then raise the warning: registry package query result is empty; otherwise set
RP to be the result of the RegistryPackageQuery.
3040
3041
3.
Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
3042
Examples
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
A client application wishes to identify all package instances in the Registry that contain an
Invoice extrinsic object as a member of the package.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<RegistryPackageQuery>
<RegistryEntryQuery>
<RegistryEntryFilter>
<Clause>
Copyright © OASIS, 2002. All Rights Reserved
Page 89 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
<SimpleClause leftArgument = "objectType">
<StringClause stringPredicate = "Equal">Invoice</StringClause>
</SimpleClause>
</Clause>
</RegistryEntryFilter>
</RegistryEntryQuery>
</RegistryPackageQuery>
</FilterQuery>
</AdhocQueryRequest>
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
A client application wishes to identify all package instances in the Registry that are not empty.
3074
3075
3076
3077
3078
3079
A client application wishes to identify all package instances in the Registry that are empty. Since
the RegistryPackageQuery is not set up to do negations, clients will have to do two separate
RegistryPackageQuery requests, one to find all packages and another to find all non-empty
packages, and then do the set difference themselves. Alternatively, they could do a more
complex RegistryEntryQuery and check that the packaging association between the package and
its members is non-existent.
3080
3081
3082
3083
Note: A registry package is an intrinsic RegistryEntry instance that is completely determined by
its associations with its members. Thus a RegistryPackageQuery can always be re-specified as an
equivalent RegistryEntryQuery using appropriate “Source” and “Target” associations. However,
the equivalent RegistryEntryQuery is often more complicated to write.
3084
8.2.10 ExtrinsicObjectQuery
3085
Purpose
3086
3087
To identify a set of extrinsic object instances as the result of a query over selected registry
metadata.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<RegistryPackageQuery>
<RegistryObjectQuery/>
</RegistryPackageQuery>
</FilterQuery>
</AdhocQueryRequest>
Extrinsic Object
Registry
Entry
3088
3089
ebRIM Binding
3090
3091
Definition
 Figure 34: ebRIM Binding for ExtrinsicObjectQuery
Copyright © OASIS, 2002. All Rights Reserved
Page 90 of 167
OASIS/ebXML Registry Services Specification v2.0
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
<complexType name="ExtrinsicObjectQueryType">
<complexContent>
<extension base="tns:RegistryEntryQueryType">
<sequence>
<element ref="tns:ExtrinsicObjectFilter" minOccurs="0" maxOccurs="1" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="ExtrinsicObjectQuery" type="tns:ExtrinsicObjectQueryType" />
3114
Semantic Rules
3115
3116
3117
1.
March 2016
<element name="ExtrinsicObjectQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryEntry" />
<element ref="rim:RegistryObject" />
<element ref="rim:ExtrinsicObject" />
</choice>
</complexType>
</element>
Let EO denote the set of all persistent ExtrinsicObject instances in the Registry. The
following steps will eliminate instances in EO that do not satisfy the conditions of the
specified filters.
3118
a) If EO is empty then continue to the next numbered rule.
3119
3120
3121
b) If a ExtrinsicObjectFilter is not specified then go to the next step; otherwise, let x be an
extrinsic object in EO. If x does not satisfy the ExtrinsicObjectFilter then remove x from
EO. If EO is empty then continue to the next numbered rule.
3122
3123
c) Let EO be the set of remaining ExtrinsicObject instances. Evaluate inherited
RegistryEntryQuery over EO as explained in Section 8.2.3.
3124
3125
2.
If EO is empty, then raise the warning: extrinsic object query result is empty; otherwise, set
EO to be the result of the ExtrinsicObjectQuery.
3126
3127
3.
Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
3128
8.2.11 OrganizationQuery
3129
Purpose
3130
3131
To identify a set of organization instances as the result of a query over selected registry
metadata.
3132
ebRIM Binding
Copyright © OASIS, 2002. All Rights Reserved
Page 91 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
Organization
Registry
Object
Parent
Children
Organization
Organization
Postal
Address
Postal
Address
User
Organization
Telephone
Number
Telephone
Number
 Figure 35: ebRIM Binding for OrganizationQuery
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
Definition
3164
Semantic Rules
3165
3166
3167
1. Let ORG denote the set of all persistent Organization instances in the Registry. The
following steps will eliminate instances in ORG that do not satisfy the conditions of the
specified filters.
3168
<complexType name="OrganizationQueryType">
<complexContent>
<extension base="tns:RegistryObjectQueryType">
<sequence>
<element ref="tns:OrganizationFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:PostalAddressFilter" minOccurs="0" maxOccurs="1" />
<element ref="tns:TelephoneNumberFilter" minOccurs="0" maxOccurs="unbounded" />
<element ref="tns:UserBranch" minOccurs="0" maxOccurs="1" />
<element name="OrganizationParentBranch" type="tns:OrganizationQueryType" minOccurs="0
" maxOccurs="1" />
<element name="OrganizationChildrenBranch" type="tns:OrganizationQueryType" minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="OrganizationQuery" type="tns:OrganizationQueryType" />
<element name="OrganizationQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:Organization" />
</choice>
</complexType>
</element>
a)
If ORG is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 92 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3169
3170
3171
3172
b)
If an OrganizationFilter element is not directly contained in the OrganizationQuery
element, then go to the next step; otherwise let x be an organization instance in ORG. If x
does not satisfy the OrganizationFilter then remove x from ORG. If ORG is empty then
continue to the next numbered rule.
3173
3174
3175
3176
c)
If a PostalAddressFilter element is not directly contained in the OrganizationQuery
element then go to the next step; otherwise, let x be an extrinsic object in ORG. If postal
address of x does not satisfy the PostalAddressFilter then remove x from ORG. If ORG is
empty then continue to the next numbered rule.
3177
3178
3179
3180
d)
If no TelephoneNumberFilter element is directly contained in the OrganizationQuery
element then go to the next step; otherwise, let x be an extrinsic object in ORG. If any of
the TelephoneNumberFilters isn’t satisfied by all of the telephone numbers of x then
remove x from ORG. If ORG is empty then continue to the next numbered rule.
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
e)
If a UserBranch element is not directly contained in the OrganizationQuery element then
go to the next step; otherwise, let x be an extrinsic object in ORG. Let u be the user
instance that is affiliated with x. If a UserFilter element is specified within the
UserBranch, and if u does not satisfy that filter, then remove x from ORG. If a
PostalAddressFilter element is specified within the UserBranch, and if the postal address
of u does not satisfy that filter, then remove x from ORG. If TelephoneNumberFilter(s)
are specified within the UserBranch and if any of the TelephoneNumberFilters isn’t
satisfied by all of the telephone numbers of x then remove x from ORG. If
EmailAddressFilter(s) are specified within the UserBranch and if any of the
EmailAddressFilters isn’t satisfied by all of the email addresses of x then remove x from
ORG. If an OrganizationQuery element is specified within the UserBranch, then let o be
the Organization instance that is identified by the organization that u is affiliated with. If
o doesn’t satisfy OrganizationQuery as defined in Section 8.2.11 then remove x from
ORG. If ORG is empty then continue to the next numbered rule.
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
f)
If a OrganizationParentBranch element is not specified within the OrganizationQuery,
then go to the next step; otherwise, let x be an extrinsic object in ORG. Execute the
following paragraph with o = x:
Let o be an organization instance. If an OrganizationFilter is not specified within the
OrganizationParentBranch and if o has no parent (i.e. if o is a root organization in the
Organization hierarchy), then remove x from ORG; otherwise, let p be the parent
organization of o. If p does not satisfy the OrganizationFilter, then remove x from ORG.
If ORG is empty then continue to the next numbered rule.
If another OrganizationParentBranch element is directly contained within this
OrganizationParentBranch element, then repeat the previous paragraph with o = p.
3205
3206
3207
3208
3209
g)
If a OrganizationChildrenBranch element is not specified, then continue to the next
numbered rule; otherwise, let x be a remaining organization in ORG. If x is not the parent
node of some organization instance, then remove x from ORG and if ORG is empty
continue to the next numbered rule; otherwise, treat each OrganizationChildrenBranch
element separately and execute the following paragraph with n = x.
Copyright © OASIS, 2002. All Rights Reserved
Page 93 of 167
OASIS/ebXML Registry Services Specification v2.0
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
March 2016
Let n be an organization instance. If an OrganizationFilter element is not specified within
the OrganizationChildrenBranch element then let ORGC be the set of all organizations
that have n as their parent node; otherwise, let ORGC be the set of all organizations that
satisfy the OrganizationFilter and have n as their parent node. If ORGC is empty, then
remove x from ORG and if ORG is empty continue to the next numbered rule; otherwise,
let c be any member of ORGC. If a PostalAddressFilter element is directly contained in
the OrganizationChildrenBranch and if the postal address of c does not satisfy the
PostalAddressFilter then remove c from ORGC. If ORGC is empty then remove x from
ORG. If ORG is empty then continue to the next numbered rule. If no
TelephoneNumberFilter element is directly contained in the OrganizationChildrenBranch
and if any of the TelephoneNumberFilters isn’t satisfied by all of the telephone numbers
of c then remove c from ORGC. If ORGC is empty then remove x from ORG. If ORG is
empty then continue to the next numbered rule; otherwise, let y be an element of ORGC
and continue with the next paragraph.
If the OrganizationChildrenBranch element is terminal, i.e. if it does not directly contain
another OrganizationChildrenBranch element, then continue to the next numbered rule;
otherwise, repeat the previous paragraph with the new OrganizationChildrenBranch
element and with n = y.
3228
3229
h)
Let ORG be the set of remaining Organization instances. Evaluate inherited
RegistryObjectQuery over ORG as explained in Section 8.2.2.
3230
3231
2.
If ORG is empty, then raise the warning: organization query result is empty; otherwise set
ORG to be the result of the OrganizationQuery.
3232
3233
3.
Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
3234
Examples
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
A client application wishes to identify a set of organizations, based in France, that have
submitted a PartyProfile extrinsic object this year.
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass" returnComposedObjects = "True”/>
<FilterQuery>
<OrganizationQuery>
<SourceAssociationBranch>
<AssociationFilter>
<Clause>
<SimpleClause leftArgument = "associationType">
<StringClause stringPredicate = "Equal">SubmitterOf</StringClause>
</SimpleClause>
</Clause>
</AssociationFilter>
<RegistryObjectQuery>
<RegistryObjectFilter>
<Clause>
<SimpleClause leftArgument = "objectType">
<StringClause stringPredicate = "Equal">CPP</StringClause>
</SimpleClause>
</Clause>
</RegistryObjectFilter>
<AuditableEventQuery>
Copyright © OASIS, 2002. All Rights Reserved
Page 94 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
<AuditableEventFilter>
<Clause>
<SimpleClause leftArgument = "timestamp">
<RationalClause logicalPredicate = "GE">
<DateTimeClause>2000-01-01T00:00:00-05:00</DateTimeClause>
</RationalClause>
</SimpleClause>
</Clause>
</AuditableEventFilter>
</AuditableEventQuery>
</RegistryObjectQuery>
</SourceAssociationBranch>
<PostalAddressFilter>
<Clause>
<SimpleClause leftArgument = "country">
<StringClause stringPredicate = "Equal">France</StringClause>
</SimpleClause>
</Clause>
</PostalAddressFilter>
</OrganizationQuery>
</FilterQuery>
</AdhocQueryRequest>
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
A client application wishes to identify all organizations that have Corporation named XYZ as a
parent.
3304
8.2.12 ServiceQuery
3305
3306
3307
Purpose
3308
ebRIM Binding
<AdhocQueryRequest>
<ResponseOption returnType = "LeafClass"/>
<FilterQuery>
<OrganizationQuery>
<OrganizationParentBranch>
<NameBranch>
<LocalizedStringFilter>
<Clause>
<SimpleClause leftArgument = "value">
<StringClause stringPredicate = "Equal">XYZ</StringClause>
</SimpleClause>
</Clause>
</LocalizedStringFilter>
</NameBranch>
</OrganizationParentBranch>
</OrganizationQuery>
</FilterQuery>
</AdhocQueryRequest>
To identify a set of service instances as the result of a query over selected registry metadata.
Copyright © OASIS, 2002. All Rights Reserved
Page 95 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
Service
Registry Entry
Service Binding
Registry
Object
Registry
Entry
 Figure 36: ebRIM Binding for ServiceQuery
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
Definition
3336
Semantic Rules
3337
3338
1.
3339
Specification Link
<complexType name="ServiceQueryType">
<complexContent>
<extension base="tns:RegistryEntryQueryType">
<sequence>
<element ref="tns:ServiceFilter" minOccurs="0"
maxOccurs="1" />
<element ref="tns:ServiceBindingBranch" minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</extension>
</complexContent>
</complexType>
<element name="ServiceQuery" type="tns:ServiceQueryType" />
<element name="ServiceQueryResult">
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<element ref="rim:ObjectRef" />
<element ref="rim:RegistryObject" />
<element ref="rim:Service" />
</choice>
</complexType>
</element>
Let S denote the set of all persistent Service instances in the Registry. The following steps
will eliminate instances in S that do not satisfy the conditions of the specified filters.
a) If S is empty then continue to the next numbered rule.
Copyright © OASIS, 2002. All Rights Reserved
Page 96 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3340
3341
3342
b) If a ServicetFilter is not specified then go to the next step; otherwise, let x be a service in
S. If x does not satisfy the ServiceFilter, then remove x from S. If S is empty then
continue to the next numbered rule.
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
c) If a ServiceBindingBranch is not specified then continue to the next numbered rule;
otherwise, consider each ServiceBindingBranch element separately as follows:
Let SB be the set of all ServiceBinding instances that describe binding of x. Let sb be the
member of SB. If a ServiceBindingFilter element is specified within the
ServiceBindingBranch, and if sb does not satisfy that filter, then remove sb from SB. If
SB is empty then remove x from S. If S is empty then continue to the next numbered rule.
If a SpecificationLinkBranch is not specified within the ServiceBindingBranch then
continue to the next numbered rule; otherwise, consider each SpecificationLinkBranch
element separately as follows:
Let sb be a remaining service binding in SB. Let SL be the set of all specification link
instances sl that describe specification links of sb. If a SpecificationLinkFilter element is
specified within the SpecificationLinkBranch, and if sl does not satisfy that filter, then
remove sl from SL. If SL is empty then remove sb from SB. If SB is empty then remove
x from S. If S is empty then continue to the next numbered rule. If a RegistryObjectQuery
element is specified within the SpecificationLinkBranch then let sl be a remaining
specification link in SL. Treat RegistryObjectQuery element as follows: Let RO be the
result set of the RegistryObjectQuery as defined in Section 8.2.2. If sl is not a
specification link for some registry object in RO, then remove sl from SL. If SL is empty
then remove sb from SB. If SB is empty then remove x from S. If S is empty then
continue to the next numbered rule. If a RegistryEntryQuery element is specified within
the SpecificationLinkBranch then let sl be a remaining specification link in SL. Treat
RegistryEntryQuery element as follows: Let RE be the result set of the
RegistryEntryQuery as defined in Section 8.2.3. If sl is not a specification link for some
registry entry in RE, then remove sl from SL. If SL is empty then remove sb from SB. If
SB is empty then remove x from S. If S is empty then continue to the next numbered rule.
3368
3369
d) Let S be the set of remaining Service instances. Evaluate inherited RegistryEntryQuery
over AE as explained in Section 8.2.3.
3370
3371
2.
If S is empty, then raise the warning: service query result is empty; otherwise set S to be the
result of the ServiceQuery.
3372
3373
3.
Return the result and any accumulated warnings or exceptions (in the RegistryErrorList)
within the RegistryResponse.
3374
3375
Examples
3376
8.2.13 Registry Filters
3377
Purpose
3378
To identify a subset of the set of all persistent instances of a given registry class.
3379
3380
3381
Definition
<complexType name="FilterType">
Copyright © OASIS, 2002. All Rights Reserved
Page 97 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
<sequence>
<element ref="tns:Clause" />
</sequence>
</complexType>
<element name="RegistryObjectFilter" type="tns:FilterType" />
<element name="RegistryEntryFilter" type="tns:FilterType" />
<element name="ExtrinsicObjectFilter" type="tns:FilterType" />
<element name="RegistryPackageFilter" type="tns:FilterType" />
<element name="OrganizationFilter" type="tns:FilterType" />
<element name="ClassificationNodeFilter" type="tns:FilterType" />
<element name="AssociationFilter" type="tns:FilterType" />
<element name="ClassificationFilter" type="tns:FilterType" />
<element name="ClassificationSchemeFilter" type="tns:FilterType" />
<element name="ExternalLinkFilter" type="tns:FilterType" />
<element name="ExternalIdentifierFilter" type="tns:FilterType" />
<element name="SlotFilter" type="tns:FilterType" />
<element name="AuditableEventFilter" type="tns:FilterType" />
<element name="UserFilter" type="tns:FilterType" />
<element name="SlotValueFilter" type="tns:FilterType" />
<element name="PostalAddressFilter" type="tns:FilterType" />
<element name="TelephoneNumberFilter" type="tns:FilterType" />
<element name="EmailAddressFilter" type="tns:FilterType" />
<element name="ServiceFilter" type="tns:FilterType" />
<element name="ServiceBindingFilter" type="tns:FilterType" />
<element name="SpecificationLinkFilter" type="tns:FilterType" />
<element name="LocalizedStringFilter" type="tns:FilterType" />
3409
Semantic Rules
3410
1.
The Clause element is defined in Section 8.2.14.
3411
3412
3413
3414
3415
2.
For every RegistryObjectFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the RegistryObject UML class defined in
[ebRIM]. If not, raise exception: registry object attribute error. The RegistryObjectFilter
returns a set of identifiers for RegistryObject instances whose attribute values evaluate to
True for the Clause predicate.
3416
3417
3418
3419
3420
3.
For every RegistryEntryFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the RegistryEntry UML class defined in
[ebRIM]. If not, raise exception: registry entry attribute error. The RegistryEntryFilter
returns a set of identifiers for RegistryEntry instances whose attribute values evaluate to True
for the Clause predicate.
3421
3422
3423
3424
3425
4.
For every ExtrinsicObjectFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the ExtrinsicObject UML class defined in
[ebRIM]. If not, raise exception: extrinsic object attribute error. The ExtrinsicObjectFilter
returns a set of identifiers for ExtrinsicObject instances whose attribute values evaluate to
True for the Clause predicate.
3426
3427
3428
3429
3430
5.
For every RegistryPackageFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the RegistryPackage UML class defined in
[ebRIM]. If not, raise exception: package attribute error. The RegistryPackageFilter returns
a set of identifiers for RegistryPackage instances whose attribute values evaluate to True for
the Clause predicate.
Copyright © OASIS, 2002. All Rights Reserved
Page 98 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3431
3432
3433
3434
3435
6.
For every OrganizationFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the Organization or PostalAddress UML
classes defined in [ebRIM]. If not, raise exception: organization attribute error. The
OrganizationFilter returns a set of identifiers for Organization instances whose attribute
values evaluate to True for the Clause predicate.
3436
3437
3438
3439
3440
3441
3442
7.
For every ClassificationNodeFilter XML element, the leftArgument attribute of any
containing SimpleClause shall identify a public attribute of the ClassificationNode UML
class defined in [ebRIM]. If not, raise exception: classification node attribute error. If the
leftAttribute is the visible attribute “path” then if stringPredicate of the StringClause is not
“Equal” then raise exception: classification node path attribute error. The
ClassificationNodeFilter returns a set of identifiers for ClassificationNode instances whose
attribute values evaluate to True for the Clause predicate.
3443
3444
3445
3446
3447
8.
For every AssociationFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the Association UML class defined in
[ebRIM]. If not, raise exception: association attribute error. The AssociationFilter returns a
set of identifiers for Association instances whose attribute values evaluate to True for the
Clause predicate.
3448
3449
3450
3451
3452
9.
For every ClassificationFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the Classification UML class defined in
[ebRIM]. If not, raise exception: classification attribute error. The ClassificationFilter
returns a set of identifiers for Classification instances whose attribute values evaluate to True
for the Clause predicate.
3453
3454
3455
3456
3457
10.
For every ClassificationSchemeFilter XML element, the leftArgument attribute of any
containing SimpleClause shall identify a public attribute of the ClassificationNode UML
class defined in [ebRIM]. If not, raise exception: classification scheme attribute error. The
ClassificationSchemeFilter returns a set of identifiers for ClassificationScheme instances
whose attribute values evaluate to True for the Clause predicate.
3458
3459
3460
3461
3462
11.
For every ExternalLinkFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the ExternalLink UML class defined in
[ebRIM]. If not, raise exception: external link attribute error. The ExternalLinkFilter returns
a set of identifiers for ExternalLink instances whose attribute values evaluate to True for the
Clause predicate.
3463
3464
3465
3466
3467
12.
For every ExternalIdentiferFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the ExternalIdentifier UML class defined in
[ebRIM]. If not, raise exception: external identifier attribute error. The
ExternalIdentifierFilter returns a set of identifiers for ExternalIdentifier instances whose
attribute values evaluate to True for the Clause predicate.
3468
3469
3470
3471
13.
For every SlotFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the Slot UML class defined in [ebRIM]. If
not, raise exception: slot attribute error. The SlotFilter returns a set of identifiers for Slot
instances whose attribute values evaluate to True for the Clause predicate.
Copyright © OASIS, 2002. All Rights Reserved
Page 99 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3472
3473
3474
3475
3476
14.
For every AuditableEventFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the AuditableEvent UML class defined in
[ebRIM]. If not, raise exception: auditable event attribute error. The AuditableEventFilter
returns a set of identifiers for AuditableEvent instances whose attribute values evaluate to
True for the Clause predicate.
3477
3478
3479
3480
15.
For every UserFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the User UML class defined in [ebRIM]. If
not, raise exception: user attribute error. The UserFilter returns a set of identifiers for User
instances whose attribute values evaluate to True for the Clause predicate.
3481
3482
3483
3484
3485
3486
3487
3488
16.
SlotValue is a derived, non-persistent class based on the Slot class from ebRIM. There is one
SlotValue instance for each “value” in the “values” list of a Slot instance. The visible
attribute of SlotValue is“value”. It is a character string. The dynamic instances of SlotValue
are derived from the “values” attribute defined in ebRIM for a Slot instance. For every
SlotValueFilter XML element, the leftArgument attribute of any containing SimpleClause
shall identify the “value” attribute of the SlotValue class just defined. If not, raise exception:
slot element attribute error. The SlotValueFilter returns a set of Slot instances whose “value”
attribute evaluates to True for the Clause predicate.
3489
3490
3491
3492
3493
17.
For every PostalAddressFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the PostalAddress UML class defined in
[ebRIM]. If not, raise exception: postal address attribute error. The PostalAddressFilter
returns a set of identifiers for PostalAddress instances whose attribute values evaluate to True
for the Clause predicate.
3494
3495
3496
3497
3498
18.
For every TelephoneNumberFilter XML element, the leftArgument attribute of any
containing SimpleClause shall identify a public attribute of the TelephoneNumber UML
class defined in [ebRIM]. If not, raise exception: telephone number identity attribute error.
The TelephoneNumberFilter returns a set of identifiers for TelephoneNumber instances
whose attribute values evaluate to True for the Clause predicate.
3499
3500
3501
3502
3503
19.
For every EmailAddressFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the EmailAddress UML class defined in
[ebRIM]. If not, raise exception: email address attribute error. The EmailAddressFilter
returns a set of identifiers for EmailAddresss instances whose attribute values evaluate to
True for the Clause predicate.
3504
3505
3506
3507
20.
For every ServiceFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the Service UML class defined in [ebRIM].
If not, raise exception: service attribute error. The ServiceFilter returns a set of identifiers for
Service instances whose attribute values evaluate to True for the Clause predicate.
3508
3509
3510
3511
3512
21.
For every ServiceBindingFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the ServiceBinding UML class defined in
[ebRIM]. If not, raise exception: service binding attribute error. The ServiceBindingFilter
returns a set of identifiers for ServiceBinding instances whose attribute values evaluate to
True for the Clause predicate.
Copyright © OASIS, 2002. All Rights Reserved
Page 100 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3513
3514
3515
3516
3517
22.
For every SpecificationLinkFilter XML element, the leftArgument attribute of any
containing SimpleClause shall identify a public attribute of the SpecificationLink UML class
defined in [ebRIM]. If not, raise exception: specification link attribute error. The
SpecificationLinkFilter returns a set of identifiers for SpecificationLink instances whose
attribute values evaluate to True for the Clause predicate.
3518
3519
3520
3521
3522
23.
For every LocalizedStringFilter XML element, the leftArgument attribute of any containing
SimpleClause shall identify a public attribute of the LocalizedString UML class defined in
[ebRIM]. If not, raise exception: localized string attribute error. The LocalizedStringFilter
returns a set of identifiers for LocalizedString instances whose attribute values evaluate to
True for the Clause predicate.
3523
8.2.14 XML Clause Constraint Representation
3524
Purpose
3525
3526
3527
The simple XML FilterQuery utilizes a formal XML structure based on Predicate Clauses.
Predicate Clauses are utilized to formally define the constraint mechanism, and are referred to
simply as Clauses in this specification.
3528
Conceptual Diagram
3529
The following is a conceptual diagram outlining the Clause structure.
3530
3531
3532
 Figure 37: The Clause Structure
Copyright © OASIS, 2002. All Rights Reserved
Page 101 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3533
Semantic Rules
3534
3535
3536
Predicates and Arguments are combined into a "LeftArgument - Predicate - RightArgument"
format to form a Clause. There are two types of Clauses: SimpleClauses and CompoundClauses.
3537
3538
3539
3540
A SimpleClause always defines the leftArgument as a text string, sometimes referred to as the
Subject of the Clause. SimpleClause itself is incomplete (abstract) and must be extended.
SimpleClause is extended to support BooleanClause, StringClause, and RationalClause
(abstract).
3541
3542
3543
3544
3545
3546
3547
BooleanClause implicitly defines the predicate as ‘equal to’, with the right argument as a
boolean. StringClause defines the predicate as an enumerated attribute of appropriate stringcompare operations and a right argument as the element’s text data. Rational number support is
provided through a common RationalClause providing an enumeration of appropriate rational
number compare operations, which is further extended to IntClause and FloatClause, each with
appropriate signatures for the right argument.
3548
3549
A CompoundClause contains two or more Clauses (Simple or Compound) and a connective
predicate. This provides for arbitrarily complex Clauses to be formed.
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
Definition
SimpleClauses
CompoundClauses
<element name = "Clause">
<annotation>
<documentation xml:lang = "en">
The following lines define the XML syntax for Clause.
</documentation>
</annotation>
<complexType>
<choice>
<element ref = "tns:SimpleClause"/>
<element ref = "tns:CompoundClause"/>
</choice>
</complexType>
</element>
<element name = "SimpleClause">
<complexType>
<choice>
<element ref = "tns:BooleanClause"/>
<element ref = "tns:RationalClause"/>
<element ref = "tns:StringClause"/>
</choice>
<attribute name = "leftArgument" use = "required" type = "string"/>
</complexType>
</element>
<element name = "CompoundClause">
<complexType>
<sequence>
<element ref = "tns:Clause" maxOccurs = "unbounded"/>
</sequence>
<attribute name = "connectivePredicate" use = "required">
<simpleType>
<restriction base = "NMTOKEN">
Copyright © OASIS, 2002. All Rights Reserved
Page 102 of 167
OASIS/ebXML Registry Services Specification v2.0
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
March 2016
<enumeration value = "And"/>
<enumeration value = "Or"/>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
<element name = "BooleanClause">
<complexType>
<attribute name = "booleanPredicate" use = "required" type = "boolean"/>
</complexType>
</element>
<element name = "RationalClause">
<complexType>
<choice>
<element ref = "tns:IntClause"/>
<element ref = "tns:FloatClause"/>
<element ref = "tns:DateTimeClause"/>
</choice>
<attribute name = "logicalPredicate" use = "required">
<simpleType>
<restriction base = "NMTOKEN">
<enumeration value = "LE"/>
<enumeration value = "LT"/>
<enumeration value = "GE"/>
<enumeration value = "GT"/>
<enumeration value = "EQ"/>
<enumeration value = "NE"/>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
<element name = "IntClause" type = "integer"/>
<element name = "FloatClause" type = "float"/>
<element name = "DateTimeClause" type = "dateTime"/>
<element name = "StringClause">
<complexType>
<simpleContent>
<extension base = "string">
<attribute name = "stringPredicate" use = "required">
<simpleType>
<restriction base = "NMTOKEN">
<enumeration value = "Contains"/>
<enumeration value = "-Contains"/>
<enumeration value = "StartsWith"/>
<enumeration value = "-StartsWith"/>
<enumeration value = "Equal"/>
<enumeration value = "-Equal"/>
<enumeration value = "EndsWith"/>
<enumeration value = "-EndsWith"/>
</restriction>
</simpleType>
</attribute>
</extension>
</simpleContent>
</complexType>
Copyright © OASIS, 2002. All Rights Reserved
Page 103 of 167
OASIS/ebXML Registry Services Specification v2.0
3642
3643
March 2016
</element>
3644
Examples
3645
3646
3647
3648
3649
3650
3651
3652
Simple BooleanClause: "Smoker" = True
3653
3654
3655
3656
3657
3658
3659
Simple StringClause: "Smoker" contains "mo"
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
Simple IntClause: "Age" >= 7
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
Simple FloatClause: "Size" = 4.3
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
Compound with two Simples (("Smoker" = False)AND("Age" =< 45))
<Clause>
<SimpleClause leftArgument="Smoker">
<BooleanClause booleanPredicate="True"/>
</SimpleClause>
</Clause>
<Clause>
<SimpleClause leftArgument = "Smoker">
<StringClause stringPredicate = "Contains">mo</StringClause>
</SimpleClause>
<Clause>
<Clause>
<SimpleClause leftArgument="Age">
<RationalClause logicalPredicate="GE">
<IntClause>7</IntClause>
</RationalClause>
</SimpleClause>
</Clause>
<Clause>
<SimpleClause leftArgument="Size">
<RationalClause logicalPredicate="Equal">
<FloatClause>4.3</FloatClause>
</RationalClause>
</SimpleClause>
</Clause>
<Clause>
<CompoundClause connectivePredicate="And">
<Clause>
<SimpleClause leftArgument="Smoker">
<BooleanClause booleanPredicate="False"/>
</SimpleClause>
</Clause>
<Clause>
<SimpleClause leftArgument="Age">
<RationalClause logicalPredicate="LE">
<IntClause>45</IntClause>
Copyright © OASIS, 2002. All Rights Reserved
Page 104 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3693
3694
3695
3696
3697
3698
</RationalClause>
</SimpleClause>
</Clause>
</CompoundClause>
</Clause>
3699
Coumpound with one Simple and one Compound
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
( ("Smoker" = False)And(("Age" =< 45)Or("American"=True)) )
3728
8.3 SQL Query Support
3729
Need to update storedProcedures.sql, database.sql??
3730
3731
3732
3733
The Registry may optionally support an SQL based query capability that is designed for Registry
clients that demand more advanced query capability. The optional SQLQuery element in the
AdhocQueryRequest allows a client to submit complex SQL queries using a declarative query
language.
3734
3735
3736
3737
3738
3739
The syntax for the SQLQuery of the Registry is defined by a stylized use of a proper subset of
the “SELECT” statement of Entry level SQL defined by ISO/IEC 9075:1992, Database
Language SQL [SQL], extended to include <sql invoked routines> (also known as
stored procedures) as specified in ISO/IEC 9075-4 [SQL-PSM] and pre-defined routines defined
in template form in Appendix D.3. The syntax of the Registry query language is defined by the
BNF grammar in D.1.
3740
3741
Note that the use of a subset of SQL syntax for SQLQuery does not imply a requirement to use
relational databases in a Registry implementation.
<Clause>
<CompoundClause connectivePredicate="And">
<Clause>
<SimpleClause leftArgument="Smoker">
<BooleanClause booleanPredicate="False"/>
</SimpleClause>
</Clause>
<Clause>
<CompoundClause connectivePredicate="Or">
<Clause>
<SimpleClause leftArgument="Age">
<RationalClause logicalPredicate="LE">
<IntClause>45</IntClause>
</RationalClause>
</SimpleClause>
</Clause>
<Clause>
<SimpleClause leftArgument="American">
<BooleanClause booleanPredicate="True"/>
</SimpleClause>
</Clause>
</CompoundClause>
</Clause>
</CompoundClause>
<Clause>
Copyright © OASIS, 2002. All Rights Reserved
Page 105 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3742
8.3.1 SQL Query Syntax Binding To [ebRIM]
3743
3744
3745
SQL Queries are defined based upon the query syntax in in Appendix D.1 and a fixed relational
schema defined in Appendix D.3. The relational schema is an algorithmic binding to [ebRIM] as
described in the following sections.
3746
8.3.1.1
3747
3748
3749
A subset of the class names defined in [ebRIM] map to table names that may be queried by an
SQL query. Appendix D.3 defines the names of the ebRIM classes that may be queried by an
SQL query.
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
The algorithm used to define the binding of [ebRIM] classes to table definitions in Appendix D.3
is as follows:
 Classes that have concrete instances are mapped to relational tables. In addition entity classes
(e.g. PostalAddress and TelephoneNumber) are also mapped to relational tables.
 The intermediate classes in the inheritance hierarchy, namely RegistryObject and
RegistryEntry, map to relational views.
 The names of relational tables and views are the same as the corresponding [ebRIM] class
name. However, the name binding is case insensitive.
 Each [ebRIM] class that maps to a table in Appendix D.3 includes column definitions in
Appendix D.3 where the column definitions are based on a subset of attributes defined for
that class in [ebRIM]. The attributes that map to columns include the inherited attributes for
the [ebRIM] class. Comments in Appendix D.3 indicate which ancestor class contributed
which column definitions.
3763
3764
An SQLQuery against a table not defined in Appendix D.3 may raise an error condition:
InvalidQueryException.
3765
3766
The following sections describe the algorithm for mapping attributes of [ebRIM] to SQLcolumn
definitions.
3767
8.3.1.2
3768
3769
3770
3771
3772
Attributes defined by [ebRIM] that are of primitive types (e.g. String) may be used in the same
way as column names in SQL. Again the exact attribute names are defined in the class
definitions in [ebRIM]. Note that while names are in mixed case, SQL-92 is case insensitive. It is
therefore valid for a query to contain attribute names that do not exactly match the case defined
in [ebRIM].
3773
8.3.1.3
3774
3775
3776
A few of the [ebRIM] class attributes are of type UUID and are a reference to an instance of a
class defined by [ebRIM]. For example, the accessControlPolicy attribute of the RegistryObject
class returns a reference to an instance of an AccessControlPolicy object.
3777
3778
3779
In such cases the reference maps to the id attribute for the referenced object. The name of the
resulting column is the same as the attribute name in [ebRIM] as defined by 8.3.1.2. The data
type for the column is VARCHAR(64) as defined in Appendix D.3.
3780
3781
When a reference attribute value holds a null reference, it maps to a null value in the SQL
binding and may be tested with the <null specification> (“IS [NOT] NULL” syntax) as defined
Class Binding
Primitive Attributes Binding
Reference Attribute Binding
Copyright © OASIS, 2002. All Rights Reserved
Page 106 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3782
by [SQL].
3783
Reference attribute binding is a special case of a primitive attribute mapping.
3784
8.3.1.4
3785
3786
3787
3788
3789
3790
3791
3792
3793
A few of the [ebRIM] interfaces define attributes that are not primitive types. Instead they are of
a complex type as defined by an entity class in [ebRIM]. Examples include attributes of type
TelephoneNumber, Contact, PersonName etc. in class Organization and class User.
The SQL query schema does not map complex attributes as columns in the table for the class for
which the attribute is defined. Instead the complex attributes are mapped to columns in the table
for the domain class that represents the data type for the complex attribute (e.g.
TelephoneNumber). A column links the row in the domain table to the row in the parent table
(e.g. User). An additional column named ‘attribute_name’ identifies the attribute name in the
parent class, in case there are multiple attributes with the same complex attribute type.
3794
3795
3796
3797
This mapping also easily allows for attributes that are a collection of a complex type. For
example, a User may have a collection of TelephoneNumbers. This maps to multiple rows in the
TelephoneNumber table (one for each TelephoneNumber) where each row has a parent identifier
and an attribute_name.
3798
8.3.1.5
3799
3800
3801
3802
Several of the [ebRIM] classes define methods in addition to attributes, where these methods
return collections of references to instances of classes defined by [ebRIM]. For example, the
getPackages method of the RegistryObject class returns a Collection of references to instances of
Packages that the object is a member of.
3803
3804
3805
Such collection returning methods in [ebRIM] classes have been mapped to stored procedures in
Appendix D.3 such that these stored procedures return a collection of id attribute values. The
returned value of these stored procedures can be treated as the result of a table sub-query in SQL.
3806
3807
These stored procedures may be used as the right-hand-side of an SQL IN clause to test for
membership of an object in such collections of references.
3808
8.3.2 Semantic Constraints On Query Syntax
3809
3810
3811
This section defines simplifying constraints on the query syntax that cannot be expressed in the
BNF for the query syntax. These constraints must be applied in the semantic analysis of the
query.
3812
1. Class names and attribute names must be processed in a case insensitive manner.
3813
3814
2. The syntax used for stored procedure invocation must be consistent with the syntax of an
SQL procedure invocation as specified by ISO/IEC 9075-4 [SQL/PSM].
3815
3816
3. For this version of the specification, the SQL select column list consists of exactly one
column, and must always be t.id, where t is a table reference in the FROM clause.
3817
8.3.3 SQL Query Results
3818
3819
The result of an SQL query resolves to a collection of objects within the registry. It never
resolves to partial attributes. The objects related to the result set may be returned as an
Complex Attribute Binding
Binding of Methods Returning Collections
Copyright © OASIS, 2002. All Rights Reserved
Page 107 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3820
3821
3822
3823
ObjectRef, RegistryObject, RegistryEntry or leaf ebRIM class depending upon the returnType
attribute of the responseOption parameter specified by the client on the AdHocQueryRequest.
The entire result set is returned as a SQLQueryResult as defined by the AdHocQueryResponse in
Section 8.1.
3824
8.3.4 Simple Metadata Based Queries
3825
3826
The simplest form of an SQL query is based upon metadata attributes specified for a single class
within [ebRIM]. This section gives some examples of simple metadata based queries.
3827
3828
3829
3830
3831
3832
3833
3834
For example, to retrieve the collection of ExtrinsicObjects whose name contains the word
‘Acme’ and that have a version greater than 1.3, the following query must be submitted:
3835
3836
Note that the query syntax allows for conjugation of simpler predicates into more complex
queries as shown in the simple example above.
3837
8.3.5 RegistryObject Queries
3838
3839
3840
The schema for the SQL query defines a view called RegistryObject that allows doing a
polymorphic query against all RegistryObject instances regardless of their actual concrete type or
table name.
3841
3842
3843
3844
3845
3846
3847
3848
3849
The following example is similar to the example in Section 8.3.4 except that it is applied against
all RegistryObject instances rather than just ExtrinsicObject instances. The result set will include
id for all qualifying RegistryObject instances whose name contains the word ‘Acme’ and whose
description contains the word “bicycle”.
3850
8.3.6 RegistryEntry Queries
3851
3852
3853
The schema for the SQL query defines a view called RegistryEntry that allows doing a
polymorphic query against all RegistryEntry instances regardless of their actual concrete type or
table name.
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
The following example is the same as the example in Section 8.3.4 except that it is applied
against all RegistryEntry instances rather than just ExtrinsicObject instances. The result set will
include id for all qualifying RegistryEntry instances whose name contains the word ‘Acme’ and
that have a version greater than 1.3.
SELECT eo.id from ExtrinsicObject eo, Name nm where nm.value LIKE '%Acme%' AND
eo.id = nm.parent AND
eo.majorVersion >= 1 AND
(eo.majorVersion >= 2 OR eo.minorVersion > 3);
SELECT ro.id from RegistryObject ro, Name nm, Description d where nm.value LIKE '%Acme%' AND
d.value LIKE '%bicycle%' AND
ro.id = nm.parent AND ro.id = d.parent;
SELECT re.id from RegistryEntry re, Name nm where nm.value LIKE '%Acme%' AND
re.id = nm.parent AND
re.majorVersion >= 1 AND
(re.majorVersion >= 2 OR re.minorVersion > 3);
Copyright © OASIS, 2002. All Rights Reserved
Page 108 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3864
8.3.7 Classification Queries
3865
This section describes various classification related queries.
3866
8.3.7.1
3867
3868
3869
3870
ClassificationNodes are identified by their ID, as are all objects in [ebRIM]. However, they may
also be identified as a path attribute that specifies an XPATH expression [XPT] from a root
classification node to the specified classification node in the XML document that would
represent the ClassificationNode tree including the said ClassificationNode.
3871
8.3.7.2
3872
3873
3874
3875
The following query retrieves the collection of ClassificationSchemes :
3876
3877
The above query returns all ClassificationSchemes. Note that the above query may also specify
additional predicates (e.g. name, description etc.) if desired.
3878
8.3.7.3
3879
3880
3881
3882
The following query retrieves the children of a ClassificationNode given the ID of that node:
3883
3884
The above query returns all ClassificationNodes that have the node specified by <id> as their
parent attribute.
3885
8.3.7.4
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
The following query retrieves the collection of ExtrinsicObjects classified by specified
ClassificationNodes:
3901
3902
3903
3904
The above query retrieves the collection of ExtrinsicObjects that are classified by the
Automotive Industry and the Japan Geography. Note that according to the semantics defined for
GetClassifiedObjectsRequest, the query will also contain any objects that are classified by
descendents of the specified ClassificationNodes.
3905
8.3.7.5
3906
3907
3908
3909
3910
The following query retrieves the collection of Classifications that classify a specified Object:
Identifying ClassificationNodes
Retrieving ClassificationSchemes
SELECT scheme.id FROM ClassificationScheme scheme;
Retrieving Children of Specified ClassificationNode
SELECT cn.id FROM ClassificationNode cn WHERE parent = <id>
Retrieving Objects Classified By a ClassificationNode
SELECT id FROM ExtrinsicObject
WHERE
id IN (SELECT classifiedObject FROM Classification
WHERE
classificationNode IN (SELECT id FROM ClassificationNode
WHERE path = “/Geography/Asia/Japan’))
AND
id IN (SELECT classifiedObject FROM Classification
WHERE
classificationNode IN (SELECT id FROM ClassificationNode
WHERE path = ‘/Industry/Automotive’))
Retrieving Classifications That Classify an Object
SELECT id FROM Classification c
WHERE c.classifiedObject = <id>;
Copyright © OASIS, 2002. All Rights Reserved
Page 109 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3911
8.3.8 Association Queries
3912
This section describes various Association related queries.
3913
8.3.8.1
3914
3915
3916
3917
3918
The following query retrieves the collection of Associations that have the specified Object as its
source:
3919
8.3.8.2
3920
3921
3922
3923
3924
The following query retrieves the collection of Associations that have the specified Object as its
target:
3925
8.3.8.3
3926
3927
The following query retrieves the collection of Associations that have specified Association
attributes:
3928
3929
3930
3931
Select Associations that have the specified name.
3932
3933
3934
3935
3936
3937
Select Associations that have the specified association type, where association type is a string
containing the corresponding field name described in [ebRIM].
3938
8.3.8.4
3939
3940
3941
3942
3943
3944
3945
3946
3947
The various forms of Association queries may be combined into complex predicates. The
following query selects Associations that have a specific sourceObject, targetObject and
associationType:
3948
8.3.9 Package Queries
3949
3950
3951
3952
The following query retrieves all Packages that a specified RegistryObject belongs to:
3953
8.3.9.1
3954
3955
The following query retrieves all Packages that a specified object belongs to, that are not
deprecated and where name contains "RosettaNet."
Retrieving All Association With Specified Object As Its Source
SELECT id FROM Association WHERE sourceObject = <id>
Retrieving All Association With Specified Object As Its Target
SELECT id FROM Association WHERE targetObject = <id>
Retrieving Associated Objects Based On Association Attributes
SELECT id FROM Association WHERE name = <name>
SELECT id FROM Association WHERE
associationType = <associationType>
Complex Association Queries
SELECT id FROM Association WHERE
sourceObject = <id1> AND
targetObject = <id2> AND
associationType = <associationType>;
SELECT id FROM Package WHERE id IN (RegistryObject_registryPackages(<id>));
Complex Package Queries
Copyright © OASIS, 2002. All Rights Reserved
Page 110 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3956
3957
3958
3959
3960
3961
SELECT id FROM Package p, Name n WHERE
p.id IN (RegistryObject_registryPackages(<id>)) AND
nm.value LIKE '%RosettaNet%' AND nm.parent = p.id AND
p.status <> ‘Deprecated’
3962
8.3.10 ExternalLink Queries
3963
3964
3965
3966
The following query retrieves all ExternalLinks that a specified ExtrinsicObject is linked to:
3967
3968
3969
3970
The following query retrieves all ExtrinsicObjects that are linked by a specified ExternalLink:
3971
8.3.10.1 Complex ExternalLink Queries
3972
3973
3974
3975
3976
3977
3978
3979
The following query retrieves all ExternalLinks that a specified ExtrinsicObject belongs to, that
contain the word ‘legal’ in their description and have a URL for their externalURI.
3980
8.3.11 Audit Trail Queries
3981
3982
3983
3984
The following query retrieves all the AuditableEvents for a specified RegistryObject:
3985
8.4 Content Retrieval
3986
Need to use new format??
3987
3988
3989
3990
A client retrieves content via the Registry by sending the GetContentRequest to the
QueryManager. The GetContentRequest specifies a list of ObjectRefs for Objects that need to be
retrieved. The QueryManager returns the specified content by sending a GetContentResponse
message to the RegistryClient interface of the client.
3991
3992
If there are no errors encountered, the GetContentResponse message includes the specified
content(s) as mime multipart attachment(s) within the message.
3993
3994
If there are errors encountered, the RegistryResponse payload includes the errors and there are
no additional mime multipart attachments.
3995
8.4.1 Identification Of Content Payloads
3996
3997
3998
Since the GetContentResponse message may include several repository items as additional
payloads, it is necessary to have a way to identify each mime multipart attachment in the
message. To facilitate this identification, the Registry must do the following:
SELECT id From ExternalLink WHERE id IN (RegistryObject_externalLinks(<id>))
SELECT id From ExtrinsicObject WHERE id IN (RegistryObject_linkedObjects(<id>))
SELECT id FROM ExternalLink WHERE
id IN (RegistryObject_externalLinks(<id>)) AND
description LIKE ‘%legal%’ AND
externalURI LIKE ‘%http://%’
SELECT id FROM AuditableEvent WHERE
Copyright © OASIS, 2002. All Rights Reserved
registryObject = <id>
Page 111 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
3999
4000
4001
4002
4003

4004
8.4.2 GetContentResponse Message Structure
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
The following message fragment illustrates the structure of the GetContentResponse Message
that is returning a Collection of Collaboration Protocol Profiles as a result of a
GetContentRequest that specified the IDs for the requested objects. Note that the boundary
parameter in the Content-Type headers in the example below are meant to be illustrative not
prescriptive.

Use the ID of the ExtrinsicObject instance as the value of the Content-ID header parameter
for the mime multipart that contains the corresponding repository item for the
ExtrinsicObject.
In case of [ebMS] transport, use the ID of the ExtrinsicObject instance in the Reference
element for that object in the Manifest element of the ebXMLHeader.
Content-type: multipart/related; boundary="MIME_boundary"; type="text/xml";
--MIME_boundary
Content-ID: <GetContentRequest@example.com>
Content-Type: text/xml
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'
xmlns:eb= 'http://www.oasis-open.org/committees/ebxml-msg/schema/draft-msg-header-03.xsd'>
<SOAP-ENV:Header>
<!--ebMS header goes here if using ebMS-->
...
<ds:Signature ...>
<!--signature over soap envelope-->
...
</ds:Signature>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<!--ebMS manifest goes here if using ebMS-->
...
<?xml version="1.0" encoding="UTF-8"?>
<GetContentResponse>
<ObjectRefList>
<ObjectRef id="urn:uuid:d8163dfb-f45a-4798-81d9-88aca29c24ff"/>
<ObjectRef id="urn:uuid:212c3a78-1368-45d7-acc9-a935197e1e4f"/>
</ObjectRefList>
</GetContentResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
--MIME_boundary
Content-ID: urn:uuid:d8163dfb-f45a-4798-81d9-88aca29c24ff
Content-Type: Multipart/Related; boundary=payload1_boundary; type=text/xml
Content-Description: Optionally describe payload1 here
--payload1_boundary
Content-Type: text/xml; charset=UTF-8
Content-ID: signature:urn:uuid:d8163dfb-f45a-4798-81d9-88aca29c24ff
<ds:Signature ...>
... Signature for payload1
</ds:Signature>
Copyright © OASIS, 2002. All Rights Reserved
Page 112 of 167
OASIS/ebXML Registry Services Specification v2.0
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
March 2016
--payload1_boundary
Content-ID: urn:uuid:d8163dfb-f45a-4798-81d9-88aca29c24ff
Content-Type: text/xml
<?xml version="1.0" encoding="UTF-8"?>
<tp:CollaborationProtocolProfile ...>
.....
</tp:CollaborationProtocolProfile>
--payload1_boundary---MIME_boundary
Content-ID: urn:uuid:212c3a78-1368-45d7-acc9-a935197e1e4f
Content-Type: Multipart/Related; boundary=payload2_boundary; type=text/xml
Content-Description: Optionally describe payload2 here
--payload2_boundary
Content-Type: text/xml; charset=UTF-8
Content-ID: signature:urn:uuid:212c3a78-1368-45d7-acc9-a935197e1e4f
<ds:Signature ...>
... Signature for payload2
</ds:Signature>
--payload2_boundary
Content-ID: urn:uuid:212c3a78-1368-45d7-acc9-a935197e1e4f
Content-Type: text/xml
<?xml version="1.0" encoding="UTF-8"?>
<tp:CollaborationProtocolProfile ...>
.....
</tp:CollaborationProtocolProfile>
--payload2_boundary---MIME_boundary--
Copyright © OASIS, 2002. All Rights Reserved
Page 113 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4100
9 Content Management Services
4101
Fix pictures, schema for index to catalog name change??
4102
4103
4104
4105
This chapter describes the Content-based discovery facility of the ebXML Registry. This facility
enables clients to discover repository items based upon the content contained within the
repository item. The Content-based discovery facility is a required normative feature of ebXML
Registries compliant to version 3 or later of this specification.
4106
4107
4108
4109
4110
4111
4112
The essence of the content-based discovery feature is based upon the ability to selectively
convert repository item content into metadata consisting of instances of RegistryObject subclasses (RegistryObject Metadata).
A registry uses one or more Content Cataloguing Services to automatically catalog repository
items. Cataloguing a repository item creates and/or updates RegistryObject metadata such as
ExtrinsicObject or Classification instances. The catalogued metadata enables clients to discover
the repository item using existing query capabilities of the registry.
4113
9.1 Content Cataloging: Use Cases
4114
There are many scenarios where content-based discovery is necessary.
4115
9.1.1 Find All CPPs Where Role is “Buyer”
4116
4117
A company that sells a product using the RosettaNet PIP3A4 Purchase Order process wants to
find CPPs for other companies where the Role element of the CPP is that of “Buyer”.
4118
9.1.2 Find All XML Schema’s That Use Specified Namespace
4119
4120
A client may wish to discover all XML Schema documents in the registry that use an XML
namespace containing the word “oasis”.
4121
9.1.3 Find All WSDL Descriptions with a SOAP Binding
4122
4123
4124
An ebXML registry client is attempting to discover all repository items that are WSDL
descriptions that have a SOAP binding defined. Note that SOAP binding related information is
content within the WSDL document and not metadata.
4125
9.2 Content Cataloguing Service
4126
4127
4128
4129
4130
4131
Figure 38 shows that conceptually, a Content Cataloguing Service (or Cataloguing Service)
accepts as input a repository item and generates as output one or more RegistryObject Metadata
instances that are used to catalog the ExtrinsicObject for that repository item. In addition a
Cataloging Service accepts as control input a Catalog Definition File, which is also a repository
item.
Copyright © OASIS, 2002. All Rights Reserved
Page 114 of 167
OASIS/ebXML Registry Services Specification v2.0
4132
4133
March 2016
 Figure 38: Abstract Content Cataloguing Service: Inputs and Outputs
4134
9.2.1 Illustrative Example
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
Figure 39 shows a UML instance diagram to illustrate how a Content Cataloguing Service is
used. The Content Cataloguing Service is the normative Default XML Cataloguing Service
described in section 9.10.
o In the center we see a Content Cataloguing Service name defaultXMLCataloging Service.
o On the left we see a CPP repository item and its ExtrinsicObject inputExtObjForCPP
being input as Content to the defaultXMLCataloging Service.
o On top we see an XSLT style sheet repository item and its ExtrinsicObject being sent as a
Catalog Definition File to the defaultXMLCataloging Service.
o On the right we see the outputExtObjForCPP, which is the modified ExtrinsicObject for
the CPP. We also see a Classification roleClassification, which classifies the CPP by the
Role element within the CPP. These are the Catalog Metadata generated as a result of the
Cataloging Service cataloguing the CPP.
Copyright © OASIS, 2002. All Rights Reserved
Page 115 of 167
OASIS/ebXML Registry Services Specification v2.0
4147
4148
March 2016
 Figure 39: Example of CPP cataloguing using Default XML Cataloging Service
4149
9.3 Catalog Definition File
4150
4151
4152
4153
4154
4155
The Catalog Definition File describes the information that the Cataloging Service must extract
from the repository item and subsequently map it to the generated RegistryObject Metadata. This
specification does not define the format of the Catalog Definition File. Each Cataloging Service
is free to define its own Catalog Definition File format in a Cataloging Service specific manner.
The only constraint in this specification is that the Catalog Definition File must be a repository
item.
4156
9.4 Content To Be Cataloged
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
This specification does not define the format of content to be Cataloged. This specification
describes how a client may register arbitrary Cataloging Services for cataloguing arbitrary
content types.
The most common use case for a Cataloging Service is for cataloguing XML documents.
Therefore, this specification also provides a normative definition for a specialized XML Content
Cataloging Service in section 9.10.
An ebXML Registry must provide native built-in support for the normative default XML Content
Cataloging Service.
In addition, an ebXML Registry may optionally allow clients to register arbitrary Cataloging
Services for arbitrary content. In either case the registry must use the appropriate Cataloging
Service if one exists, to catalog a repository item when it is submitted.
Copyright © OASIS, 2002. All Rights Reserved
Page 116 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4168
9.5 Catalog Metadata
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
A content cataloguing service catalogs a repository item by processing it and extracting specific
information content as specified by the Catalog Definition File. The content cataloguing service
must map the extracted content to catalog metadata in form of instances of RIM classes.
For example, the catalog metadata may consists of:
o Classification instances
o ExternalIdentifier instances
o ExternalLink instances
o The name attribute for the ExtrinsicObject for the content to be Cataloged
o The description attribute for the ExtrinsicObject for the content to be Cataloged
A Content Cataloguing Service may generate any class defined by RIM as catalog metadata in an
application specific manner.
4180
9.6 Content Cataloguing Protocol
4181
4182
4183
4184
4185
4186
4187
4188
The interface of the Content Cataloguing Service must implement a single method called
catalogContent. The catalogContent method accepts a CatalogContentRequest as parameter and
returns a CatalogContentResponse as its response if there are no errors.
The CatalogContentRequest contains repository items that need to be catalogued. The resulting
CatalogContentResponse contains the metadata that gets generated by the Content Cataloguing
Service as a result of cataloguing the specified repository items.
The content cataloguing protocol is abstract and does not specify the implementation details of
any specific Content Cataloguing Service.
4189
4190
 Figure 40: Content Cataloging Protocol
4191
9.6.1 CatalogContentRequest
4192
4193
The CatalogContentRequest is used to pass repository items to a Content Cataloguing Service so
that it can create catalog metadata for the specified repository items.
Copyright © OASIS, 2002. All Rights Reserved
Page 117 of 167
OASIS/ebXML Registry Services Specification v2.0
4194
9.6.1.1
Syntax:
4195
4196
4197
March 2016
 Figure 41: CatalogContentRequest Syntax
9.6.1.2
Parameters:
4198

id: Inherited request id attribute common to all requests.
4199
4200
4201
4202
4203
4204

CatalogExtrinsicObject: This parameter specifies the ExtrinsicObject for the
repository item that the caller wishes to specify as the Catalog Definition File.
This specification does not specify the format of this repository item. There must
be a corresponding repository item as an attachment to this request. The
corresponding repository item should follow the same rules as attachments in
SubmitObjectsRequest.
4205
4206
4207
4208
4209

SubjectExtrinsicObject: This parameter specifies the ExtrinsicObject for the
repository item that the caller wishes to be catalogued. This specification does not
specify the format of this repository item. There must be a corresponding
repository item as an attachment to this request. The corresponding repository
item should follow the same rules as attachments in SubmitObjectsRequest.
4210
4211
9.6.1.3
4212
This request returns an CatalogContentResponse. See section 9.6.2 for details.
4213
9.6.1.4
4214
In addition to the exceptions common to all requests, the following exceptions may be returned:
Returns:
Exceptions:
4215
4216

MissingRepositoryItemException: signifies that the caller did not provide a
required repository item as an attachment to this request.
4217
4218

UnsupportedCatalogException: signifies that this Content Cataloguing Service
did not support the CatalogExtrinsicObject provided by the client.
4219
4220

UnsupportedSubjectException: signifies that this Content Cataloguing Service did
not support the SubjectExtrinsicObject provided by the client.
4221
4222
9.6.2 CatalogContentResponse
4223
4224
The CatalogContentResponse is sent by the Content Cataloguing Service as a response to a
CatalogContentRequest.
4225
Copyright © OASIS, 2002. All Rights Reserved
Page 118 of 167
OASIS/ebXML Registry Services Specification v2.0
4226
9.6.2.1
Syntax:
4227
4228
4229
March 2016
 Figure 42: CatalogContentResponse Syntax
9.6.2.2
Parameters:
4230

id: id attribute inherited from RegistryResponseType.
4231
4232
4233
4234
4235
4236
4237
4238

CatalogMetadata: This parameter specifies a collection of RegistryObject
instances that were created as a result of dynamic content cataloguing by a
content cataloguing service. It may include a modified ExtrinsicObject for the
repository item that has been catalogued by the Content Cataloguing Service. The
Content Cataloguing Service may add metadata such as Classifications,
ExternalIdentifiers, name, description etc. to the CataloguedExtrinsicObject
element. There must not be an accompanying repository item as an attachment to
this response message.
4239
4240
9.7 Publishing a Content Cataloguing Service
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
Any publisher may publish an arbitrary Content Cataloguing Service to an ebXML Registry. The
Content Cataloguing Service must be published using the existing LifeCycleManager interface.
The publisher must use the existing SubmitObjectsRequest to publish:
o A Service instance that must have a required Association with associationType of
“CataloguingServiceFor”. In Figure 43 this is exemplified by the
defaultXMLCatalogingService in the upper-left corner. The Service must be the
sourceObject while a ClassificationNode in the canonical ObjectType
ClassificationScheme must be the targetObject.
o A ServiceBinding instance contained within the Service instance that must provide the
accessURI to the Cataloguing Service.
o An optional ExternalLink instance on the ServiceBinding that is resolvable to a web page
describing:
o The format of the supported content to be Cataloged
o The format of the supported Catalog Definition File
Note that no SpecificationLink is required since this specification is implicit for Content
Cataloguing Services.
o One or more Catalog Definition File(s) that must be an ExtrinsicObject and a repository
item pair. The ExtrinsicObject for the Catalog Definition must have a required
Association with associationType of “CatalogedefinitionFileFor”. In Figure 43 this is
exemplified by the cppCatalogingServiceXSLT and the oagBODCatalogingServiceXSLT
objects on the left side. The Service must be the sourceObject while a ClassificationNode
in the canonical ObjectType ClassificationScheme must be the targetObject.
Copyright © OASIS, 2002. All Rights Reserved
Page 119 of 167
OASIS/ebXML Registry Services Specification v2.0
4263
4264
4265
4266
4267
March 2016
o Zero or more ClassificationScheme(s) and ClassifiocationNodes(s) that may be
referenced (used) in the catalogued metadata generated by the Content Cataloguing
Service.
 Figure 43: Cataloguing Service Configuration
4268
4269
4270
4271
4272
4273
4274
4275
Figure 43 shows the configuration of the default XML Cataloging Service that is associated with
the objectType for XML content. This Cataloging Service may be used with any XML content
that has its objectType attribute reference the xmlObjectType ClassificationNode or one of its
descendents.
The figure also shows two different Catalog Definition Files, cppCataloging ServiceXSLT and
oagBODCataloging ServiceXSLT that may be used to catalog ebXML CPP and OAG Business
Object Documents (BOD) respectively.
4276
9.7.1 Multiple Cataloging Services and Catalog Definition Files
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
May need to change to allow multiple services to be invoked for generic Processing Service??
Vailidation service should be run before cataloguing, catloging before any other??
ValidationServiceFor, CatalogingServiceFor, XXXServiceFor asociationType??
This specification allows clients to submit multiple Cataloging Services and Catalog Definition
Files for the same objectType. How a registry handles multiple Cataloging Service and Catalog
Definition File submission for the same type of content is a matter of registry specific policy. If a
registry does not allow this then it must send an InvalidRequestException with a reason, when a
duplicate Cataloging Service or Catalog Definition File is submitted. If a registry allows this then
it must provide a conflict resolution mechanism to select the appropriate Cataloging Service and
Catalog Definition File in some registry specific manner.
Copyright © OASIS, 2002. All Rights Reserved
Page 120 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4287
9.7.2 Restrictions On Publishing Content Cataloguing Services
4288
4289
4290
4291
4292
4293
4294
4295
A client may submit any Content Cataloguing Service or Catalog Definition File. A registry may
use registry specific policies to determine whether a client submitted Content Cataloguing
Service or Catalog Definition File are acceptable. For example a registry may require that the
content cataloguing service or Catalog Definition File does not create excessive metadata. A
registry may reject a SubmitObjectRequest with an InvalidRequestException and give a reason
why the request was rejected, upon receiving requests publishing Content Cataloguing Service or
Catalog Definition File that is unreasonable. In effect support for user-defined Content
Cataloguing Services is optional in this version of the specification.
4296
9.8 Dynamic Content Cataloguing
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
Some time during or after a publisher submits a repository item, the registry must check to see if
there is a Content Cataloguing Service and Catalog Definition File registered for that type of
repository item. This is referred to as Content Cataloguing Service resolution and Catalog
Definition File resolution as described in section 9.8.2.
If a Content Cataloguing Service and Catalog Definition File are found then the registry must
invoke that service using the Content Cataloguing Protocol. In the invocation, it gives a
repository item as content to be Cataloged and a repository item as Catalog Definition File
within a CatalogContentRequest. The Content Cataloguing Service must catalog the content and
return the potentially modified ExtrinsicObject for the content to be Cataloged such that it has
catalog metadata generated from relevant portions of the content to be Cataloged.
The registry must store the repository item along with the potentially modified ExtrinsicObject
annotated with the catalog metadata once the Content Cataloguing Protocol is completed.
The result of dynamic Content Cataloguing is that content to be Cataloged gets catalogued
automatically as a consequence of being submitted. Once catalogued it is possible to use the
catalog metadata to do dynamic content-based discovery of the Cataloged content.
A registry may do dynamic content cataloguing synchronous with the original
SubmitObjectRequest request or it may do so asynchronously sometime after the request is
committed. A registry must declare the maximum latency between content submission and
content Cataloging in the catalogingLatency attribute of its Registry instance.
4316
9.8.1 Referential Integrity and Dynamic Content Cataloguing
4317
4318
A registry must maintain referential integrity between the RegistryObjects and repository items
in the submission and the generated RegistryObjects in the catalogued metadata.
4319
9.8.2 Error Handling Model for Dynamic Content Cataloguing
4320
4321
4322
4323
4324
4325
4326
Any errors generated during dynamic content cataloguing must not affect the storing of the
RegistryObjects and repository items that were submitted. Such cataloguing errors are internal
registry errors due to implementation errors or configuration errors.
A registry must return a normal response with status = “Success” if the submitted content and
metadata is stored successfully even when there are errors encountered during dynamic content
cataloguing. A registry should log such cataloguing errors like any other internal registry errors
so that a Registry Operator may be able to explore the problem at a later time.
Copyright © OASIS, 2002. All Rights Reserved
Page 121 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4327
9.8.3 Updates and Dynamic Content Cataloguing
4328
4329
When an ExtrinsicObject and its repository item are updated within a registry, the registry must
append any new catalog metadata to any previously created catalog metadata.
4330
9.8.4 Resolution Algorithm For Cataloging Service and Catalog Definition File
4331
4332
4333
When a registry receives a submission of an ExtrinsicObject EO1 and repository item pair, it
must use the following algorithm to determine or resolve the content cataloguing service and
Catalog Definition File to be used to catalog that content:
4334
4335
4336
4337
4338
1. Get the objectType attribute of the ExtrinsicObject. If the objectType is a UUID to a
classificationNode (refered to as objectType ClassificationNode) then proceed to next
step. Need to update objectType in ebRIM to say it must be a ref to a node in
ObjectType. For backward compatibility allow non-UUID values. If not UUID to Cnode
then return with no service/CDF resolution??
4339
4340
4341
4342
4343
2. Query to see if the objectType ClassificationNode is the targetObject of an Association
with associationType of CataloguingServiceFor. If desired Association is not found for
this ClassificationNode then repeat this step with its parent ClassificationNode. Repeat
until the desired Association is found or until the parent is the ClassificationScheme. If
desired Association is found proceed to next step.
4344
4345
4346
3. Check if the sourceObject of the desired Association is a Service instance. If not, log an
InvalidRequestException. If it is a Service instance, then use this Service as the content
cataloguing service for the ExtrinsicObject.
4347
4348
4349
4350
4351
4. Query to see if the objectType ClassificationNode is the targetObject of an Association
with associationType of CatalogDefinitionFileFor. If desired Association is not found for
this ClassificationNode then repeat this step with its parent ClassificationNode. Repeat
until the desired Association is found or until the parent is the ClassificationScheme. If
desired Association is found proceed to next step.
4352
4353
4354
5. Check if the sourceObject of the desired Association is an ExtrinsicObject instance. If
not, log an InvalidRequestException. If it is an ExtrinsicObject instance, then use its
repository item as the Catalog Definition File.
4355
4356
4357
4358
4359
The above algorithm allows for objectType hierarchy to be used to configure Cataloging Service
and Catalog Definition Files with varying degrees of specificity or specialization with respect to
the type of content.
If no Cataloging Service or Catalog Definition File is found then content should not be
catalogued.
4360
9.9 Dynamic Content-based Discovery
4361
4362
4363
4364
As described earlier, content to be Cataloged is automatically catalogued when it is submitted to
the registry. This content may subsequently be dynamically discovered using the catalog
metadata within existing AdhocQueryRequest. Because the catalog metadata is based upon
content to be Cataloged, an AdhocQueryRequest can perform dynamic content- based discovery.
Copyright © OASIS, 2002. All Rights Reserved
Page 122 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4365
9.10 Default XML Content Cataloging Service
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
An ebXML Registry must provide the XML Content Cataloguing Service natively as a built-in
service. The XML content cataloguing service accepts an XML instance document as its input
and it accepts an XSLT Style sheet as a Content Definition File. Each type of content should
have its own unique XSLT style sheet. For example, an ebXML CPP document should have a
specialized ebXML CPP catalog definition style sheet. The XML content cataloguing service
must apply the XSLT style sheet to the XML instance document input to generate the catalog
metadata. Since a single style sheet must be applied to both the ExtrinsicObject and the content
to be Cataloged , we must assume the two documents to be composed within a single virtual
document the schema for which is as follows:
4380
9.10.1 Publishing of Default XML Content Cataloging Service
4381
4382
4383
4384
The default XML Content Cataloguing Service need not be explicitly published to an ebXML
Registry. An ebXML Registry must provide the XML Content Cataloguing Service natively as a
built-in service. This built-in service must be published to the registry as part of the intrinsic
bootstrapping of required data within the registry.
4385
9.11 Canonical Catalog Definition Files
4386
4387
4388
4389
4390
4391
It is desirable to have identical Catalog Definition Files and cataloguing services for a given
object type across all registry implementations. This provides a consistent behavior for dynamic
content cataloguing across registries. To facilitate consistency a non-normative set of canonical
Catalog Definition Files will be maintained at:
http://www.oasis-open.org/committees/regrep/documents/3.0/contentBasedDiscovery
It is recommended that producers of content definition files should register them with this site.
<cbd:MetaDataAndContent>
<rim:ExtrinsicObject/>
<someXMLTag/>
</cbd:MetaDataAndContent>
Copyright © OASIS, 2002. All Rights Reserved
Page 123 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4392
10 Event Notification
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
This chapter defines the Event Notification feature of the OASIS ebXML Registry. The Event
Notification feature is an optional but normative feature of the ebXML Registry.
Event Notification feature allows OASIS ebXML Registries to notify its users and / or other
registries about events of interest. It allows users to stay informed about registry events without
being forced to periodically poll the registry. It also allows a registry to propagate internal
changes to other registries whose content might be affected by those changes.
ebXML registries support content-based Notification where interested parties express their
interest in form of a query. This is different from subject–based (sometimes referred to as topicbased) notification, where information is categorized by subjects and interested parties express
their interests in those predefined subjects.
4403
10.1 Use Cases
4404
4405
The following use cases illustrate different ways in which ebXML registries notify users or other
registries.
4406
10.1.1 New Service is Offered
4407
4408
4409
A user wishes to know when a new Plumbing service is offered in her town. When that happens,
she might try to learn more about that service and compare it with her current Plumbing service
provider’s offering.
4410
10.1.2 Monitor Download of Content
4411
4412
4413
User wishes to know whenever her CPP [ebCPP] is downloaded in order to evaluate on an
ongoing basis the success of her recent advertising campaign. She might also want to analyze
who the interested parties are.
4414
10.1.3 Monitor Price Changes
4415
4416
4417
User wishes to know when the price of a product that she is interested in buying drops below a
certain amount. If she buys it she would also like to be notified when the product has been
shipped to her.
4418
10.1.4 Keep Replicas Consistent With Source Object
4419
4420
4421
4422
In order to improve performance and availability of accessing some registry objects, a local
registry may make replicas of certain objects that are hosted by another registry. The registry
would like to be notified when the source object for a replica is updated so that it can
synchronize the replica with the latest state of the source object.
4423
10.2 Registry Events
4424
4425
4426
4427
4428
Activities within a registry result in meaningful events. Typically, registry events are generated
when a registry processes client requests. In addition, certain registry events may be caused by
administrative actions performed by a registry operator. [ebRIM] defines the AuditableEvent
class, instances of which represent registry events. When such an event occurs, an
AuditableEvent instance is generated by the registry.
Copyright © OASIS, 2002. All Rights Reserved
Page 124 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4429
10.3 Subscribing to Events
4430
4431
4432
4433
A User may create a subscription with a registry if she wishes to receive notification for a
specific type of event. A User creates a subscription by submitting a Subscription instance to a
registry using the SubmitObjectsRequest. If a Subscription is submitted to a registry that does
not support event notification then the registry must return an UnsupportedCapabilityException.
4434
10.3.1 Event Selection
4435
4436
4437
4438
In order for a User to only be notified of specific events of interest, she must specify a Selector
within the Subscription instance. Each Selector contains a query that determines whether an
event qualifies for that Subscription or not. The query syntax is the standard ad hoc query syntax
described in chapter 8. Need examples of Subscriptions, Notifications??
4439
10.3.2 Notification Action
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
Editor wordsmith??
When creating a Subscription, a User may also specify what the registry should do when an
event matching the Selector for that Subscription (subscription event) transpires. A User may
specify Actions within the Subscription. Each Action defines an action that the registry must
perform when a subscription event transpires. If no Actions are defined within the Subscription
that implies that the user does not wish to be notified asynchronously by the registry and instead
intends to periodically poll the registry and pull the pending Notifications.
[ebRIM] defines two standard Actions that allow delivery of event notifications via email to a
human user or by invocation of a web service based programmatic interface.
For each event that transpires in the registry, if the registry supports event notification, it must
check all registered and active Subscriptions and see if any Subscriptions match the event. If a
match is found then the registry performs the Notification Actions required for the Subscription.
4452
10.3.3 Subscription Authorization
4453
4454
4455
A registry may use registry specific policies to decide which User is authorized to create a
subscription and to what events. A Registry must return an AuthorizationException in the event
that an Unauthorized User submits a Subscription to a registry.
4456
10.3.4 Subscription Quotas
4457
4458
4459
4460
4461
4462
See if we can wordsmith to avoid using number as the limit. What if few heavy duty
subscriptions??
A registry may use registry specific policies to decide an upper limit on the number of
Subscriptions a User is allowed to create. A Registry must return a QuotaExceededException in
the event that an Authorized User submits more Subscriptions than allowed by their registry
specific quota.
Copyright © OASIS, 2002. All Rights Reserved
Page 125 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4463
10.3.5 Subscription Expiration
4464
4465
4466
4467
4468
4469
4470
Each subscription defines a startDate and and endDate attribute which determines the period
within which a Subscription is active. Outside the bounds of the active period, a Subsription may
exist in an expired state within the registry. A registry may remove an expired Subscription at
any time. In such cases the identity of a RegistryOperator User must be used for the request in
order to have sufficient authorization to remove a User’s Subscription.
A Registry must not consider expired Subscriptions when delivering notifications for an event to
its Subscriptions. An expired Subscription may be renewed by submitting a new Subscription.
4471
10.4 Unsubscribing from Events
4472
4473
4474
4475
A User may terminate a Subscription with a registry if she no longer wishes to be notified of
events related to that Subscription. A User terminates a Subscription by deleting the
corresponding Subscription object using the RemoveObjectsRequest to the registry.
Removal of a Subscription object follows the same rules as removal of any other object.
4476
10.5 Notification of Events
4477
4478
4479
4480
4481
4482
4483
4484
4485
A registry performs the Actions for a Subscription in order to actually deliver the events.
However, regardless of the specific delivery action, the registry must communicate the
Subscription events. The Subscription events are delivered within a Notification instance as
described by [ebRIM].
[ebRIM] defines an extensible description of Notifications, making it possible to allow for
registry or application specific Notifications. It defines several normative types of Notifications.
A client may specify the type of Notification they wish to receive using the notificationOption
attribute of the Action within the Subscription. The registry may override this notificationOption
based upon registry specific operational policies.
4486
10.6 Retrieval of Events
4487
4488
4489
The registry provides asynchronous PUSH style delivery of Notifications via notify Actions as
described earlier. However, a client may also use a PULL style to retrieve any pending events for
their Subscriptions. Pulling of events is done using the Get Notifications protocol.
4490
10.6.1 GetNotificationsRequest
4491
4492
The GetNotificationsRequest is used by a client to retrieve any pending events for their
Subscriptions.
4493
10.6.1.1 Syntax:
4494
4495
 Figure 44: GetNotificationsRequest Syntax
Copyright © OASIS, 2002. All Rights Reserved
Page 126 of 167
OASIS/ebXML Registry Services Specification v2.0
4496
4497
4498
March 2016
10.6.1.2 Parameters:

subscriptionRefs: This parameter specifies a collection of ObjectRefs to
Subscription objects for which the client wishes to get Notifications.
4499
4500
10.6.1.3 Returns:
4501
This request returns a GetNotificationsResponse. See section 10.6.2 for details.
4502
10.6.1.4 Exceptions:
4503
In addition to the exceptions common to all requests, the following exceptions may be returned:
4504
4505

ObjectNotFoundException: signifies that a specified Subscription was not found
in the registry.
4506
10.6.2 GetNotificationsResponse
4507
4508
The GetNotificationsResponse is sent by the registry as a response to GetNotificationsRequest. It
contains the Notifications for the Subscription specified in the GetNotificationsRequest.
4509
4510
10.6.2.1 Syntax:
4511
4512
4513
4514
4515
4516
4517
 Figure 45: GetNotificationsResponse Syntax
10.6.2.2 Parameters:

notification: This parameter specifies a notification contained within the
GetNotificationsResponse. The notification is actually delivered as a more
specialized sub-type (e.g. EventRefsNotification) as defined by [ebRIM].
4518
10.7 Purging of Events
4519
4520
4521
A registry may periodically purge AuditableEvents in order to manage its resources. It is up to
the registry when such purging occurs. It is up to the registry to determine when undelivered
events are purged.
Copyright © OASIS, 2002. All Rights Reserved
Page 127 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4522
11 Cooperating Registries Support
4523
4524
This chapter describes the capabilities and protocols that enable multiple ebXML registries to
cooperate with each other to meet advanced use cases.
4525
11.1 Cooperating Registries Use Cases
4526
4527
The following is a list of use cases that illustrate different ways that ebXML registries cooperate
with each other.
4528
11.1.1 Inter-registry Object References
4529
4530
4531
4532
A Submitting Organization wishes to submit a RegistryObject to a registry such that the
submitted object references a RegistryObject in another registry.
An example might be where a RegistryObject in one registry is associated with a RegistryObject
in another registry.
4533
4534
 Figure 46: Inter-registry Object References
4535
4536
11.1.2 Federated Queries
4537
4538
4539
4540
A client wishes to issue a single query against multiple registries and get back a single response
that contains results based on all the data contained in all the registries. From the client’s
perspective it is issuing its query against a single logical registry that has the union of all data
within all the physical registries.
4541
11.1.3 Local Caching of Data from Another Registry
4542
4543
4544
4545
4546
4547
4548
4549
A destination registry wishes to cache some or all the data of another source registry that is
willing to share its data. The shared dataset is copied from the source registry to the destination
registry and is visible to queries on the destination registry even when the source registry is not
available.
Local caching of data may be desirable in order to improve performance and availability of
accessing that object.
An example might be where a RegistryObject in one registry is associated with a RegistryObject
in another registry, and the first registry caches the second RegistryObject locally.
Copyright © OASIS, 2002. All Rights Reserved
Page 128 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4550
11.1.4 Object Relocation
4551
4552
A Submitting Organization wishes to relocate its RegistryObjects and/or repository items from
the registry where it was submitted to another registry.
4553
11.2 Registry Federations
4554
4555
4556
4557
A registry federation is a group of registries that have voluntarily agreed to form a loosely
coupled union. Such a federation may be based on common business interests and specialties that
the registries may share. Registry federations appear as a single logical registry, to registry
clients.
4558
4559
 Figure 47: Registry Federations
4560
4561
4562
4563
4564
4565
4566
4567
Registry federations are based on a peer-to-peer (P2P) model where all participating registries
are equal. Each participating registry is called a registry peer. There is no distinction between the
registry operator that created a federation and those registry operators that joined that Federation
later.
Any registry operator may form a registry federation at any time. When a federation is created it
must have exactly one registry peer which is the registry operated by the registry operator that
created the federation.
Any registry may choose to voluntarily join or leave a federation at any time.
4568
11.2.1 Federation Metadata
4569
4570
4571
4572
4573
4574
4575
The Registry Information model defines the Registry and Federation classes, instances of these
classes and the associations between these instances describe a federation and its members. Such
instance data is referred to as Federation Metadata. The Registry and Federation classes are
described in detail in [ebRIM].
The Federation information model is summarized here as follows:
o A Federation instance represents a registry federation.
o A Registry instance represents a registry that is a member of the Federation.
Copyright © OASIS, 2002. All Rights Reserved
Page 129 of 167
OASIS/ebXML Registry Services Specification v2.0
4576
4577
4578
4579
March 2016
o An Association instance with associationType of HasFederationMember represents
membership of the registry in the federation. This Association links the Registry instance
and the Federation instance.
4580
4581
 Figure 48: Federation Metadata Example
4582
11.2.2 Local Vs. Federated Queries
4583
4584
4585
4586
A federation appears to registry clients as a single unified logical registry. An
AdhocQueryRequest sent by a client to a federation member may be local or federated. A new
boolean attribute named federated is added to AdhocQueryRequest to indicate whether the query
is federated or not.
4587
11.2.2.1 Local Queries
4588
4589
4590
4591
When the federated attribute of AdhocQueryRequest has the value of false then the query is a
local query. In the absence of a federated attribute the default value of federated attribute is false.
A local AdhocQueryRequest is only processed by the registry that receives the request. A local
AdhocQueryRequest does not operate on data that belongs to other registries.
4592
11.2.2.2 Federated Queries
4593
4594
4595
4596
4597
4598
4599
When the federated attribute of AdhocQueryRequest has the value of true then the query is a
federated query.
A federated query to any federation member must be routed by that member to all other
federation member registries as parallel-distributed queries. A federated query operates on data
that belongs to all members of the federation.
When a client submits a federated query to a registry that is not a member of a federation, the
registry must treat it as a local query.
Copyright © OASIS, 2002. All Rights Reserved
Page 130 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4600
11.2.2.3 Membership in Multiple Federations
4601
4602
4603
4604
4605
4606
A registry may be a member of multiple federations. In such cases if the federated attribute of
AdhocQueryRequest has the value of true then the registry must route the federated query to all
federations that it is a member of.
Alternatively, the client may specify the id of a specific federation that the registry is a member
of, as the value of the federation parameter. The type of the federation parameter is ID.
In such cases the registry must route the federated query to the specified federation only.
4607
11.2.3 Federated Lifecycle Management Operations
4608
4609
4610
4611
4612
Details on how to create and delete federations and how to join and leave a federation are
described in 11.2.8.
All lifecycle operations must be performed on a RegistryObject within its home registry using
the operations defined by the LifeCycleManager interface. Unlike query requests, lifecycle
management requests do not support any federated capabilities.
4613
11.2.4 Federations and Local Caching of Remote Data
4614
4615
4616
4617
4618
4619
4620
4621
A federation member is not required to maintain a local cache of replicas of RegistryObjects and
repository items that belong to other members of the federation.
A registry may choose to locally cache some or all data from any other registry whether that
registry is a federation member or not. Data caching is orthogonal to registry federation and is
described in section 11.3.
Since by default there is minimal replication in the members of a federation, the federation
architecture scales well with respect to memory and disk utilization at each registry.
Data replication is often necessary for performance, scalability and fault-tolerance reasons.
4622
11.2.5 Caching of Federation Metadata
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
A special case for local caching is the caching of the Federation and Registry instances and
related Associations that define a federation and its members. Such data is referred to as
federation metadata. A federation member is required to locally cache the federation metadata,
from the federation home for each federation that it is a member of. The reason for this
requirement is consistent with a Peer-to-Peer (P2P) model and ensures fault –tolerance in case
the Federation home registry is unavailable.
The federation member must keep the cached federation metadata synchronized with the master
copy in the Federation home, within the time period specified by the replicationSyncLatency
attribute of the Federation. Synchronization of cached Federation metadata may be done via
synchronous polling or asynchronous event notification using the event notification feature of the
registry.
4634
11.2.6 Time Synchronization Between Registry Peers
4635
4636
4637
4638
Federation members are not required to synchronize their system clocks with each other.
However, it is recommended that a Federation member keep its clock synchronized with an
atomic clock server within the latency described by the replicationSyncLatency attribute of the
Federation.
Copyright © OASIS, 2002. All Rights Reserved
Page 131 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4639
11.2.7 Federations and Security
4640
4641
Federation lifecycle management operations abide by the same security rules as standard
lifecycle management.
4642
11.2.8 Federation Lifecycle Management Protocols
4643
4644
4645
This section describes the various operations that manage the lifecycle of a federation and its
membership. A key design objective is to allow federation lifecycle operations to be done using
existing LifeCycleManager interface of the registry in a stylized manner.
4646
11.2.8.1 Joining a Federation
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
The following rules govern how a registry joins a federation:
 Each registry must have exactly one Registry instance within that registry for which it is
a home. The Registry instance is owned by the RegistryOperator and may be placed in
the registry using any operator specific means. The Registry instance must never change
its home registry.
 A registry may request to join an existing federation by submitting an instance of an
Extramural Association that associates the Federation instance as sourceObject, to its
Registry instance as targetObject, using an associationType of HasFederationMember.
The home registry for the Association and the Federation objects must be the same.
 The owner of the Federation instance must confirm the Extramural Association in order
for the registry to be accepted as a member of the federation.
4658
11.2.8.2 Creating a Federation
4659
4660
4661
4662
4663
4664
The following rules govern how a federation is created:
 A Federation is created by submitting a Federation instance to a registry using
SubmitObjectsRequest.
 The registry where the Federation is submitted is referred to as the federation home.
 The federation home may or may not be a member of that Federation.
 A federation home may contain multiple Federation instances.
4665
11.2.8.3 Leaving a Federation
4666
4667
4668
4669
The following rules govern how a registry leaves a federation:
A registry may leave a federation at any time by removing its HasFederationMember
Association instance that links it with the Federation instance. This is done using the standard
RemoveObjectsRequest.
4670
11.2.8.4 Dissolving a Federation
4671
4672
4673
4674
4675
The following rules govern how a federation is dissolved:
 A federation is dissolved by sending a RemoveObjectsRequest to its home registry and
removing its Federation instance.
 The removal of a Federation instance is controlled by the same Access Control Policies
that govern any RegistryObject.
Copyright © OASIS, 2002. All Rights Reserved
Page 132 of 167
OASIS/ebXML Registry Services Specification v2.0
4676
4677
4678
4679
4680

March 2016
The removal of a Federation instance is controlled by the same lifecycle management
rules that govern any RegistryObject. Typically, this means that a federation may not be
dissolved while it has federation members. It may however be deprecated at any time.
Once a Federation is deprecated no new members can join it.
4681
11.3 Object Replication
4682
4683
4684
4685
4686
4687
4688
4689
RegistryObjects within a registry may be replicated in another registry. A replicated copy of a
remote object is referred to as its replica. The remote object may be an original object or it may
be a replica. A replica from an original is referred to as a first-generation replica. A replica of a
replica is referred to as a second-generation replica (and so on).
The registry that replicates a remote object locally is referred to as the destination registry for the
replication. The registry that contains the remote object being replicated is referred to as the
source registry for the replication.
4690
4691
 Figure 49: Object Replication
4692
4693
11.3.1 Use Cases for Object Replication
4694
4695
A registry may create a local replica of a remote object for a variety of reasons. A few sample
use cases follow:
4696
4697
4698
4699
4700
4701
4702
o Improve access time and fault tolerance via locally caching remote objects. For example,
a registry may automatically create a local replica when a remote ObjectRef is submitted
to the registry.
o Improve scalability by distributing access to hotly contested object, such as NAICS
scheme, across multiple replicas.
o Enable cooperating registry features such as hierarchical registry topology and local
caching of federation metadata.
Copyright © OASIS, 2002. All Rights Reserved
Page 133 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4703
11.3.2 Queries And Replicas
4704
4705
4706
4707
4708
4709
A registry must support client queries to consider a local replica of remote object as if it were a
local object. Local replicas are considered within the extent of the data set of a registry as far as
local queries are concerned.
When a client submits a local query that retrieves a remote object by its id attribute, if the
registry contains a local replica of that object then the registry should return the state defined by
the local replica.
4710
11.3.3 Lifecycle Operations And Replicas
4711
4712
4713
LifeCycle operations on an original object must be performed at the home registry for that
object. LifeCycle operations on replicas of an original object only affect the replica and do not
have any impact on the original object.
4714
11.3.4 Object Replication and Federated Registries
4715
4716
4717
Object replication capability is orthogonal to the registry federation capability. Objects may be
replicated from any registry to any other registry without any requirement that the registries
belong to the same federation.
4718
11.3.5 Creating a Local Replica
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
Any Submitting Organization can create a replica by using the existing SubmitObjectsRequest. If
a registry receives a SubmitObjectRequest which has an RegistryObjectList containing a remote
ObjectRef, then it must create a replica for that remote ObjectRef.
In addition to Submitting Organizations, a registry itself may create a replica under specific
situations in a registry specific manner.
Creating a local replica requires the destination registry to read the state of the remote object
from the source registry and then create a local replica of the remote object.
A registry may use standard QueryManager interface to read the state of a remote object
(whether it is an original or a replica). No new APIs are needed to read the state of a remote
object. Since query functionality does not need prior registration, no prior registration or contract
is needed for a registry to read the state of a remote object.
Once the state of the remote object has been read, a registry may use registry specific means to
create a local replica of the remote object. Such registry specific means may include the use of
the LifeCycleManager interface.
4733
4734
A replica of a RegistryObject may be distinguished from an original since a replica must have its
home attribute point to the remote registry where the original for the replica resides.
4735
11.3.6 Transactional Replication
4736
4737
4738
4739
4740
4741
Transactional replication enables a registry to replicate events in another registry in a
transactionally consistent manner. This is typically the case when entire registries are replicated
to another registry.
This specification defines a more loosely coupled replication model as an alternative to
transactional replication for the following reasons:
 Transactional replication is not a typical use case for registries
Copyright © OASIS, 2002. All Rights Reserved
Page 134 of 167
OASIS/ebXML Registry Services Specification v2.0

March 2016
4742
4743
4744
4745
4746
4747
4748
Registry implementations are not required to implement transactional replication.
4749
11.3.7 Keeping Replicas Current
4750
4751
4752
4753
4754
A registry must keep its replicas current within the latency specified by the value of the
replicationSyncLatency attribute defined by the registry. This includes removal of the replica
when its original is removed from its home registry.
Replicas may be kept current using the event notification feature of the registry or via periodic
polling.
4755
11.3.8 Write Operations on Local Replica
4756
4757
4758
Local Replicas are read-only objects. Lifecycle management operations of RegistryObjects are
not permitted on local replicas. All lifecycle management operation to RegistryObjects must be
performed in the home registry for the object.
4759
11.3.9 Tracking Location of a Replica
4760
4761
4762
4763
4764
A local replica of a remote RegistryObject instance must have exactly one ObjectRef instance
within the local registry. The home attribute of the ObjectRef associated with the replica tracks
its home location. A RegistryObject must have exactly one home. The home for a RegistryObject
may change via Object Relocation as described in section 11.4. It is optional for a registry to
track location changes for replicas within it.
4765
11.3.10
4766
4767
4768
It is possible to have a remote ObjectRef to a RegistryObject that is a replica of another
RegistryObject. In such cases the home attribute of the ObjectRef contains the base URI to the
home registry for the replica.
4769
11.3.11
4770
4771
4772
A Submitting Organization can remove a replica by using the RemoveObjectsRequest. If a
registry receives a RemoveObjectsRequest that has an ObjectRefList containing a remote
ObjectRef, then it must remove the local replica for that remote ObjectRef.
4773
11.4 Object Relocation Protocol
4774
4775
4776
4777
Need to replace this with Registry Import/Export capability??
Every RegistryObject has a home registry and a User within the home registry that is the
publisher or owner of that object. Initially, the home registry is the where the object is originally
submitted. Initially, the owner is the User that submitted the object.


Loosely coupled replication as defined by this specification typically suffices for most
use cases
Transaction replication is very complex and error prone
Transactional replication requires a tight coupling between registries participating in the
replication
Remote Object References to a Replica
Removing a Local Replica
Copyright © OASIS, 2002. All Rights Reserved
Page 135 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4778
4779
4780
4781
A RegistryObject may be relocated from one home registry to another home registry using the
Object Relocation protocol.
Within the Object Relocation protocol, the new home registry is referred to as the destination
registry while the previous home registry is called the source registry.
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
Figure 50: Object Relocation
The User at the source registry who owns the objects being relocated is referred to as the
ownerAtSource. The User at the destination registry, who is the new oner of the objects, is
referred to as the ownerAtDestination. While the ownerAtSource and the ownerAtDestination
may often be the same identity, the Object Relocation protocol treats them as two distinct
identities.
A special case usage of the Object Relocation protocol is to transfer ownership of
RegistryObjects from one User to another within the same registry. In such cases the protocol is
the same except for the fact that the source and destination registries are the same.
Following are some notable points regarding object relocation:
4793
4794

Object relocation does not require that the source and destination registries be in the same
federation or that either registry have a prior contract with the other.
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805

Object relocation must preserve object id. While the home registry for a RegistryObject
may change due to object relocation, its id never changes.
ObjectRelocation must preserve referential integrity of RegistryObjects. Relocated
objects that have references to an object that did not get relocated must preserve their
reference. Similarly objects that have references to a relocated object must also preserve
their reference. Thus, relocating an object may result in making the value of a reference
attribute go from being a local reference to being a remote reference or vice versa.
AcceptObjectsRequest does not include ObjectRefList. It only includes an opaque
transactonId identifying the relocateObjects transaction.
The requests defined by the Relocate Objects protocol must be sent to the source or
destination registry only.



Copyright © OASIS, 2002. All Rights Reserved
Page 136 of 167
OASIS/ebXML Registry Services Specification v2.0
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815

March 2016
When an object is relocated an AuditableEvent of type “Relocated” happens. Relocated
events must have the source and target registry’s base URIs recorded as two Slots on the
Relocated event. The names of these Slots are sourceRegistry and targetRegistry
respectively.
 Figure 51: Relocate Objects Protocol
Figure 40 illustrates the Relocate Objects Protocol. The participants in the protocol are the
ownerAtSource and ownerAtDestination User instances as well as the LifeCycleManager
interfaces of the sourceRegistry and destinationRegistry.
The steps in the protocol are described next:
4816
4817
4818
4819
4820
4821
1. The protocol is initiated by the ownerAtSource sending a RelocateObjectsRequest
message to the LifeCycleManager interface of the sourceRegistry. The sourceRegistry
must make sure that the ownerAtSource is authorized to perform this request. The id of
this RelocateObjectsRequest is used as the transaction identifier for this instance of the
protocol. This RelocateObjectsRequest message must contain an ObjectRefList element
specifying the objects that are to be relocated.
4822
4823
4824
4825
2. Next, the sourceRegistry must send a different RelocateObjectsRequest message to the
LifeCycleManager interface of the destinationRegistry. This RelocateObjectsRequest
message must not contain the ObjectRefList element. This message signals the
detsinationRegistry to participate in relocation protocol.
4826
4827
4828
4829
3. The destinationRegistry must relay the RelocateObjectsRequest message to the
ownerAtDestination using the event notification feature of the registry as described in
chapter 10. This concludes the sequence of events that were a result of the
ownerAtSource sending the RelocateObjectsRequest message to the sourceRegistry.
Copyright © OASIS, 2002. All Rights Reserved
Page 137 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4830
4831
4832
4833
4. The ownerAtDestination at a later time may send an AcceptObjectsRequest message to
the destinationRegistry. This request must identify the object relocation transaction via
the relocateObjectsRequestId. The value of this attribute must be the id of the original
RelocateObjectsRequest.
4834
4835
5. The destinationRegistry relays the AcceptObjectsRequest message to the sourceRegistry.
The source registry returns the objects being relocated as an AdhocQueryResponse.
4836
4837
4838
6. The registry submits the relocated data to itself assigning the identity of the
ownerAtDestination as the owner. The relocated data may be submitted to the destination
registry using any registry specific means or a SubmitObjectsRequest.
4839
4840
7. The destinationRegistry notifies the sourceRegistry that the relocated objects have been
safely committed. Need to decide on the signal message name here??
4841
4842
8. The sourceRegistry removes the relocated objects using any registry specific means or a
RemoveObjectsRequest. This concludes the Object Relocation transaction.
4843
11.4.1 RelocateObjectsRequest
4844
4845
 Figure 52: RelocateObjectsRequest XML Schema
4846
11.4.1.1 Attribute id
4847
The attribute id provides the transaction identifier for this instance of the protocol.
4848
11.4.1.2 Element ObjectRefList
4849
4850
4851
This element specifies the set of id attributes of RegistryObjects that are being relocated. This
attribute must be present when the message is sent by the ownerAtSource to the sourceRegistry.
This attribute must not be present when the message is sent on any other occasion.
4852
11.4.1.3 Element sourceRegistry
4853
4854
4855
This element specifies the ObjectRef to the sourceRegistry Registry instance. The value of this
attribute must be a local reference when the message is sent by the ownerAtSource to the
sourceRegistry.
Copyright © OASIS, 2002. All Rights Reserved
Page 138 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4856
11.4.1.4 Element destinationRegistry
4857
This element specifies the ObjectRef to the destinationRegistry Registry instance.
4858
11.4.1.5 Element ownerAtSource
4859
This element specifies the ObjectRef to the ownerAtSource User instance.
4860
11.4.1.6 Element ownerAtDestination
4861
This element specifies the ObjectRef to the ownerAtDestination User instance.
4862
11.4.2 AcceptObjectsRequest
4863
4864
11.4.2.1 Attribute relocateObjectsRequestId
4865
4866
The attribute relocateObjectsRequestId provides the transaction identifier for this instance of the
protocol.
4867
11.4.3 Object Relocation and Remote ObjectRefs
4868
The following scenario describes what typically happens when a person moves:
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
1. When a person moves from one house to another, other persons may have their old postal
addresses.
2. When a person moves, they leave their new address as the forwarding address with the
post office.
3. The post office forwards their mail for some time to their new address.
4. Eventually the forwarding request expires and the post office no longer forwards mail for
that person.
5. During this forwarding interval the person notifies interested parties of their change of
address.
The registry must support a similar model for relocation of RegistryObjects. The following steps
describe the expected behavior when an object is relocated.
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
1. When a RegistryObject O1 is relocated from one registry R1 to another registry R2, other
RegistryObjects may have remote ObjectRefs to O1.
2. The registry R1 must leave an AuditableEvent of type Relocated that includes the home
URI for the new registry R2.
3. As long as the AuditableEvent exists in R1, if R1 gets a request to retrieve O1 by id, it
must forward the request to R2 and transparently retrieve O1 from R2 and deliver it to the
client. The object O1 must include the home URI to R2 within the optional home
attribute of RegistryObject. Clients are advised to check the home attribute and update
the home attribute of their local ObjectRef to match the new home URI value for the
object.
4. Eventually the AuditableEvent is cleaned up after a registry specific interval. R1 is no
longer required to relay requests for O1 to R2 transparent to the client. Instead R1 must
return an ObjectNotFoundException.
Copyright © OASIS, 2002. All Rights Reserved
Page 139 of 167
OASIS/ebXML Registry Services Specification v2.0
4893
4894
4895
4896
March 2016
5. Clients that are interested in the relocation of O1 and being notified of its new address
may choose to be notified by having a prior subscription using the event notification
facility of the registry. For example a Registry that has a remote ObjectRefs to O1 may
create a subscription on relocation events for O1. This however, is not required behavior.
4897
11.4.4 Notification of Object Relocation
4898
4899
4900
This section describes how the destinationRegistry uses the event notification feature of the
registry to notify the ownerAtDestination of a Relocated event.
<details TBD>
4901
11.4.5 Object Relocation and Timeouts
4902
4903
4904
No timeouts are specified for the Object Relocation protocol. Registry implementations may
cleanup incomplete Object Relocation transactions in a registry specific manner as an
administrative task using registry specific policies.
Copyright © OASIS, 2002. All Rights Reserved
Page 140 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4905
12 Registry Security
4906
4907
4908
This chapter describes the security features of the ebXML Registry. It is assumed that the reader
is familiar with the security related classes in the Registry information model as described in
[ebRIM]. Security glossary terms can be referenced from RFC 2828.
4909
12.1 Security Concerns
4910
4911
4912
4913
4914
In the current version of this specification, we address data integrity and source integrity (item 1
in Appendix E.1). We have used a minimalist approach to address the access control concern as
in item 2 of Appendix E.1. Essentially, any known entity (Submitting Organization) can publish
content and anyone can view published content. The Registry Information Model [ebRIM] is
designed to support more sophisticated security policies in future versions of this specification.
4915
12.2 Integrity of Registry Content
4916
4917
4918
4919
4920
4921
4922
4923
4924
It is assumed that most business registries do not have the resources to validate the veracity of
the content submitted to them. The mechanisms described in this section can be used to ensure
that any tampering with the content can be detected. Furthermore, these mechanisms support
unambiguous identification of the Responsible Organization for any registry content. The
Registry Client has to sign the contents before submission – otherwise the content will be
rejected. Note that in the discussions in this section we assume a Submitting Organization to be
also the Responsible Organization. Future versions of this specification may provide more
examples and scenarios where a Submitting Organization and Responsible Organization are
different.
4925
12.2.1 Message Payload Signature
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
The integrity of the Registry content requires that all submitted content be signed by the
submitter. The signature on the submitted content ensures that:
 Any tampering of the content can be detected.
 The content’s veracity can be ascertained by its association with a specific Submitting
Organization.
This section specifies the requirements for generation, packaging and validation of payload
signatures. A payload signature is packaged with the payload. Therefore the requirements apply
regardless of whether the Registry Client and the Registration Authority communicate over
standard SOAP with Attachments or ebXML Messaging Service [ebMS]. Currently, ebXML
Messaging Service does not specify the generation, validation and packaging of payload
signatures. The specification of payload signatures is left up to the application (such as Registry).
The requirements on the payload signatures augment the [ebMS] specification.
4938
Use Case
4939
4940
4941
4942
This Use Case illustrates the use of header and payload signatures (we discuss header signatures
later).
 RC1 (Registry Client 1) signs the content (generating a payload signature) and publishes the
content along with the payload signature to the Registry.
Copyright © OASIS, 2002. All Rights Reserved
Page 141 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953


4954
12.2.2 Payload Signature Requirements
4955
12.2.2.1 Payload Signature Packaging Requirements
4956
4957
4958
4959
4960
4961
4962
4963
A payload signature is represented by a ds:Signature element. The payload signature must be
packaged with the payload as specified here. This packaging assumes that the payload is always
signed.
 The payload and its signature must be enclosed in a MIME multipart message with a
Content-Type of multipart/related.
 The first body part must contain the XML signature as specified in Section 12.2.2.2,
“Payload Signature Generation Requirements”.
 The second body part must be the content.
4964
4965
The packaging of the payload signature with two payloads is as shown in the example in Section
8.4.2.
4966
12.2.2.2 Payload Signature Generation Requirements
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
The ds:Signature element [XMLDSIG] for a payload signature must be generated as specified in
this section. Note: the “ds” name space reference is to http://www.w3.org/2000/09/xmldsig#
 ds:SignatureMethod must be present. [XMLDSIG] requires that the algorithm be identified
using the Algorithm attribute. [XMLDSIG] allows more than one Algorithm attribute, and a
client may use any of these attributes. However, signing using the following Algorithm
attribute: http://www.w3.org/2000/09/xmldsig#dsa-sha1 will allow interoperability with all
XMLDSIG compliant implementations, since XMLDSIG requires the implementation of this
algorithm.
The ds:SignedInfo element must contain a ds:CanonicalizationMethod element. The following
Canonicalization algorithm (specified in [XMLDSIG]) must be supported
RC2 (Registry Client 2) retrieves RC1’s content from the Registry.
RC2 wants to verify that RC1 published the content. In order to do this, when RC2 retrieves
the content, the response from the Registration Authority to RC2 contains the following:
o Payload containing the content that has been published by RC1.
o RC1’s payload signature (represented by a ds:Signature element) over RC1’s published
content.
o The public key for validating RC1’s payload signature in ds:Signature element ( using the
KeyInfo element as specified in [XMLDSIG] ) so RC2 can obtain the public key for
signature (e.g. retrieve a certificate containing the public key for RC1).
o A ds:Signature element containing the header signature. Note that the Registration
Authority (not RC1) generates this signature.
http://www.w3.org/TR/2001/REC-xml-c14n-20010315

One ds:Reference element to reference each of the payloads that needs to be signed must be
created. The ds:Reference element:
o Must identify the payload to be signed using the URI attribute of the ds:Reference
element.
o Must contain the <ds:DigestMethod> as specified in [XMLDSIG]. A client must support
the following digest algorithm:
Copyright © OASIS, 2002. All Rights Reserved
Page 142 of 167
OASIS/ebXML Registry Services Specification v2.0
4984
4985
March 2016
http://www.w3.org/2000/09/xmldsig#sha1
o Must contain a <ds:DigestValue> which is computed as specified in [XMLDSIG].
4986
The ds:SignatureValue must be generated as specified in [XMLDSIG].
4987
4988
The ds:KeyInfo element may be present. However, when present, the ds:KeyInfo field is subject
to the requirements stated in Section 12.4, “KeyDistrbution and KeyInfo element”.
4989
12.2.2.3 Message Payload Signature Validation
4990
The ds:Signature element must be validated by the Registry as specified in the [XMLDSIG].
4991
12.2.2.4 Payload Signature Example
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
The following example shows the format of the payload signature:
5008
12.3 Authentication
5009
5010
The Registry must be able to authenticate the identity of the Principal associated with client
requests and also the owner of each repository item.
5011
5012
5013
5014
5015
5016
5017
The Principal can be identified by verifying the message header signature with the certificate of
the Principal. The certificate may be in the message itself or provided to the registry through
means unspecified in this specification. If not provided in the message, this specification does
not specify how the Registry correlates a specific message with a certificate. Each payload must
also be signed to ensure the integrity of that payload and to determine its owner. Authentication
is also required to identify the privileges a Principal is authorized to have with respect to specific
objects in the Registry.
5018
5019
5020
5021
The Registry must perform authentication on a per message basis. From a security point of view,
all messages are independent and there is no concept of a session encompassing multiple
messages or conversations. Session support may be added as an optimization feature in future
versions of this specification.
5022
5023
5024
It is important to note that the message header signature can only guarantee data integrity. It does
not guarantee safety from “replay” attacks. True support for authentication requires timestamps
or nonce (nonrecurring series of numbers to identify each message) that are signed.
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<SignatureMethod Algorithm=”http://www.w3.org/TR/2000/09/xmldsig#dsa-sha1”/>
<ds:CanonicalizationMethod>
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315">
</ds:CanonicalizationMethod>
<ds:Reference URI=#Payload1>
<ds:DigestMethod DigestAlgorithm="http://www.w3.org/TR/2000/09/xmldsig#sha1">
<ds:DigestValue> ... </ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>
...
</ds:SignatureValue>
</ds:Signature>
Copyright © OASIS, 2002. All Rights Reserved
Page 143 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5025
12.3.1 Message Header Signature
5026
5027
Message headers are signed to provide data integrity while the message is in transit. Note that the
signature within the message header also signs the digests of the payloads.
5028
Header Signature Requirements
5029
5030
5031
5032
5033
Message headers may be signed and are referred to as a header signature. When a Registered
User sends a request, the Registration Authority may use a pre-established contract or a default
policy to determine whether the response should contain a header signature. When a Registry
Guest sends a request, the Registration Authority may use a default policy to determine whether
the response contains a header signature.
5034
5035
5036
5037
5038
5039
5040
5041
This section specifies the requirements for generation, packaging and validation of a header
signature. These requirements apply when the Registry Client and Registration Authority
communicate using standard SOAP with Attachments. When ebXML MS is used for
communication, then the message handler (i.e. [ebMS]) specifies the generation, packaging and
validation of XML signatures in the SOAP header. Therefore the header signature requirements
do not apply when the ebXML MS is used for communication. However, payload signature
generation requirements (12.2.2.2) do apply whether standard SOAP with Attachments or
ebXML MS is used for communication.
5042
12.3.1.1 Packaging Requirements
5043
5044
5045
A header signature is represented by a ds:Signature element. The ds:Signature element generated
must be packaged in a <SOAP-ENV:Header> element. The packaging of the ds:Signature
element in the SOAP header field is shown in Section 8.4.2.
5046
12.3.1.2 Header Signature Generation Requirements
5047
5048
5049
5050
5051
The ds:Signature element [XMLDSIG] for a header signature must be generated as specified in
this section. A ds:Signature element contains:
 ds:SignedInfo
 ds:SignatureValue
 ds:KeyInfo
5052
The ds:SignedInfo element must be generated as follows:
5053
5054
5055
5056
5057
1. ds:SignatureMethod must be present. [XMLDSIG] requires that the algorithm be identified
using the Algorithm attribute. While [XMLDSIG] allows more than one Algorithm Attribute,
a client must be capable of signing using only the following Algorithm attribute:
http://www.w3.org/2000/09/xmldsig#dsa-sha1. All XMLDSIG implementations conforming to the
[XMLDSIG] specification support this algorithm.
5058
5059
5060
2. The ds:SignedInfo element must contain a ds:CanonicalizationMethod element. The
following Canonicalization algorithm (specified in [XMLDSIG]) must be supported:
5061
5062
5063
5064
3. A ds:Reference element to include the <SOAP-ENV:Envelope> in the signature calculation.
This signs the entire ds:Reference element and:
o Must include the ds:Transform
http://www.w3.org/TR/2001/REC-xml-c14n-20010315
http://www.w3.org/2000/09/xmldsig#enveloped-signature
Copyright © OASIS, 2002. All Rights Reserved
Page 144 of 167
OASIS/ebXML Registry Services Specification v2.0
5065
5066
5067
5068
5069
5070
5071
5072
March 2016
This ensures that the signature (which is embedded in the <SOAP-ENV:Header>
element) is not included in the signature calculation.
o Must identify the <SOAP-ENV:Envelope> element using the URI attribute of the
ds:Reference element. The URI attribute is optional in the [XMLDSIG] specification.
The URI attribute must be an empty string (“”).
o Must contain the <ds:DigestMethod> as specified in [XMLDSIG]. A client must support
the digest algorithm: http://www.w3.org/2000/09/xmldsig#sha1
o Must contain a <ds:DigestValue>, which is computed as specified in [XMLDSIG].
5073
The ds:SignatureValue must be generated as specified in [XMLDSIG].
5074
5075
The ds:KeyInfo element may be present. When present, it is subject to the requirements stated in
Section 12.4, “KeyDistrbution and KeyInfo element”.
5076
12.3.1.3 Header Signature Validation Requirements
5077
5078
The ds:Signature element for the ebXML message header must be validated by the recipient as
specified by [XMLDSIG].
5079
12.3.1.4 Header Signature Example
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
The following example shows the format of a header signature:
5099
12.4 Key Distribution and KeyInfo Element
5100
5101
5102
5103
5104
To validate a signature, the recipient of the signature needs the public key corresponding to the
signer’s private key. The participants may use the KeyInfo field of ds:Signature, or distribute the
public keys in an implementation specific manner. In this section we consider the case when the
public key is sent in the KeyInfo field. The following use cases need to be addressed:
 Registration Authority needs the public key of the Registry Client to validate the signature
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<SignatureMethod Algorithm=http://www.w3.org/TR/2000/09/xmldsig#dsa-sha1/>
<ds:CanonicalizationMethod>
Algorithm="http://www.w3.org/TR/2000/CR-xml-c14n-2001026">
</ds:CanonicalizationMethod>
<ds:Reference URI= “”>
<ds:Transform>
http://www.w3.org/2000/09/xmldsig#enveloped-signature
</ds:Transform>
<ds:DigestMethod DigestAlgorithm="./xmldsig#sha1">
<ds:DigestValue> ... </ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>
...
</ds:SignatureValue>
</ds:Signature>
Copyright © OASIS, 2002. All Rights Reserved
Page 145 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5105
5106
5107
5108
5109
5110
5111
5112

5113
The following assumptions are also made:
5114
1. A Certificate is associated both with the Registration Authority and a Registry Client.
5115
5116
2. A Registry Client registers its certificate with the Registration Authority. The mechanism
used for this is not specified here.
5117
5118
3. A Registry Client obtains the Registration Authority’s certificate and stores it in its own local
key store. The mechanism is not specified here.
5119
Appendix F.8 contains a few scenarios on the use of KeyInfo field.
5120
12.5 Confidentiality
5121
12.5.1 On-the-wire Message Confidentiality
5122
5123
5124
It is suggested but not required that message payloads exchanged between clients and the
Registry be encrypted during transmission. This specification does not specify how payload
encryption is to be done.
5125
12.5.2 Confidentiality of Registry Content
5126
5127
5128
5129
In the current version of this specification, there are no provisions for confidentiality of Registry
content. All content submitted to the Registry may be discovered and read by any client. This
implies that the Registry and the client need to have an a priori agreement regarding encryption
algorithm, key exchange agreements, etc.
5130
12.6 Authorization
5131
5132
5133
5134
5135
5136
5137
The Registry must provide an authorization mechanism based on the information model defined
in [ebRIM]. In this version of the specification the authorization mechanism is based on a default
Access Control Policy defined for a pre-defined set of roles for Registry users. Future versions of
this specification will allow for custom Access Control Policies to be defined by the Submitting
Organization. The authorization is applied based upon a specific set of privileges. A privilege is
the ability to carry out a specific action such as invoking a method on the LifeCycleManager or
QueryManager interface.
5138
12.7 Access Control
5139
5140
The Registry must create a default AccessControlPolicy object that grants default permissions to
Registry users (as defined in Section 5.3) to access Registry Objects based upon their assigned


Registry Client needs the public key of the Registration Authority to validate the Registry’s
signature.
Registry Client RC1 needs the public key of Registry Client RC2 to validate the content
signed by RC1.
[XMLDSIG] provides an optional ds:KeyInfo element that can be used to pass information
to the recipient for retrieving the public key. This field together with the procedures outlined
in this section is used to securely pass the public key to a recipient. If the KeyInfo field is
present, it must contain a X509 Certificate as specified in [XMLDSIG].
Copyright © OASIS, 2002. All Rights Reserved
Page 146 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5141
role.
5142
12.7.1 Default Permission
5143
5144
5145
The following table defines the Permissions granted by the Registry to the various pre-defined
roles for Registry users.
Role
Permissions
ContentOwner
Access to all methods on Registry Objects that are owned by
the actor who is assigned this role.
RegistryAdministrator
Access to all methods on all Registry Objects
GuestReader
Access to some read-only (getXXX) methods on some Registry
Objects (read-only access to some content) as defined in the
default access control policy.
 Table 9: Role to Permissions Mapping
5146
5147
12.7.2 Actors / Role Mapping
5148
5149
The following table shows the mapping of actors listed in Section 5.3 and their default roles.

Actor
Role
Submitting Organization
ContentOwner
Responsible Organization
Registry Administrator
RegistryAdministrator
Registration Authority
5150
Registry Guest
GuestReader
Registry Reader
GuestReader
 Table 10: Default Actor to Role Mappings
5151
12.7.3 Default Access Control Policy
5152
5153
5154
5155
5156
5157
The Registry must implement the default AccessControlPolicy and associate it with all Objects
in the Registry. The following list summarizes the default AccessControlPolicy:
 Only a Registered User can publish content.
 An unauthenticated Registry Client has access to all QueryManager methods operating on
any Registry Objects as permitted for GuestReader role. The Registry must assign the default
GuestReader role to such Registry Clients.
Copyright © OASIS, 2002. All Rights Reserved
Page 147 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167

5168
12.7.4 Custom Access Control Policies
5169
5170
5171
5172
5173
5174
5175
5176
[ebRIM] allows for custom Access Control Policy objects to be defined on a per RegistryObject
basis. This enables a Submitting Organization to define Access Control Policies that are different
from the default Access Control Policy. Such custom policies may allow other parties to perform
privileged life cycle management operations on objects owned by the Submitting Organization.
It may also restrict read-only access to other parties on sensitive objects owned by the
Submitting Organization.
A registry may allow a Submitting Organization to define custom Access Control Policies in an
implementation specific manner.
The SubmittingOrganization has access to all QueryManager or LifeCycleManager methods
operating on Registry Objects submitted by the Submitting Organization. This version of the
specification does not distinguish between Submitting Organization and Responsible
Organization, and assumes that the Submitting Organization is also the Responsible
Organization.
 The RegistryAdministrator and Registry Authority have access to all methods on all Registry
Objects.
 At the time of content submission, the Registry must assign the default ContentOwner role to
the registered User as authenticated by the credentials in the submission message.
Fix security chapter, roles etc. Make it clear that SO is not the owner it is the User??
Copyright © OASIS, 2002. All Rights Reserved
Page 148 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5177
Appendix A
Web Service Architecture
5178
A.1 Registry Service Abstract Specification
5179
5180
5181
5182
The normative definition of the Abstract Registry Service in WSDL is defined at the following
location on the web:
5183
A.2 Registry Service SOAP Binding
5184
5185
5186
5187
The normative definition of the concrete Registry Service binding to SOAP in WSDL is defined
at the following location on the web:
http://www.oasis-open.org/committees/regrep/documents/3.0/services/Registry.wsdl
Need to update WSDL for V3??
http://www.oasis-open.org/committees/regrep/documents/3.0/services/RegistrySOAPBinding.wsdl
Copyright © OASIS, 2002. All Rights Reserved
Page 149 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5188
Appendix B
ebXML Registry Schema Definitions
5189
B.1 RIM Schema
5190
5191
5192
The normative XML Schema definition that maps [ebRIM] classes to XML can be found at the
following location on the web:
5193
B.2 Query Schema
5194
5195
5196
The normative XML Schema definition for the XML query syntax for the registry service
interface can be found at the following location on the web:
5197
B.3 Registry Services Interface Schema
5198
5199
5200
5201
The normative XML Schema definition that defines the XML requests and responses supported
by the registry service interfaces in this document can be found at the following location on the
web:
5202
B.4 Examples of Instance Documents
5203
5204
5205
5206
A growing number of non-normative XML instance documents that conform to the normative
Schema definitions described earlier may be found at the following location on the web:
http://www.oasis-open.org/committees/regrep/documents/3.0/schema/rim.xsd
http://www.oasis-open.org/committees/regrep/documents/3.0/schema/query.xsd
http://www.oasis-open.org/committees/regrep/documents/3.0/schema/rs.xsd
http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ebxmlrr/ebxmlrr-spec/misc/samples/
Copyright © OASIS, 2002. All Rights Reserved
Page 150 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5207
Appendix C
Interpretation of UML Diagrams
5208
5209
This section describes in abstract terms the conventions used to define ebXML business process
description in UML.
5210
C.1 UML Class Diagram
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
A UML class diagram is used to describe the Service Interfaces required to implement an
ebXML Registry Services and clients. The UML class diagram contains:
5222
C.2 UML Sequence Diagram
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
A UML sequence diagram is used to specify the business protocol representing the interactions
between the UML interfaces for a Registry specific ebXML business process. A UML sequence
diagram provides the necessary information to determine the sequencing of messages and request
to response association as well as request to error response association.
Each sequence diagram shows the sequence for a specific conversation protocol as method calls
from the requestor to the responder. Method invocation may be synchronous or asynchronous
based on the UML notation used on the arrowhead for the link. A half arrowhead represents
asynchronous communication. A full arrowhead represents synchronous communication.
Each method invocation may be followed by a response method invocation from the responder to
the requestor to indicate the ResponseName for the previous Request. Possible error response is
indicated by a conditional response method invocation from the responder to the requestor. See
Figure 7 on page 35 for an example.
1. A collection of UML interfaces where each interface represents a Registry Service
interface.
2. Tabular description of methods on each interface where each method represents an
Action (as defined by [ebCPP]) within the Service Interface.
3. One or more parameters for each method. The type of each parameter represents the
ebXML message type that is exchanged as part of the Action corresponding to the
method. Multiple arguments imply multiple payload documents within the body of the
corresponding ebXML message.
Copyright © OASIS, 2002. All Rights Reserved
Page 151 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5235
Appendix D
SQL Query
5236
D.1 SQL Query Syntax Specification
5237
5238
5239
This section specifies the rules that define the SQL Query syntax as a subset of SQL-92. The
terms enclosed in angle brackets are defined in [SQL] or in [SQL/PSM]. The SQL query syntax
conforms to the <query specification> as well as the additional restrictions identified below:
5240
Double check these restrictions with SQL spec??
5241
1. A <select list> may contain at most one <select sublist>.
5242
5243
2. The <select list> must be is a single column whose data type is UUID, from the table in the
<from clause>.
5244
3. A <derived column> may not have an <as clause>.
5245
5246
4. A <table expression> does not contain the optional <group by clause> and <having
clause> clauses.
5247
5. A <table reference> can only consist of <table name> and <correlation name>.
5248
5249
6. A <table reference> does not have the optional AS between <table name> and
<correlation name>.
5250
5251
5252
7. Restricted use of sub-queries is allowed by the syntax as follows. The <in predicate> allows
for the right hand side of the <in predicate> to be limited to a restricted <query
specification> as defined above.
5253
5254
8. The SQL query syntax allows for the use of <sql invoked routines> invocation from
[SQL/PSM] as the RHS of the <in predicate>.
5255
D.2 Non-Normative BNF for Query Syntax Grammar
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
The following BNF exemplifies the grammar for the registry query syntax. It is provided here as
an aid to implementers. Since this BNF is not based on [SQL] it is provided as non-normative
syntax. For the normative syntax rules see Appendix D.1.
Double check this??
/*******************************************************************
* The Registry Query (Subset of SQL-92) grammar starts here
*******************************************************************/
RegistryQuery = SQLSelect [";"]
SQLSelect = "SELECT" ["DISTINCT"] SQLSelectCols "FROM" SQLTableList [ SQLWhere ]
SQLSelectCols =
ID
SQLTableList = SQLTableRef
SQLTableRef = ID
SQLWhere = "WHERE" SQLOrExpr
SQLOrExpr = SQLAndExpr ( "OR" SQLAndExpr)*
SQLAndExpr = SQLNotExpr ("AND" SQLNotExpr)*
SQLNotExpr = [ "NOT" ] SQLCompareExpr
Copyright © OASIS, 2002. All Rights Reserved
Page 152 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
SQLCompareExpr =
(SQLColRef "IS") SQLIsClause
| SQLSumExpr [ SQLCompareExprRight ]
5349
D.3 Relational Schema For SQL Queries
5350
5351
The normative Relational Schema definition for SQL queries can be found at the following
location on the web:
SQLCompareExprRight =
SQLLikeClause
| SQLInClause
| SQLCompareOp SQLSumExpr
SQLCompareOp =
"="
| "<>"
| ">"
| ">="
| "<"
| "<="
SQLInClause = [ "NOT" ] "IN" "(" SQLLValueList ")"
SQLLValueList = SQLLValueElement ( "," SQLLValueElement )*
SQLLValueElement = "NULL" | SQLSelect
SQLIsClause =
SQLColRef "IS" [ "NOT" ] "NULL"
SQLLikeClause = [ "NOT" ] "LIKE" SQLPattern
SQLPattern = STRING_LITERAL
SQLLiteral =
STRING_LITERAL
| INTEGER_LITERAL
| FLOATING_POINT_LITERAL
SQLColRef = SQLLvalue
SQLLvalue =
SQLLvalueTerm
SQLLvalueTerm = ID ( "."
ID )*
SQLSumExpr = SQLProductExpr (( "+" | "-" ) SQLProductExpr )*
SQLProductExpr = SQLUnaryExpr (( "*" | "/" ) SQLUnaryExpr )*
SQLUnaryExpr = [ ( "+" | "-") ] SQLTerm
SQLTerm = "(" SQLOrExpr ")"
| SQLColRef
| SQLLiteral
INTEGER_LITERAL = (["0"-"9"])+
FLOATING_POINT_LITERAL =
(["0"-"9"])+ "." (["0"-"9"])+ (EXPONENT)?
| "." (["0"-"9"])+ (EXPONENT)?
| (["0"-"9"])+ EXPONENT
| (["0"-"9"])+ (EXPONENT)?
EXPONENT = ["e","E"] (["+","-"])? (["0"-"9"])+
STRING_LITERAL: "'" (~["'"])* ( "''" (~["'"])* )* "'"
ID = ( <LETTER> )+ ( "_" | "$" | "#" | <DIGIT> | <LETTER> )*
LETTER = ["A"-"Z", "a"-"z"]
DIGIT = ["0"-"9"]
Copyright © OASIS, 2002. All Rights Reserved
Page 153 of 167
OASIS/ebXML Registry Services Specification v2.0
5352
5353
5354
5355
5356
5357
March 2016
http://www.oasis-open.org/committees/regrep/documents/3.0/sql/database.sql
The stored procedures that must be supported by the SQL query feature are defined at the following
location on the web:
http://www.oasis-open.org/committees/regrep/documents/3.0/sql/storedProcedures.sql
Copyright © OASIS, 2002. All Rights Reserved
Page 154 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5358
Appendix E
Security Implementation Guideline
5359
5360
5361
5362
This section provides a suggested blueprint for how security processing may be implemented in
the Registry. It is meant to be illustrative not prescriptive. Registries may choose to have
different implementations as long as they support the default security roles and authorization
rules described in this document.
5363
E.1 Security Concerns
5364
5365
5366
The security risks broadly stem from the following concerns. After a description of these
concerns and potential solutions, we identify the concerns that we address in the current
specification
5367
1. Is the content of the registry (data) trustworthy?
5368
5369
5370
5371
5372
a) How to make sure “what is in the registry” is “what is put there” by a submitting
organization? This concern can be addressed by ensuring that the publisher is
authenticated using digital signature (Source Integrity), message is not corrupted during
transfer using digital signature (Data Integrity), and the data is not altered by
unauthorized subjects based on access control policy (Authorization)
5373
5374
5375
5376
b) How to protect data while in transmission?
Communication integrity has two ingredients – Data Integrity (addressed in 1a) and Data
Confidentiality that can be addressed by encrypting the data in transmission. How to
protect against a replay attack?
5377
5378
c) Is the content up to date? The versioning as well as any time stamp processing, when
done securely will ensure the “latest content” is guaranteed to be the latest content.
5379
5380
d) How to ensure only bona fide responsible organizations add contents to registry?
Ensuring Source Integrity (as in 1a).
5381
5382
e) How to ensure that bona fide publishers add contents to registry only at authorized
locations? (System Integrity)
5383
5384
f) What if the publishers deny modifying certain content after-the-fact? To prevent this
(Nonrepudiation) audit trails may be kept which contain signed message digests.
5385
g) What if the reader denies getting information from the registry?
5386
5387
2. How to provide selective access to registry content? The broad answer is, by using an access
control policy – applies to (a), (b), and (c) directly.
5388
5389
a) How does a submitting organization restrict access to the content to only specific registry
readers?
5390
5391
b) How can a submitting organization allow some “partners” (fellow publishers) to modify
content?
5392
c) How to provide selective access to partners the registry usage data?
5393
5394
5395
d) How to prevent accidental access to data by unauthorized users? Especially with hw/sw
failure of the registry security components? The solution to this problem is by having
System Integrity.
5396
e) Data confidentiality of RegistryObject
Copyright © OASIS, 2002. All Rights Reserved
Page 155 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5397
5398
5399
3. How do we make “who can see what” policy itself visible to limited parties, even excluding
the administrator (self & confidential maintenance of access control policy). By making sure
there is an access control policy for accessing the policies themselves.
5400
5401
5402
5403
5404
5405
5406
4. How to transfer credentials? The broad solution is to use credentials assertion (such as being
worked on in Security Assertions Markup Language (SAML)). Currently, Registry does not
support the notion of a session. Therefore, some of these concerns are not relevant to the
current specification.
a) How to transfer credentials (authorization/authentication) to federated registries?
b) How do aggregators get credentials (authorization/authentication) transferred to them?
c) How to store credentials through a session?
5407
E.2 Authentication
5408
1. As soon as a message is received, a principal object is created.
5409
5410
5411
2. If the message is signed, it is verified (including the validity of the certificate) and the DN of
the certificate becomes the identity of the principal. Then the Registry is searched for the
principal and if found, the roles and groups are filled in.
5412
5413
3. If the message is not signed, a principal is created with the role RegistryGuest. This step is
suggested for symmetry and to decouple the rest of the processing.
5414
4. The message is then processed for the Action and the objects it will act on.
5415
E.3 Authorization
5416
5417
5418
5419
For every object, the access controller will iterate through all the AccessControlPolicy objects to
verify that the requested method is permitted for the Principal. If any of the permission objects
associated with the object, have a common role, identity, or group with the principal, then the
action is permitted.
5420
E.4 Registry Bootstrap
5421
5422
5423
When a Registry is newly created, a default Principal object should be created with the identity
of the Registry Administrator’s certificate DN with a role Registry Administrator. This way, any
message signed by the Registry Administrator will get all the privileges.
5424
5425
5426
When a Registry is newly created, an instance of AccessControlPolicy is created as the default
AccessControlPolicy. This includes the creation of the necessary Permission instances as well as
the Privileges and Privilege attributes.
5427
E.5 Content Submission – Client Responsibility
5428
5429
The Registry client must sign the contents before submission – otherwise the content will be
rejected.
5430
E.6 Content Submission – Registry Responsibility
5431
5432
1. As with any other request, the Registry Client will first be authenticated. In this case, the
Principal object will get the DN from the certificate.
Copyright © OASIS, 2002. All Rights Reserved
Page 156 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5433
2. As per the request in the message, the RegistryObject will be created.
5434
3. The RegistryObject is assigned the default AccessControlPolicy.
5435
5436
4. If the Registry Client is not previously registered, the registry may either reject the request or
accept it and implicitly register the Registry Client.
5437
5438
E.7 Content Remove/Deprecate – Client Responsibility
5439
5440
The Registry client must sign the header before submission, for authentication purposes;
otherwise, the request will be rejected
5441
E.8 Content Remove/Deprecate – Registry Responsibility
5442
5443
5444
1. As with any other request, the Registry Client will first be authenticated. In this case, the
Principal object will get the DN from the certificate. As there will be a principal with this
identity in the Registry, the Principal object will get all the roles from that object.
5445
5446
2. As per the request in the message (remove or deprecate), the appropriate method in the
RegistryObject class will be accessed.
5447
5448
3. The access controller performs the authorization by iterating through the Permission objects
associated with this object via the default AccessControlPolicy.
5449
5450
4. If authorization succeeds then the action will be permitted. Otherwise an error response is
sent back with a suitable AuthorizationException error message.
5451
E.9 Using ds:KeyInfo Field
5452
Two typical usage scenarios for ds:KeyInfo are described below.
5453
Scenario 1
5454
1. Registry Client (RC) signs the payload and the SOAP envelope using its private key.
5455
2. The certificate of RC is passed to the Registry in KeyInfo field of the header signature.
5456
3. The certificate of RC is passed to the Registry in KeyInfo field of the payload signature.
5457
4. Registration Authority retrieves the certificate from the KeyInfo field in the header signature.
5458
5459
5. Registration Authority validates the header signature using the public key from the
certificate.
5460
5461
5462
5463
6. Registration Authority validates the payload signature by repeating steps 4 and 5 using the
certificate from the KeyInfo field of the payload signature. Note that this step is not an
essential one if the onus of validation is that of the eventual user, another Registry Client, of
the content.
5464
Scenario 2
5465
5466
1. RC1 signs the payload and SOAP envelope using its private key and publishes to the
Registry.
Copyright © OASIS, 2002. All Rights Reserved
Page 157 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5467
2. The certificate of RC1 is passed to the Registry in the KeyInfo field of the header signature.
5468
5469
5470
3. The certificate of RC1 is passed to the Registry in the KeyInfo field of the payload signature.
This step is required in addition to step 2 because when RC2 retrieves content, it should see
RC1’s signature with the payload.
5471
4. RC2 retrieves content from the Registry.
5472
5473
5. Registration Authority signs the SOAP envelope using its private key. Registration Authority
sends RC1’s content and the RC1’s signature (signed by RC1).
5474
5475
5476
6. Registration Authority need not send its certificate in the KeyInfo field sinceRC2 is assumed
to have obtained the Registration Authority’s certificate in an implementation-specific
manner and installed it in its local key store.
5477
5478
7. RC2 obtains Registration Authority’s certificate out of its local key store and verifies the
Registration Authority’s signature.
5479
5480
8. RC2 obtains RC1’s certificate from the KeyInfo field of the payload signature and validates
the signature on the payload.
Copyright © OASIS, 2002. All Rights Reserved
Page 158 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5481
Appendix F
5482
F.1 Definitions
5483
5484
Although this section discusses only character set and language, the following terms have to be
defined clearly.
5485
F.1.1 Coded Character Set (CCS):
5486
5487
CCS is a mapping from a set of abstract characters to a set of integers. [RFC 2130]. Examples of
CCS are ISO-10646, US-ASCII, ISO-8859-1, and so on.
5488
F.1.2 Character Encoding Scheme (CES):
5489
5490
CES is a mapping from a CCS (or several) to a set of octets. [RFC 2130]. Examples of CES are
ISO-2022, UTF-8.
5491
F.1.3 Character Set (charset):
5492
5493
5494

5495
F.2 NLS And Request / Response Messages
5496
5497
5498
5499
5500
5501
5502
5503
5504
For the accurate processing of data in both registry client and registry services, it is essential to
know which character set is used. Although the body part of the transaction may contain the
charset in xml encoding declaration, registry client and registry services shall specify charset
parameter in MIME header when they use text/xml. Because as defined in [RFC 3023], if a
text/xml entity is received with the charset parameter omitted, MIME processors and XML
processors MUST use the default charset value of "us-ascii". For example:
5505
5506
5507
Also, when an application/xml entity is used, the charset parameter is optional, and registry
client and registry services must follow the requirements in Section 4.3.3 of [REC-XML] which
directly address this contingency.
5508
If another Content-Type is used, then usage of charset must follow [RFC 3023].
5509
F.3 NLS And Storing of RegistryObject
5510
This section provides NLS guidelines on how a registry should store RegistryObject instances.
5511
5512
5513
A single instance of a concrete sub-class of RegistryObject is capable of supporting multiple
locales. Thus there is no language or character set associated with a specific RegistryObject
instance.
5514
5515
A single instance of a concrete sub-class of RegistryObject supports multiple locales as follows.
Each attribute of the RegistryObject that is I18N capable (e.g. name and description attributes in

Native Language Support (NLS)
charset is a set of rules for mapping from a sequence of octets to a sequence of
characters.[RFC 2277],[RFC 2278]. Examples of character set are ISO-2022-JP, EUC-KR.
A list of registered character sets can be found at [IANA].
Content-Type: text/xml; charset=ISO-2022-JP
Copyright © OASIS, 2002. All Rights Reserved
Page 159 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5516
5517
5518
5519
5520
RegistryObject class) as defined by [ebRIM], may have multiple locale specific values expressed
as LocalizedString sub-elements within the XML element representing the I18N capable
attribute. Each LocalizedString sub-element defines the value of the I18N capable attribute in a
specific locale. Each LocalizedString element has a charset and lang attribute as well as a value
attribute of type string.
5521
F.3.1 Character Set of LocalizedString
5522
5523
The character set used by a locale specific String (LocalizedString) is defined by the charset
attribute. It is highly recommended to use UTF-8 or UTF-16 for maximum interoperability.
5524
F.3.2 Language Information of LocalizedString
5525
The language may be specified in xml:lang attribute (Section 2.12 [REC-XML]).
5526
F.4 NLS And Storing of Repository Items
5527
5528
5529
5530
This section provides NLS guidelines on how a registry should store repository items.
While a single instance of an ExtrinsicObject is capable of supporting multiple locales, it is
always associated with a single repository item. The repository item may be in a single locale or
may be in multiple locales. This specification does not specify the repository item.
5531
F.4.1 Character Set of Repository Items
5532
5533
5534
5535
5536
5537
The MIME Content-Type mime header for the mime multipart containing the repository item
MAY contain a charset attribute that specifies the character set used by the repository item. For
example:
5538
5539
It is highly recommended to use UTF-16 or UTF-8 for maximum inter-operability. The charset
of a repository item must be preserved as it is originally specified in the transaction.
5540
F.4.2 Language information of repository item
5541
5542
5543
The Content-language mime header for the mime bodypart containing the repository item may
specify the language for a locale specific repository item. The value of the Content-language
mime header property must conform to [RFC 1766].
5544
5545
5546
5547
5548
This document currently specifies only the method of sending the information of character set
and language, and how it is stored in a registry. However, the language information may be used
as one of the query criteria, such as retrieving only DTD written in French. Furthermore, a
language negotiation procedure, like registry client is asking a favorite language for messages
from registry services, could be another functionality for the future revision of this document.
Content-Type: text/xml; charset="UTF-8"
Copyright © OASIS, 2002. All Rights Reserved
Page 160 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5549
Appendix G
Registry Profile
5550
Need to review relationship between profile and Registry class. How does this relate to REST??
5551
5552
5553
5554
5555
5556
Every registry must support exactly one Registry Profile. The Registry Profile is an XML
document that describes the capabilities of the registry. The profile document must conform to
the Registry Profile element as described in the Registry Services Interface schema defined in
Appendix B. The registry must make the Registry Profile accessible over HTTP protocol via a
URL. The URL must conform to the pattern:
http://<base url>/registryProfile
5557
Copyright © OASIS, 2002. All Rights Reserved
Page 161 of 167
OASIS/ebXML Registry Services Specification v2.0
5558
13 References
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
[Bra97] Keywords for use in RFCs to Indicate Requirement Levels.
[ebRIM] ebXML Registry Information Model version 3.0
5599
5600
5601
[RFC 3023] ETF (Internet Engineering Task Force). RFC 3023:
XML Media Types, ed. M. Murata. 2001.
March 2016
http://www.oasis-open.org/committees/regrep/documents/3.0/specs/ebRIM.pdf
[ebRIM Schema] ebXML Registry Information Model Schema
http://www.oasis-open.org/committees/regrep/documents/3.0/schema/rim.xsd
[ebBPSS] ebXML Business Process Specification Schema
http://www.ebxml.org/specs
[ebCPP] ebXML Collaboration-Protocol Profile and Agreement Specification
http://www.ebxml.org/specs/
[ebMS] ebXML Messaging Service Specification, Version 1.0
http://www.ebxml.org/specs/
[XPT] XML Path Language (XPath) Version 1.0
http://www.w3.org/TR/xpath
[SQL] Structured Query Language (FIPS PUB 127-2)
http://www.itl.nist.gov/fipspubs/fip127-2.htm
[SQL/PSM] Database Language SQL — Part 4: Persistent Stored Modules
(SQL/PSM) [ISO/IEC 9075-4:1996]
[IANA] IANA (Internet Assigned Numbers Authority).
Official Names for Character Sets, ed. Keld Simonsen et al.
ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets
[RESTThesis] Roy Thomas Fielding. Architectural Styles and the Design of Network-based Software
Architectures . Doctoral Dissertation, University of California, Irvine. 2000.
http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
[RFC 1766] IETF (Internet Engineering Task Force). RFC 1766:
Tags for the Identification of Languages, ed. H. Alvestrand. 1995.
http://www.cis.ohio-state.edu/htbin/rfc/rfc1766.html
[RFC 2119] IETF (Internet Engineering Task Force). RFC 2119
[RFC 2130] IETF (Internet Engineering Task Force). RFC 2130
[RFC 2277] IETF (Internet Engineering Task Force). RFC 2277:
IETF policy on character sets and languages, ed. H. Alvestrand. 1998.
http://www.cis.ohio-state.edu/htbin/rfc/rfc2277.html
[RFC 2278] IETF (Internet Engineering Task Force). RFC 2278:
IANA Charset Registration Procedures, ed. N. Freed and J. Postel. 1998.
http://www.cis.ohio-state.edu/htbin/rfc/rfc2278.html
[RFC2616] RFC 2616:
Fielding et al. Hypertext Transfer Protocol -- HTTP/1.1 . 1999.
http://www.w3.org/Protocols/rfc2616/rfc2616.html
[RFC 2828] IETF (Internet Engineering Task Force). RFC 2828:
Internet Security Glossary, ed. R. Shirey. May 2000.
http://www.cis.ohio-state.edu/htbin/rfc/rfc2828.html
ftp://ftp.isi.edu/in-notes/rfc3023.txt
Copyright © OASIS, 2002. All Rights Reserved
Page 162 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5602
5603
[REC-XML] W3C Recommendation. Extensible Markup language(XML)1.0(Second Edition)
5604
5605
5606
[UUID] DCE 128 bit Universal Unique Identifier
5607
5608
5609
5610
5611
5612
5613
5614
[WSDL] W3C Note. Web Services Description Language (WSDL) 1.1
http://www.w3.org/TR/REC-xml
http://www.opengroup.org/onlinepubs/009629399/apdxa.htm#tagcjh_20
http://www.opengroup.org/publications/catalog/c706.htmttp://www.w3.org/TR/REC-xml
http://www.w3.org/TR/wsdl
[SOAP11] W3C Note. Simple Object Access Protocol, May 2000,
http://www.w3.org/TR/SOAP
[SOAPAt] W3C Note: SOAP with Attachments, Dec 2000,
http://www.w3.org/TR/SOAP-attachments
[XMLDSIG] XML-Signature Syntax and Processing,
http://www.w3.org/TR/2001/PR-xmldsig-core-20010820/
Copyright © OASIS, 2002. All Rights Reserved
Page 163 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5615
14 Disclaimer
5616
5617
5618
5619
The views and specification expressed in this document are those of the authors and are not
necessarily those of their employers. The authors and their employers specifically disclaim
responsibility for any problems arising from correct or incorrect implementation or use of this
design.
Copyright © OASIS, 2002. All Rights Reserved
Page 164 of 167
OASIS/ebXML Registry Services Specification v2.0
5620
15 Contact Information
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
Team Leader
Name:
Company:
Street:
City, State, Postal Code:
Country:
Phone:
Email:
Kathryn R. Breininger
The Boeing Company
P.O. Box 3707 MC 62-LC
Seattle, WA 98124-2207
USA
425-965-0182
kathryn.r.breininger@boeing.com
Editor
Name:
Company:
Street:
City, State, Postal Code:
Country:
Phone:
Email:
Farrukh S. Najmi
Sun Microsystems
1 Network Dr., MS BUR02-302
Burlington, MA, 01803-0902
USA
(781) 442-0703
farrukh.najmi@sun.com
Technical Editor
Name:
Company:
Street:
City, State, Postal Code:
Country:
Phone:
Email:
Farrukh S. Najmi
Sun Microsystems
1 Network Dr., MS BUR02-302
Burlington, MA, 01803-0902
USA
(781) 442-0703
farrukh.najmi@sun.com
Copyright © OASIS, 2002. All Rights Reserved
March 2016
Page 165 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5648
16 Copyright Statement
5649
Portions of this document are copyright (c) 2001 OASIS and UN/CEFACT.
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
Copyright (C) The Organization for the Advancement of Structured Information
Standards [OASIS], 2002. All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works
that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
published and distributed, in whole or in part, without restriction of any kind, provided that the
above copyright notice and this paragraph are included on all such copies and derivative works.
However, this document itself may not be modified in any way, such as by removing the
copyright notice or references to OASIS, except as needed for the purpose of developing OASIS
specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
Property Rights document must be followed, or as required to translate it into languages other
than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its
successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN
WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
5668
5669
5670
5671
5672
5673
5674
5675
5676
OASIS takes no position regarding the validity or scope of any intellectual property or other
rights that might be claimed to pertain to the implementation or use of the technology described
in this document or the extent to which any license under such rights might or might not be
available; neither does it represent that it has made any effort to identify any such rights.
Information on OASIS's procedures with respect to rights in OASIS specifications can be found
at the OASIS website. Copies of claims of rights made available for publication and any
assurances of licenses to be made available, or the result of an attempt made to obtain a general
license or permission for the use of such proprietary rights by implementers or users of this
specification, can be obtained from the OASIS Executive Director.
5677
5678
5679
OASIS invites any interested party to bring to its attention any copyrights, patents or patent
applications, or other proprietary rights which may cover technology that may be required to
implement this specification. Please address the information to the OASIS Executive Director.
Copyright © OASIS, 2002. All Rights Reserved
Page 166 of 167
OASIS/ebXML Registry Services Specification v2.0
March 2016
5680
17 Notes
5681
5682
These notes are here to not lose the thought and will be merged into the spec later as issues get
resolved.
5683
5684
o CBD:CatalogContentResponse: how to handle any non-composed metadata such as
ExternalIdentifier, Package etc.?
5685
5686
o CBD: Need to fix schema for virtual document processed by default XML Cataloging
Service.
5687
5688
o CBD: How to track generated metadata separate from submitted metadata (and to do so
efficiently)? Should we also log which Cataloging Service and catalog file created it?
5689
Copyright © OASIS, 2002. All Rights Reserved
Page 167 of 167