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"/>
91 <xs:attribute name="type">
93 <xs:restriction base="xs:token">
94 <xs:enumeration value="auth_simple"/>
95 <xs:enumeration value="backend_test"/>
96 <xs:enumeration value="bounce"/>
97 <xs:enumeration value="cql_rpn"/>
98 <xs:enumeration value="frontend_net"/>
99 <xs:enumeration value="http_file"/>
100 <xs:enumeration value="load_balance"/>
101 <xs:enumeration value="log"/>
102 <xs:enumeration value="multi"/>
103 <xs:enumeration value="query_rewrite"/>
104 <xs:enumeration value="record_transform"/>
105 <xs:enumeration value="session_shared"/>
106 <xs:enumeration value="sru_z3950"/>
107 <xs:enumeration value="virt_db"/>
108 <xs:enumeration value="z3950_client"/>
112 <xs:attribute name="refid" type="xs:NCName"/>
113 <xs:attribute name="id" type="xs:NCName"/>
114 <xs:attribute name="name" type="xs:NCName"/>
117 <xs:attributeGroup name="filter_refid">
118 <xs:attribute name="refid" use="required" type="xs:NCName"/>
120 <xs:group name="filter_auth_simple">
122 <xs:element minOccurs="0" ref="mp:userRegister"/>
123 <xs:element minOccurs="0" ref="mp:targetRegister"/>
124 <xs:element minOccurs="0" ref="mp:discardUnauthorisedTargets"/>
127 <xs:element name="userRegister" type="xs:string"/>
128 <xs:element name="targetRegister" type="xs:string"/>
129 <xs:element name="discardUnauthorisedTargets">
132 <xs:attributeGroup name="filter_auth_simple">
133 <xs:attribute name="type" use="required">
135 <xs:restriction base="xs:token">
136 <xs:enumeration value="auth_simple"/>
140 <xs:attribute name="id" type="xs:NCName"/>
141 <xs:attribute name="name" type="xs:NCName"/>
143 <xs:attributeGroup name="filter_backend_test">
144 <xs:attribute name="type" use="required">
146 <xs:restriction base="xs:token">
147 <xs:enumeration value="backend_test"/>
151 <xs:attribute name="id" type="xs:NCName"/>
152 <xs:attribute name="name" type="xs:NCName"/>
154 <xs:attributeGroup name="filter_bounce">
155 <xs:attribute name="type" use="required">
157 <xs:restriction base="xs:token">
158 <xs:enumeration value="bounce"/>
162 <xs:attribute name="id" type="xs:NCName"/>
163 <xs:attribute name="name" type="xs:NCName"/>
165 <xs:element name="conversion">
167 <xs:attribute name="file" use="required" type="xs:string"/>
170 <xs:attributeGroup name="filter_cql_rpn">
171 <xs:attribute name="type" use="required">
173 <xs:restriction base="xs:token">
174 <xs:enumeration value="cql_rpn"/>
178 <xs:attribute name="id" type="xs:NCName"/>
179 <xs:attribute name="name" type="xs:NCName"/>
181 <xs:group name="filter_frontend_net">
183 <xs:element minOccurs="0" ref="mp:threads"/>
184 <xs:element maxOccurs="unbounded" ref="mp:port"/>
185 <xs:element minOccurs="0" ref="mp:timeout"/>
188 <xs:element name="threads" type="xs:integer"/>
189 <xs:element name="port" type="xs:string"/>
190 <xs:element name="timeout" type="xs:integer"/>
191 <xs:attributeGroup name="filter_frontend_net">
192 <xs:attribute name="type" use="required">
194 <xs:restriction base="xs:token">
195 <xs:enumeration value="frontend_net"/>
199 <xs:attribute name="id" type="xs:NCName"/>
200 <xs:attribute name="name" type="xs:NCName"/>
202 <xs:group name="filter_http_file">
204 <xs:element ref="mp:mimetypes"/>
205 <xs:element ref="mp:area"/>
208 <xs:element name="mimetypes" type="xs:string"/>
209 <xs:element name="area">
212 <xs:element ref="mp:documentroot"/>
213 <xs:element ref="mp:prefix"/>
217 <xs:element name="documentroot" type="xs:string"/>
218 <xs:element name="prefix" type="xs:string"/>
219 <xs:attributeGroup name="filter_http_file">
220 <xs:attribute name="type" use="required">
222 <xs:restriction base="xs:token">
223 <xs:enumeration value="http_file"/>
227 <xs:attribute name="id" type="xs:NCName"/>
228 <xs:attribute name="name" type="xs:NCName"/>
230 <xs:attributeGroup name="filter_load_balance">
231 <xs:attribute name="type" use="required">
233 <xs:restriction base="xs:token">
234 <xs:enumeration value="load_balance"/>
238 <xs:attribute name="id" type="xs:NCName"/>
239 <xs:attribute name="name" type="xs:NCName"/>
241 <xs:group name="filter_log">
243 <xs:element minOccurs="0" ref="mp:message"/>
244 <xs:element minOccurs="0" ref="mp:time-format"/>
245 <xs:element minOccurs="0" ref="mp:filename"/>
246 <xs:element minOccurs="0" ref="mp:category"/>
249 <xs:element name="message" type="xs:string"/>
250 <xs:element name="time-format" type="xs:string"/>
251 <xs:element name="filename" type="xs:string"/>
252 <xs:element name="category">
254 <xs:attribute name="user-access" type="xs:boolean"/>
255 <xs:attribute name="access" type="xs:boolean"/>
256 <xs:attribute name="init-options" type="xs:boolean"/>
257 <xs:attribute name="request-session" type="xs:boolean"/>
258 <xs:attribute name="response-session" type="xs:boolean"/>
259 <xs:attribute name="apdu" type="xs:boolean"/>
260 <xs:attribute name="request-apdu" type="xs:boolean"/>
261 <xs:attribute name="response-apdu" type="xs:boolean"/>
264 <xs:attributeGroup name="filter_log">
265 <xs:attribute name="type" use="required">
267 <xs:restriction base="xs:token">
268 <xs:enumeration value="log"/>
272 <xs:attribute name="id" type="xs:NCName"/>
273 <xs:attribute name="name" type="xs:NCName"/>
275 <xs:group name="filter_multi">
277 <xs:element minOccurs="0" maxOccurs="unbounded" ref="mp:target"/>
278 <xs:element minOccurs="0" ref="mp:hideunavailable"/>
279 <xs:element minOccurs="0" ref="mp:mergetype"/>
282 <xs:element name="target">
285 <xs:extension base="xs:string">
286 <xs:attribute name="route" use="required" type="xs:string"/>
291 <xs:element name="hideunavailable">
294 <xs:element name="mergetype" type="xs:string"/>
295 <xs:attributeGroup name="filter_multi">
296 <xs:attribute name="type" use="required">
298 <xs:restriction base="xs:token">
299 <xs:enumeration value="multi"/>
303 <xs:attribute name="id" type="xs:NCName"/>
304 <xs:attribute name="name" type="xs:NCName"/>
306 <xs:element name="xslt">
308 <xs:attribute name="stylesheet" use="required" type="xs:string"/>
311 <xs:attributeGroup name="filter_query_rewrite">
312 <xs:attribute name="type" use="required">
314 <xs:restriction base="xs:token">
315 <xs:enumeration value="query_rewrite"/>
319 <xs:attribute name="id" type="xs:NCName"/>
320 <xs:attribute name="name" type="xs:NCName"/>
322 <xs:element name="filter_record_transform" abstract="true">
325 <xs:element maxOccurs="unbounded" ref="y:retrieval"/>
327 <xs:attribute name="version" use="required">
329 <xs:restriction base="xs:token">
330 <xs:enumeration value="1.0"/>
336 <xs:attributeGroup name="filter_record_transform">
337 <xs:attribute name="type" use="required">
339 <xs:restriction base="xs:token">
340 <xs:enumeration value="record_transform"/>
344 <xs:attribute name="id" type="xs:NCName"/>
345 <xs:attribute name="name" type="xs:NCName"/>
347 <xs:group name="filter_session_shared">
349 <xs:element minOccurs="0" ref="mp:resultset"/>
350 <xs:element minOccurs="0" ref="mp:session"/>
353 <xs:element name="resultset">
355 <xs:attribute name="max" use="required" type="xs:integer"/>
356 <xs:attribute name="ttl" use="required" type="xs:integer"/>
359 <xs:element name="session">
361 <xs:attribute name="ttl" use="required" type="xs:integer"/>
364 <xs:attributeGroup name="filter_session_shared">
365 <xs:attribute name="type" use="required">
367 <xs:restriction base="xs:token">
368 <xs:enumeration value="session_shared"/>
372 <xs:attribute name="id" type="xs:NCName"/>
373 <xs:attribute name="name" type="xs:NCName"/>
375 <xs:group name="filter_sru_z3950">
377 <xs:element maxOccurs="unbounded" ref="mp:database"/>
380 <xs:element name="database">
383 <xs:extension base="mp:any">
384 <xs:attribute name="name" use="required" type="xs:NCName"/>
389 <xs:attributeGroup name="filter_sru_z3950">
390 <xs:attribute name="type" use="required">
392 <xs:restriction base="xs:token">
393 <xs:enumeration value="sru_z3950"/>
397 <xs:attribute name="id" type="xs:NCName"/>
398 <xs:attribute name="name" type="xs:NCName"/>
400 <xs:group name="filter_virt_db">
402 <xs:element maxOccurs="unbounded" ref="mp:virtual"/>
405 <xs:element name="virtual">
408 <xs:element name="database" type="xs:NCName"/>
409 <xs:element maxOccurs="unbounded" name="target" type="xs:string"/>
411 <xs:attribute name="route" type="xs:NCName"/>
414 <xs:attributeGroup name="filter_virt_db">
415 <xs:attribute name="type" use="required">
417 <xs:restriction base="xs:token">
418 <xs:enumeration value="virt_db"/>
422 <xs:attribute name="id" type="xs:NCName"/>
423 <xs:attribute name="name" type="xs:NCName"/>
425 <xs:group name="filter_z3950_client">
427 <xs:element minOccurs="0" ref="mp:timeout"/>
428 <xs:element minOccurs="0" ref="mp:default_target"/>
429 <xs:element minOccurs="0" ref="mp:force_target"/>
432 <xs:element name="default_target" type="xs:string"/>
433 <xs:element name="force_target" type="xs:string"/>
434 <xs:attributeGroup name="filter_z3950_client">
435 <xs:attribute name="type" use="required">
437 <xs:restriction base="xs:token">
438 <xs:enumeration value="z3950_client"/>
442 <xs:attribute name="id" type="xs:NCName"/>
443 <xs:attribute name="name" type="xs:NCName"/>
447 filter_zeerex_explain =
448 attribute type { "zeerex_explain" },
449 attribute id { xsd:NCName }?,
450 attribute name { xsd:NCName }?,
451 element mp:database {
452 attribute name { xsd:NCName },