etc/config.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- $Id: config.xsd,v 1.13 2006-02-02 18:20:41 mike 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:element ref="config:message"/>
  62
  63         <!-- type="virt_db" or type="multi" -->
  64         <xs:element minOccurs="0" maxOccurs="unbounded" ref="config:virtual"/>
  65
  66         <!-- type="auth_simple" -->
  67         <xs:sequence>
  68           <xs:element minOccurs="0" ref="config:userRegister"/>
  69           <xs:element minOccurs="0" ref="config:targetRegister"/>
  70           <xs:element minOccurs="0" name="discardUnauthorisedTargets">
  71             <xs:complexType/>
  72           </xs:element>
  73         </xs:sequence>
  74
  75         <!-- type="backend_test" -->
  76         <!-- No elements included -->
  77
  78         <!-- type="session_shared" -->
  79         <!-- No example configuration to deduce from yet -->
  80
  81         <!-- type="template" -->
  82         <!-- No example configuration to deduce from yet -->
  83
  84       </xs:choice>
  85       <xs:attribute name="id" type="xs:NCName"/>
  86       <xs:attribute name="refid" type="xs:NCName"/>
  87       <xs:attribute name="type">
  88         <xs:simpleType>
  89           <xs:restriction base="xs:NCName">
  90             <xs:enumeration value="frontend_net"/>
  91             <xs:enumeration value="z3950_client"/>
  92             <xs:enumeration value="log"/>
  93             <xs:enumeration value="virt_db"/>
  94             <xs:enumeration value="auth_simple"/>
  95             <xs:enumeration value="backend_test"/>
  96             <xs:enumeration value="multi"/>
  97             <xs:enumeration value="session_shared"/>
  98             <xs:enumeration value="template"/>
  99           </xs:restriction>
 100         </xs:simpleType>
 101       </xs:attribute>
 102     </xs:complexType>
 103   </xs:element>
 104
 105   <xs:element name="threads" type="xs:integer"/>
 106   <xs:element name="port" type="xs:string"/>
 107   <xs:element name="timeout" type="xs:integer"/>
 108   <xs:element name="message" type="xs:NCName"/>
 109   <xs:element name="userRegister" type="xs:string"/>
 110   <xs:element name="targetRegister" type="xs:string"/>
 111   <xs:element name="discardUnauthorisedTargets" type="xs:string"/>
 112
 113   <!-- ### This is used differently depending on whether it occurs
 114        within a "virt_db" or "multi" filter: for the former, it
 115        contains one database and one target; for the latter, it
 116        contains an optional vhost and one or more targets.  This
 117        schema should be tweaked to enforce this. -->
 118   <xs:element name="virtual">
 119     <xs:complexType>
 120       <xs:sequence>
 121         <xs:element minOccurs="0" ref="config:database"/>
 122         <xs:element minOccurs="0" ref="config:vhost"/>
 123         <xs:element maxOccurs="unbounded" ref="config:target"/>
 124       </xs:sequence>
 125       <xs:attribute name="route" type="xs:NCName"/>
 126     </xs:complexType>
 127   </xs:element>
 128
 129   <xs:element name="database" type="xs:NCName"/>
 130   <xs:element name="vhost" type="xs:NCName"/>
 131   <xs:element name="target" type="xs:anyURI"/>
 132
 133
 134   <xs:element name="routes">
 135     <xs:complexType>
 136       <xs:sequence>
 137         <xs:element minOccurs="1" maxOccurs="unbounded" ref="config:route"/>
 138       </xs:sequence>
 139     </xs:complexType>
 140   </xs:element>
 141
 142   <xs:element name="route">
 143     <xs:complexType>
 144       <xs:sequence>
 145         <xs:element maxOccurs="unbounded" ref="config:filter"/>
 146       </xs:sequence>
 147       <xs:attribute name="id" use="required" type="xs:NCName"/>
 148     </xs:complexType>
 149   </xs:element>
 150 </xs:schema>