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_log"/>
83 <xs:group ref="mp:filter_multi"/>
84 <xs:element ref="mp:xslt"/>
85 <xs:element ref="mp:filter_record_transform"/>
86 <xs:group ref="mp:filter_session_shared"/>
87 <xs:group ref="mp:filter_sru_z3950"/>
88 <xs:group ref="mp:filter_virt_db"/>
89 <xs:group ref="mp:filter_z3950_client"/>
90 <xs:group ref="mp:filter_limit"/>
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="load_balance"/>
102 <xs:enumeration value="log"/>
103 <xs:enumeration value="multi"/>
104 <xs:enumeration value="query_rewrite"/>
105 <xs:enumeration value="record_transform"/>
106 <xs:enumeration value="session_shared"/>
107 <xs:enumeration value="sru_z3950"/>
108 <xs:enumeration value="virt_db"/>
109 <xs:enumeration value="z3950_client"/>
110 <xs:enumeration value="limit"/>
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"/>
190 <xs:element name="threads" type="xs:integer"/>
191 <xs:element name="port" type="xs:string"/>
192 <xs:element name="timeout" type="xs:integer"/>
193 <xs:attributeGroup name="filter_frontend_net">
194 <xs:attribute name="type" use="required">
196 <xs:restriction base="xs:token">
197 <xs:enumeration value="frontend_net"/>
201 <xs:attribute name="id" type="xs:NCName"/>
202 <xs:attribute name="name" type="xs:NCName"/>
204 <xs:group name="filter_http_file">
206 <xs:element ref="mp:mimetypes"/>
207 <xs:element ref="mp:area"/>
210 <xs:element name="mimetypes" type="xs:string"/>
211 <xs:element name="area">
214 <xs:element ref="mp:documentroot"/>
215 <xs:element ref="mp:prefix"/>
219 <xs:element name="documentroot" type="xs:string"/>
220 <xs:element name="prefix" type="xs:string"/>
221 <xs:attributeGroup name="filter_http_file">
222 <xs:attribute name="type" use="required">
224 <xs:restriction base="xs:token">
225 <xs:enumeration value="http_file"/>
229 <xs:attribute name="id" type="xs:NCName"/>
230 <xs:attribute name="name" type="xs:NCName"/>
232 <xs:attributeGroup name="filter_load_balance">
233 <xs:attribute name="type" use="required">
235 <xs:restriction base="xs:token">
236 <xs:enumeration value="load_balance"/>
240 <xs:attribute name="id" type="xs:NCName"/>
241 <xs:attribute name="name" type="xs:NCName"/>
243 <xs:group name="filter_log">
245 <xs:element minOccurs="0" ref="mp:message"/>
246 <xs:element minOccurs="0" ref="mp:time-format"/>
247 <xs:element minOccurs="0" ref="mp:filename"/>
248 <xs:element minOccurs="0" ref="mp:category"/>
251 <xs:element name="message" type="xs:string"/>
252 <xs:element name="time-format" type="xs:string"/>
253 <xs:element name="filename" type="xs:string"/>
254 <xs:element name="category">
256 <xs:attribute name="user-access" type="xs:boolean"/>
257 <xs:attribute name="access" type="xs:boolean"/>
258 <xs:attribute name="init-options" type="xs:boolean"/>
259 <xs:attribute name="request-session" type="xs:boolean"/>
260 <xs:attribute name="response-session" type="xs:boolean"/>
261 <xs:attribute name="apdu" type="xs:boolean"/>
262 <xs:attribute name="request-apdu" type="xs:boolean"/>
263 <xs:attribute name="response-apdu" type="xs:boolean"/>
266 <xs:attributeGroup name="filter_log">
267 <xs:attribute name="type" use="required">
269 <xs:restriction base="xs:token">
270 <xs:enumeration value="log"/>
274 <xs:attribute name="id" type="xs:NCName"/>
275 <xs:attribute name="name" type="xs:NCName"/>
277 <xs:group name="filter_multi">
279 <xs:element minOccurs="0" maxOccurs="unbounded" ref="mp:target"/>
280 <xs:element minOccurs="0" ref="mp:hideunavailable"/>
281 <xs:element minOccurs="0" ref="mp:mergetype"/>
284 <xs:element name="target">
287 <xs:extension base="xs:string">
288 <xs:attribute name="route" use="required" type="xs:string"/>
293 <xs:element name="hideunavailable">
296 <xs:element name="mergetype" type="xs:string"/>
297 <xs:attributeGroup name="filter_multi">
298 <xs:attribute name="type" use="required">
300 <xs:restriction base="xs:token">
301 <xs:enumeration value="multi"/>
305 <xs:attribute name="id" type="xs:NCName"/>
306 <xs:attribute name="name" type="xs:NCName"/>
308 <xs:element name="xslt">
310 <xs:attribute name="stylesheet" use="required" type="xs:string"/>
313 <xs:attributeGroup name="filter_query_rewrite">
314 <xs:attribute name="type" use="required">
316 <xs:restriction base="xs:token">
317 <xs:enumeration value="query_rewrite"/>
321 <xs:attribute name="id" type="xs:NCName"/>
322 <xs:attribute name="name" type="xs:NCName"/>
324 <xs:element name="filter_record_transform" abstract="true">
327 <xs:element maxOccurs="unbounded" ref="y:retrieval"/>
329 <xs:attribute name="version" use="required">
331 <xs:restriction base="xs:token">
332 <xs:enumeration value="1.0"/>
338 <xs:attributeGroup name="filter_record_transform">
339 <xs:attribute name="type" use="required">
341 <xs:restriction base="xs:token">
342 <xs:enumeration value="record_transform"/>
346 <xs:attribute name="id" type="xs:NCName"/>
347 <xs:attribute name="name" type="xs:NCName"/>
349 <xs:group name="filter_session_shared">
351 <xs:element minOccurs="0" ref="mp:resultset"/>
352 <xs:element minOccurs="0" ref="mp:session"/>
355 <xs:element name="resultset">
357 <xs:attribute name="max" use="required" type="xs:integer"/>
358 <xs:attribute name="ttl" use="required" type="xs:integer"/>
361 <xs:element name="session">
363 <xs:attribute name="ttl" use="required" type="xs:integer"/>
366 <xs:attributeGroup name="filter_session_shared">
367 <xs:attribute name="type" use="required">
369 <xs:restriction base="xs:token">
370 <xs:enumeration value="session_shared"/>
374 <xs:attribute name="id" type="xs:NCName"/>
375 <xs:attribute name="name" type="xs:NCName"/>
377 <xs:group name="filter_sru_z3950">
379 <xs:element maxOccurs="unbounded" ref="mp:database"/>
382 <xs:element name="database">
385 <xs:extension base="mp:any">
386 <xs:attribute name="name" use="required" type="xs:NCName"/>
391 <xs:attributeGroup name="filter_sru_z3950">
392 <xs:attribute name="type" use="required">
394 <xs:restriction base="xs:token">
395 <xs:enumeration value="sru_z3950"/>
399 <xs:attribute name="id" type="xs:NCName"/>
400 <xs:attribute name="name" type="xs:NCName"/>
402 <xs:group name="filter_virt_db">
404 <xs:element maxOccurs="unbounded" ref="mp:virtual"/>
407 <xs:element name="virtual">
410 <xs:element name="database" type="xs:NCName"/>
411 <xs:element maxOccurs="unbounded" name="target" type="xs:string"/>
413 <xs:attribute name="route" type="xs:NCName"/>
416 <xs:attributeGroup name="filter_virt_db">
417 <xs:attribute name="type" use="required">
419 <xs:restriction base="xs:token">
420 <xs:enumeration value="virt_db"/>
424 <xs:attribute name="id" type="xs:NCName"/>
425 <xs:attribute name="name" type="xs:NCName"/>
427 <xs:group name="filter_z3950_client">
429 <xs:element minOccurs="0" ref="mp:timeout"/>
430 <xs:element minOccurs="0" ref="mp:default_target"/>
431 <xs:element minOccurs="0" ref="mp:force_target"/>
434 <xs:element name="default_target" type="xs:string"/>
435 <xs:element name="force_target" type="xs:string"/>
436 <xs:attributeGroup name="filter_z3950_client">
437 <xs:attribute name="type" use="required">
439 <xs:restriction base="xs:token">
440 <xs:enumeration value="z3950_client"/>
444 <xs:attribute name="id" type="xs:NCName"/>
445 <xs:attribute name="name" type="xs:NCName"/>
447 <xs:group name="filter_limit">
449 <xs:element minOccurs="0" ref="mp:limit"/>
452 <xs:element name="limit">
454 <xs:attribute name="bandwidth" type="xs:integer"/>
455 <xs:attribute name="pdu" type="xs:integer"/>
456 <xs:attribute name="search" type="xs:integer"/>
457 <xs:attribute name="retrieve" type="xs:integer"/>
460 <xs:attributeGroup name="filter_limit">
461 <xs:attribute name="type" use="required">
463 <xs:restriction base="xs:token">
464 <xs:enumeration value="limit"/>
471 filter_zeerex_explain =
472 attribute type { "zeerex_explain" },
473 attribute id { xsd:NCName }?,
474 attribute name { xsd:NCName }?,
475 element mp:database {
476 attribute name { xsd:NCName },