etc/config.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- $Id: config.xsd,v 1.19 2006-06-20 22:29:38 adam Exp $ -->
   3 <!--
   4         This Schema prescribes the format of YP2 configuration files.
   5         Invoke it like this:
   6                 xmllint -noout -schema config.xsd config1.xml
   7         But use double-dashes for the option names instead of single.
   8         (I couldn't include them literally, as, believe it or not,
   9         it's an error to include a double dash in an XML comment.
  10 -->
  11 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  12            elementFormDefault="qualified"
  13            targetNamespace="http://indexdata.dk/yp2/config/1"
  14            xmlns:config="http://indexdata.dk/yp2/config/1">
  15
  16   <xs:element name="yp2">
  17     <xs:complexType>
  18       <xs:sequence>
  19         <xs:element ref="config:start"/>
  20         <xs:element minOccurs="0" ref="config:filters"/>
  21         <xs:element ref="config:routes"/>
  22       </xs:sequence>
  23     </xs:complexType>
  24   </xs:element>
  25
  26
  27   <xs:element name="start">
  28     <xs:complexType>
  29       <!-- Absence of elements listed here mandates that <start> is empty -->
  30       <xs:attribute name="route" use="required" type="xs:NCName"/>
  31     </xs:complexType>
  32   </xs:element>
  33
  34
  35   <xs:element name="filters">
  36     <xs:complexType>
  37       <xs:sequence>
  38         <xs:element maxOccurs="unbounded" ref="config:filter"/>
  39       </xs:sequence>
  40     </xs:complexType>
  41   </xs:element>
  42
  43   <xs:element name="filter">
  44     <xs:complexType>
  45       <xs:choice>
  46         <!-- In general, the content depends on the "type" attribute.
  47              Perhaps the various filter-types' configuration
  48              structures should each be described by their own little
  49              subschemas? -->
  50
  51         <!-- type="frontend_net" -->
  52         <xs:sequence>
  53           <xs:element minOccurs="0" ref="config:threads"/>
  54           <xs:element ref="config:port"/>
  55         </xs:sequence>
  56
  57         <!-- type="z3950_client" -->
  58         <xs:element ref="config:timeout"/>
  59
  60         <!-- type="log" -->
  61         <xs:sequence>
  62          <xs:element minOccurs="0" ref="config:message"/>
  63          <xs:element minOccurs="0" ref="config:filename"/>
  64          <xs:element minOccurs="0" name="category">
  65            <xs:complexType>
  66             <xs:attribute name="request-session" type="xs:boolean"/>
  67             <xs:attribute name="response-session" type="xs:boolean"/>
  68             <xs:attribute name="session" type="xs:boolean"/>
  69             <xs:attribute name="request-apdu" type="xs:boolean"/>
  70             <xs:attribute name="response-apdu" type="xs:boolean"/>
  71             <xs:attribute name="apdu" type="xs:boolean"/>
  72             <xs:attribute name="init-options" type="xs:boolean"/>
  73            </xs:complexType>
  74          </xs:element>
  75         </xs:sequence>
  76
  77
  78         <!-- type="virt_db" or type="multi" -->
  79         <xs:sequence>
  80           <xs:element minOccurs="0" maxOccurs="unbounded" ref="config:virtual"/>
  81           <xs:element minOccurs="0" maxOccurs="1" name="hideunavailable">
  82             <xs:complexType/>
  83           </xs:element>
  84         </xs:sequence>
  85
  86         <!-- type="auth_simple" -->
  87         <xs:sequence>
  88           <xs:element minOccurs="0" ref="config:userRegister"/>
  89           <xs:element minOccurs="0" ref="config:targetRegister"/>
  90           <xs:element minOccurs="0" name="discardUnauthorisedTargets">
  91             <xs:complexType/>
  92           </xs:element>
  93         </xs:sequence>
  94
  95         <!-- type="backend_test" -->
  96         <!-- No elements included -->
  97
  98         <!-- type="session_shared" -->
  99         <!-- No example configuration to deduce from yet -->
 100
 101         <!-- type="template" -->
 102         <!-- No example configuration to deduce from yet -->
 103
 104         <!-- type="http_file" -->
 105         <xs:sequence>
 106           <xs:element ref="config:mimetypes"/>
 107           <xs:element name="area">
 108             <xs:complexType>
 109               <xs:sequence>
 110                 <xs:element ref="config:documentroot"/>
 111                 <xs:element ref="config:prefix"/>
 112               </xs:sequence>
 113             </xs:complexType>
 114           </xs:element>
 115         </xs:sequence>
 116
 117         <!-- type="query_rewrite" -->
 118         <xs:element ref="config:xslt"/>
 119
 120       </xs:choice>
 121       <xs:attribute name="id" type="xs:NCName"/>
 122       <xs:attribute name="refid" type="xs:NCName"/>
 123       <xs:attribute name="type">
 124         <xs:simpleType>
 125           <xs:restriction base="xs:NCName">
 126             <xs:enumeration value="frontend_net"/>
 127             <xs:enumeration value="z3950_client"/>
 128             <xs:enumeration value="log"/>
 129             <xs:enumeration value="virt_db"/>
 130             <xs:enumeration value="auth_simple"/>
 131             <xs:enumeration value="backend_test"/>
 132             <xs:enumeration value="multi"/>
 133             <xs:enumeration value="session_shared"/>
 134             <xs:enumeration value="template"/>
 135             <xs:enumeration value="http_file"/>
 136             <xs:enumeration value="query_rewrite"/>
 137           </xs:restriction>
 138         </xs:simpleType>
 139       </xs:attribute>
 140     </xs:complexType>
 141   </xs:element>
 142
 143   <xs:element name="threads" type="xs:integer"/>
 144   <xs:element name="port" type="xs:string"/>
 145   <xs:element name="timeout" type="xs:integer"/>
 146   <xs:element name="message" type="xs:NCName"/>
 147   <xs:element name="filename" type="xs:string"/>
 148   <xs:element name="userRegister" type="xs:string"/>
 149   <xs:element name="targetRegister" type="xs:string"/>
 150   <xs:element name="discardUnauthorisedTargets" type="xs:string"/>
 151   <xs:element name="mimetypes" type="xs:string"/>
 152   <xs:element name="documentroot" type="xs:string"/>
 153   <xs:element name="prefix" type="xs:string"/>
 154   <xs:element name="xslt" type="xs:string"/>
 155
 156   <!-- ### This is used differently depending on whether it occurs
 157        within a "virt_db" or "multi" filter: for the former, it
 158        contains one database and one target; for the latter, it
 159        contains an optional vhost and one or more targets.  This
 160        schema should be tweaked to enforce this. -->
 161   <xs:element name="virtual">
 162     <xs:complexType>
 163       <xs:sequence>
 164         <xs:element minOccurs="0" ref="config:database"/>
 165         <xs:element minOccurs="0" ref="config:vhost"/>
 166         <xs:element maxOccurs="unbounded" ref="config:target"/>
 167       </xs:sequence>
 168       <xs:attribute name="route" type="xs:NCName"/>
 169     </xs:complexType>
 170   </xs:element>
 171
 172   <xs:element name="database" type="xs:NCName"/>
 173   <xs:element name="vhost" type="xs:NCName"/>
 174   <xs:element name="target" type="xs:anyURI"/>
 175
 176
 177   <xs:element name="routes">
 178     <xs:complexType>
 179       <xs:sequence>
 180         <xs:element minOccurs="1" maxOccurs="unbounded" ref="config:route"/>
 181       </xs:sequence>
 182     </xs:complexType>
 183   </xs:element>
 184
 185   <xs:element name="route">
 186     <xs:complexType>
 187       <xs:sequence>
 188         <xs:element maxOccurs="unbounded" ref="config:filter"/>
 189       </xs:sequence>
 190       <xs:attribute name="id" use="required" type="xs:NCName"/>
 191     </xs:complexType>
 192   </xs:element>
 193 </xs:schema>