1 <?xml version="1.0" encoding="UTF-8"?>
3 Metaproxy XML config file schemas
5 Copyright (c) 2005-2008 Index Data.
7 See the LICENSE file for details
10 The RelaxNG Compact Syntax file 'metaproxy.rnc' is the master copy.
12 The RelaxNG XML Syntax and XML Schema are generated using 'trang':
13 trang metaproxy.rnc metaproxy.rng
14 trang metaproxy.rnc metaproxy.xsd
16 Config file validation is done using 'xmllint':
17 xmllint -/-relaxng metaproxy.rng ../../../etc/config1.xml
18 xmllint -/-schema metaproxy.xsd config-bytarget.xml
20 For information on RelaxNG see http://relaxng.org
21 see also http://books.xmlschemata.org/relaxng/
23 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://indexdata.com/metaproxy" xmlns:mp="http://indexdata.com/metaproxy" xmlns:y="http://indexdata.com/yaz">
24 <xs:import namespace="http://indexdata.com/yaz" schemaLocation="retrievalinfo.xsd"/>
25 <xs:complexType name="any" mixed="true">
27 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="skip"/>
30 <xs:element name="metaproxy">
33 <xs:element minOccurs="0" ref="mp:dlpath"/>
34 <xs:element ref="mp:start"/>
35 <xs:element minOccurs="0" ref="mp:filters"/>
36 <xs:element ref="mp:routes"/>
38 <xs:attribute name="version" use="required">
40 <xs:restriction base="xs:token">
41 <xs:enumeration value="1.0"/>
47 <xs:element name="dlpath" type="xs:string"/>
48 <xs:element name="start">
50 <xs:attribute name="route" use="required" type="xs:NCName"/>
53 <xs:element name="filters">
56 <xs:element maxOccurs="unbounded" ref="mp:filter"/>
60 <xs:element name="routes">
63 <xs:element maxOccurs="unbounded" ref="mp:route"/>
67 <xs:element name="route">
70 <xs:element maxOccurs="unbounded" ref="mp:filter"/>
72 <xs:attribute name="id" use="required" type="xs:NCName"/>
75 <xs:element name="filter">
77 <xs:choice minOccurs="0">
78 <xs:group ref="mp:filter_auth_simple"/>
79 <xs:element ref="mp:conversion"/>
80 <xs:group ref="mp:filter_frontend_net"/>
81 <xs:group ref="mp:filter_http_file"/>
82 <xs:group ref="mp:filter_limit"/>
83 <xs:group ref="mp:filter_log"/>
84 <xs:group ref="mp:filter_multi"/>
85 <xs:element ref="mp:xslt"/>
86 <xs:element ref="mp:filter_record_transform"/>
87 <xs:group ref="mp:filter_session_shared"/>
88 <xs:group ref="mp:filter_sru_z3950"/>
89 <xs:group ref="mp:filter_virt_db"/>
90 <xs:group ref="mp:filter_z3950_client"/>
92 <xs:attribute name="type">
94 <xs:restriction base="xs:token">
95 <xs:enumeration value="auth_simple"/>
96 <xs:enumeration value="backend_test"/>
97 <xs:enumeration value="bounce"/>
98 <xs:enumeration value="cql_rpn"/>
99 <xs:enumeration value="frontend_net"/>
100 <xs:enumeration value="http_file"/>
101 <xs:enumeration value="limit"/>
102 <xs:enumeration value="load_balance"/>
103 <xs:enumeration value="log"/>
104 <xs:enumeration value="multi"/>
105 <xs:enumeration value="query_rewrite"/>
106 <xs:enumeration value="record_transform"/>
107 <xs:enumeration value="session_shared"/>
108 <xs:enumeration value="sru_z3950"/>
109 <xs:enumeration value="virt_db"/>
110 <xs:enumeration value="z3950_client"/>
114 <xs:attribute name="refid" type="xs:NCName"/>
115 <xs:attribute name="id" type="xs:NCName"/>
116 <xs:attribute name="name" type="xs:NCName"/>
119 <xs:attributeGroup name="filter_refid">
120 <xs:attribute name="refid" use="required" type="xs:NCName"/>
122 <xs:group name="filter_auth_simple">
124 <xs:element minOccurs="0" ref="mp:userRegister"/>
125 <xs:element minOccurs="0" ref="mp:targetRegister"/>
126 <xs:element minOccurs="0" ref="mp:discardUnauthorisedTargets"/>
129 <xs:element name="userRegister" type="xs:string"/>
130 <xs:element name="targetRegister" type="xs:string"/>
131 <xs:element name="discardUnauthorisedTargets">
134 <xs:attributeGroup name="filter_auth_simple">
135 <xs:attribute name="type" use="required">
137 <xs:restriction base="xs:token">
138 <xs:enumeration value="auth_simple"/>
142 <xs:attribute name="id" type="xs:NCName"/>
143 <xs:attribute name="name" type="xs:NCName"/>
145 <xs:attributeGroup name="filter_backend_test">
146 <xs:attribute name="type" use="required">
148 <xs:restriction base="xs:token">
149 <xs:enumeration value="backend_test"/>
153 <xs:attribute name="id" type="xs:NCName"/>
154 <xs:attribute name="name" type="xs:NCName"/>
156 <xs:attributeGroup name="filter_bounce">
157 <xs:attribute name="type" use="required">
159 <xs:restriction base="xs:token">
160 <xs:enumeration value="bounce"/>
164 <xs:attribute name="id" type="xs:NCName"/>
165 <xs:attribute name="name" type="xs:NCName"/>
167 <xs:element name="conversion">
169 <xs:attribute name="file" use="required" type="xs:string"/>
172 <xs:attributeGroup name="filter_cql_rpn">
173 <xs:attribute name="type" use="required">
175 <xs:restriction base="xs:token">
176 <xs:enumeration value="cql_rpn"/>
180 <xs:attribute name="id" type="xs:NCName"/>
181 <xs:attribute name="name" type="xs:NCName"/>
183 <xs:group name="filter_frontend_net">
185 <xs:element minOccurs="0" ref="mp:threads"/>
186 <xs:element maxOccurs="unbounded" ref="mp:port"/>
187 <xs:element minOccurs="0" ref="mp:timeout"/>
188 <xs:element minOccurs="0" ref="mp:connect-max"/>
191 <xs:element name="threads" type="xs:integer"/>
192 <xs:element name="port" type="xs:string"/>
193 <xs:element name="timeout" type="xs:integer"/>
194 <xs:element name="connect-max" type="xs:integer"/>
195 <xs:attributeGroup name="filter_frontend_net">
196 <xs:attribute name="type" use="required">
198 <xs:restriction base="xs:token">
199 <xs:enumeration value="frontend_net"/>
203 <xs:attribute name="id" type="xs:NCName"/>
204 <xs:attribute name="name" type="xs:NCName"/>
206 <xs:group name="filter_http_file">
208 <xs:element ref="mp:mimetypes"/>
209 <xs:element ref="mp:area"/>
212 <xs:element name="mimetypes" type="xs:string"/>
213 <xs:element name="area">
216 <xs:element ref="mp:documentroot"/>
217 <xs:element ref="mp:prefix"/>
221 <xs:element name="documentroot" type="xs:string"/>
222 <xs:element name="prefix" type="xs:string"/>
223 <xs:attributeGroup name="filter_http_file">
224 <xs:attribute name="type" use="required">
226 <xs:restriction base="xs:token">
227 <xs:enumeration value="http_file"/>
231 <xs:attribute name="id" type="xs:NCName"/>
232 <xs:attribute name="name" type="xs:NCName"/>
234 <xs:attributeGroup name="filter_load_balance">
235 <xs:attribute name="type" use="required">
237 <xs:restriction base="xs:token">
238 <xs:enumeration value="load_balance"/>
242 <xs:attribute name="id" type="xs:NCName"/>
243 <xs:attribute name="name" type="xs:NCName"/>
245 <xs:group name="filter_log">
247 <xs:element minOccurs="0" ref="mp:message"/>
248 <xs:element minOccurs="0" ref="mp:time-format"/>
249 <xs:element minOccurs="0" ref="mp:filename"/>
250 <xs:element minOccurs="0" ref="mp:category"/>
253 <xs:element name="message" type="xs:string"/>
254 <xs:element name="time-format" type="xs:string"/>
255 <xs:element name="filename" type="xs:string"/>
256 <xs:element name="category">
258 <xs:attribute name="user-access" type="xs:boolean"/>
259 <xs:attribute name="access" type="xs:boolean"/>
260 <xs:attribute name="init-options" type="xs:boolean"/>
261 <xs:attribute name="request-session" type="xs:boolean"/>
262 <xs:attribute name="response-session" type="xs:boolean"/>
263 <xs:attribute name="apdu" type="xs:boolean"/>
264 <xs:attribute name="request-apdu" type="xs:boolean"/>
265 <xs:attribute name="response-apdu" type="xs:boolean"/>
268 <xs:attributeGroup name="filter_log">
269 <xs:attribute name="type" use="required">
271 <xs:restriction base="xs:token">
272 <xs:enumeration value="log"/>
276 <xs:attribute name="id" type="xs:NCName"/>
277 <xs:attribute name="name" type="xs:NCName"/>
279 <xs:group name="filter_multi">
281 <xs:element minOccurs="0" maxOccurs="unbounded" ref="mp:target"/>
282 <xs:element minOccurs="0" ref="mp:hideunavailable"/>
283 <xs:element minOccurs="0" ref="mp:mergetype"/>
286 <xs:element name="target">
289 <xs:extension base="xs:string">
290 <xs:attribute name="route" use="required" type="xs:string"/>
295 <xs:element name="hideunavailable">
298 <xs:element name="mergetype" type="xs:string"/>
299 <xs:attributeGroup name="filter_multi">
300 <xs:attribute name="type" use="required">
302 <xs:restriction base="xs:token">
303 <xs:enumeration value="multi"/>
307 <xs:attribute name="id" type="xs:NCName"/>
308 <xs:attribute name="name" type="xs:NCName"/>
310 <xs:element name="xslt">
312 <xs:attribute name="stylesheet" use="required" type="xs:string"/>
315 <xs:attributeGroup name="filter_query_rewrite">
316 <xs:attribute name="type" use="required">
318 <xs:restriction base="xs:token">
319 <xs:enumeration value="query_rewrite"/>
323 <xs:attribute name="id" type="xs:NCName"/>
324 <xs:attribute name="name" type="xs:NCName"/>
326 <xs:element name="filter_record_transform" abstract="true">
329 <xs:element maxOccurs="unbounded" ref="y:retrieval"/>
331 <xs:attribute name="version" use="required">
333 <xs:restriction base="xs:token">
334 <xs:enumeration value="1.0"/>
340 <xs:attributeGroup name="filter_record_transform">
341 <xs:attribute name="type" use="required">
343 <xs:restriction base="xs:token">
344 <xs:enumeration value="record_transform"/>
348 <xs:attribute name="id" type="xs:NCName"/>
349 <xs:attribute name="name" type="xs:NCName"/>
351 <xs:group name="filter_session_shared">
353 <xs:element minOccurs="0" ref="mp:resultset"/>
354 <xs:element minOccurs="0" ref="mp:session"/>
357 <xs:element name="resultset">
359 <xs:attribute name="max" use="required" type="xs:integer"/>
360 <xs:attribute name="ttl" use="required" type="xs:integer"/>
363 <xs:element name="session">
365 <xs:attribute name="ttl" use="required" type="xs:integer"/>
368 <xs:attributeGroup name="filter_session_shared">
369 <xs:attribute name="type" use="required">
371 <xs:restriction base="xs:token">
372 <xs:enumeration value="session_shared"/>
376 <xs:attribute name="id" type="xs:NCName"/>
377 <xs:attribute name="name" type="xs:NCName"/>
379 <xs:group name="filter_sru_z3950">
381 <xs:element minOccurs="0" maxOccurs="unbounded" ref="mp:database"/>
384 <xs:element name="database">
387 <xs:extension base="mp:any">
388 <xs:attribute name="name" use="required" type="xs:NCName"/>
393 <xs:attributeGroup name="filter_sru_z3950">
394 <xs:attribute name="type" use="required">
396 <xs:restriction base="xs:token">
397 <xs:enumeration value="sru_z3950"/>
401 <xs:attribute name="id" type="xs:NCName"/>
402 <xs:attribute name="name" type="xs:NCName"/>
404 <xs:group name="filter_virt_db">
406 <xs:element minOccurs="0" ref="mp:pass-vhosts"/>
407 <xs:element maxOccurs="unbounded" ref="mp:virtual"/>
410 <xs:element name="pass-vhosts" type="xs:boolean"/>
411 <xs:element name="virtual">
414 <xs:element name="database" type="xs:NCName"/>
415 <xs:element maxOccurs="unbounded" name="target" type="xs:string"/>
417 <xs:attribute name="route" type="xs:NCName"/>
420 <xs:attributeGroup name="filter_virt_db">
421 <xs:attribute name="type" use="required">
423 <xs:restriction base="xs:token">
424 <xs:enumeration value="virt_db"/>
428 <xs:attribute name="id" type="xs:NCName"/>
429 <xs:attribute name="name" type="xs:NCName"/>
431 <xs:group name="filter_z3950_client">
433 <xs:element minOccurs="0" ref="mp:timeout"/>
434 <xs:element minOccurs="0" ref="mp:default_target"/>
435 <xs:element minOccurs="0" ref="mp:force_target"/>
438 <xs:element name="default_target" type="xs:string"/>
439 <xs:element name="force_target" type="xs:string"/>
440 <xs:attributeGroup name="filter_z3950_client">
441 <xs:attribute name="type" use="required">
443 <xs:restriction base="xs:token">
444 <xs:enumeration value="z3950_client"/>
448 <xs:attribute name="id" type="xs:NCName"/>
449 <xs:attribute name="name" type="xs:NCName"/>
451 <xs:group name="filter_limit">
453 <xs:element minOccurs="0" ref="mp:limit"/>
456 <xs:element name="limit">
458 <xs:attribute name="bandwidth" type="xs:integer"/>
459 <xs:attribute name="pdu" type="xs:integer"/>
460 <xs:attribute name="search" type="xs:integer"/>
461 <xs:attribute name="retrieve" type="xs:integer"/>
464 <xs:attributeGroup name="filter_limit">
465 <xs:attribute name="type" use="required">
467 <xs:restriction base="xs:token">
468 <xs:enumeration value="limit"/>
475 filter_zeerex_explain =
476 attribute type { "zeerex_explain" },
477 attribute id { xsd:NCName }?,
478 attribute name { xsd:NCName }?,
479 element mp:database {
480 attribute name { xsd:NCName },