More examples

[yazproxy-moved-to-github.git] / doc / reference.xml

diff --git a/doc/reference.xml b/doc/reference.xml
index 2bd922d..aeeefa1 100644 (file)
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -17,7 +17,7 @@
    </para>
   </section>
   <section id="proxy-target">
-   <title>Specifying the Backend Server</title>
+   <title>Choosing the Backend Server</title>
    <para>
     When the proxy receives a Z39.50 Initialize Request from a Z39.50
     client, it determines the backend server by the following rules:
@@ -57,6 +57,30 @@
      </listitem>
     </orderedlist>
    </para>
+   <para>
+    If the proxy receives an SRW/SRU request, the following rules are used.
+    <orderedlist>
+     <listitem>
+      <para>If default target has Explain information with a
+       <literal>database</literal> that matches the path of the
+       HTTP request of SRW/SRU that backend server is used for
+       SRW/SRU operation.
+       </para>
+     </listitem>
+     <listitem>
+      <para>
+       Otherwise the service will return HTTP 404 (Not found).
+      </para>
+     </listitem>
+    </orderedlist>
+   </para>
+   <note>
+    <para>
+     We know it is stupid to only check for explain in default target.
+     It means that it is only possible to offer one SRW/SRU server.
+     We expect to improve that in the next version of the YAZ proxy.
+    </para>
+   </note>
   </section>
   <section id="proxy-keepalive">
    <title>Keep-alive Facility</title>
@@ -104,6 +128,10 @@
     <ulink url="http://xmlsoft.org/XSLT/">libXSLT</ulink> support in
     order for the config file facility to be enabled.
    </para>
+   <para>
+    See <xref linkend="yazproxy-schema"/> for an XML schema
+    for the configuration.
+   </para>
    <tip>
     <para>To check for a config file to be well-formed, the yazproxy may
      be invoked without specifying a listening port, i.e.
@@ -649,7 +677,114 @@
     <literal>characterInfo</literal> of the <literal>information</literal>
      choice.
    </para>
-   </section>
+  </section>
+  <section id="yazproxy-schema">
+   <title>YAZ Proxy Configuration Schema</title>
+   <para>
+    Here an XML Schema for the YAZ proxy configuration file. 
+    The schema, <filename>yazproxy.xsd</filename> is located in sub
+    directory <filename>etc</filename> of the distribution.
+   </para>
+   <screen><![CDATA[
+    <?xml version="1.0"?>
+<!-- XML Schema for YAZ proxy config file.
+    $Id: reference.xml,v 1.3 2004-04-20 23:49:48 adam Exp $
+-->
+<xs:schema
+  xmlns:xs="http://www.w3.org/2001/XMLSchema"
+  xmlns:exp="http://explain.z3950.org/dtd/2.0/"
+  xmlns="http://indexdata.dk/yazproxy/schema/0.8/"
+  targetNamespace="http://indexdata.dk/yazproxy/schema/0.8/"
+  >
+ <xs:import namespace="http://explain.z3950.org/dtd/2.0/" 
+      schemaLocation="zeerex-2.0.xsd"/>
+ <xs:element name="proxy">
+  <xs:complexType>
+   <xs:sequence>
+    <xs:element ref="target" minOccurs="0" maxOccurs="unbounded"/>
+    <xs:element ref="max-clients" minOccurs="0"/>
+    <xs:element ref="log" minOccurs="0"/>
+   </xs:sequence>
+  </xs:complexType>
+ </xs:element>
+
+ <xs:element name="target">
+  <xs:complexType>
+   <xs:sequence>
+     <xs:element ref="url" minOccurs="0" maxOccurs="unbounded"/>
+     <xs:element ref="target-timeout" minOccurs="0"/>
+     <xs:element ref="client-timeout" minOccurs="0"/>
+     <xs:element ref="keepalive" minOccurs="0"/>
+     <xs:element ref="limit" minOccurs="0"/>
+     <xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded"/>
+     <xs:element ref="syntax" minOccurs="0" maxOccurs="unbounded"/>
+     <xs:element ref="preinit" minOccurs="0"/>
+     <xs:element name="exp:explain" minOccurs="0"/>
+     <xs:element ref="cql2rpn" minOccurs="0"/>
+   </xs:sequence>
+   <xs:attribute name="default" type="xs:string" use="optional"/>
+   <xs:attribute name="name" type="xs:string"/>
+  </xs:complexType>
+ </xs:element>
+
+ <xs:element name="url" type="xs:string"/>
+ <xs:element name="target-timeout" type="xs:integer"/>
+ <xs:element name="client-timeout" type="xs:integer"/>
+ <xs:element name="bandwidth" type="xs:integer"/>
+ <xs:element name="pdu" type="xs:integer"/>
+ <xs:element name="retrieve" type="xs:integer"/>
+ <xs:element name="preinit" type="xs:integer"/>
+ <xs:element name="cql2rpn" type="xs:string"/>
+
+ <xs:element name="keepalive">
+  <xs:complexType>
+   <xs:sequence>
+    <xs:element ref="bandwidth" minOccurs="0"/>
+    <xs:element ref="pdu" minOccurs="0"/>
+   </xs:sequence>
+  </xs:complexType>
+ </xs:element>
+ <xs:element name="limit">
+  <xs:complexType>
+   <xs:sequence>
+    <xs:element ref="bandwidth" minOccurs="0"/>
+    <xs:element ref="pdu" minOccurs="0"/>
+    <xs:element ref="retrieve" minOccurs="0"/>
+   </xs:sequence>
+  </xs:complexType>
+ </xs:element>
+ 
+ <xs:element name="attribute">
+  <xs:complexType>
+   <xs:attribute name="type" type="xs:string"/>
+   <xs:attribute name="value" type="xs:string"/>
+   <xs:attribute name="error" type="xs:integer"/>
+  </xs:complexType>
+ </xs:element>
+
+ <xs:element name="syntax">
+  <xs:complexType>
+   <xs:sequence>
+    <xs:element name="title" type="xs:string" minOccurs="0"/>
+    <xs:element name="name" type="xs:string" minOccurs="0"
+                                             maxOccurs="unbounded"/>
+   </xs:sequence>
+   <xs:attribute name="error" type="xs:string" minOccurs="0"/>
+   <xs:attribute name="type" type="xs:string" minOccurs="0"/>
+   <xs:attribute name="marcxml" type="xs:string" minOccurs="0"/>
+   <xs:attribute name="identifier" type="xs:string" minOccurs="0"/>
+   <xs:attribute name="stylesheet" type="xs:string" minOccurs="0"/>
+  </xs:complexType>
+ </xs:element>
+
+ <xs:element name="max-clients" type="xs:integer"/>
+ <xs:element name="log" type="xs:string"/>
+
+</xs:schema>
+
+]]>
+   </screen>
+  </section>
  </chapter>
 
  <!-- Keep this comment at the end of the file