doc/gfs-virtual.xml

   1 <!--
   2    Description of the virtual host mechanism in YAZ GFS
   3    Included in both manual and man page for yaz-ztest
   4 -->
   5
   6 <para>
   7  The Virtual hosts mechanism allows a YAZ frontend server to
   8  support multiple backends. A backend is selected on the basis of
   9  the TCP/IP binding (port+listening adddress) and/or the virtual host.
  10 </para>
  11 <para>
  12  A backend can be configured to execute in a particular working
  13  directory. Or the YAZ frontend may perform CQL to RPN conversion, thus
  14  allowing traditional Z39.50 backends to be offered as a SRW/SRU
  15  service. SRW/SRU Explain information for a particular backend may also
  16  be specified.
  17 </para>
  18 <para>
  19  For the HTTP protocol, the virtual host is specified in the Host header.
  20  For the Z39.50 protocol, the virtual host is specified as in the
  21  Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1.
  22 </para>
  23 <note>
  24  <para>
  25   Not all Z39.50 clients allows the VHOST information to be set.
  26   For those the selection of the backend must rely on the
  27   TCP/IP information alone (port and address).
  28  </para>
  29 </note>
  30 <para>
  31  The YAZ frontend server uses XML to describe the backend
  32  configurations. Command-line option <literal>-f</literal>
  33  specifies filename of the XML configuration.
  34 </para>
  35 <para>
  36  The configuration uses the root element <literal>yazgfs</literal>.
  37  This element includes a list of <literal>listen</literal> elements,
  38  followed by one or more <literal>server</literal> elements.
  39 </para>
  40 <para>
  41  The <literal>listen</literal> describes listener (transport end point),
  42  such as TCP/IP, Unix file socket or SSL server. Content for
  43  a listener:
  44  <variablelist>
  45   <varlistentry><term>CDATA (required)</term>
  46    <listitem>
  47     <para>
  48      The CDATA for the <literal>listen</literal> element holds the
  49      listener string, such as <literal>tcp:@:210</literal>,
  50      <literal>tcp:server1:2100</literal>,
  51      etc.
  52     </para>
  53    </listitem>
  54   </varlistentry>
  55   <varlistentry><term>attribute <literal>id</literal> (optional)</term>
  56     <listitem>
  57      <para>
  58       identifier for this listener. This may be referred to from
  59       server sections.
  60      </para>
  61     </listitem>
  62    </varlistentry>
  63  </variablelist>
  64  <note>
  65   <para>
  66    We expect more information to be added for the listen section in
  67    a future version, such as CERT file for SSL servers.
  68   </para>
  69  </note>
  70 </para>
  71 <para>
  72  The <literal>server</literal> describes a server and the parameters
  73  for this server type. Content for a server:
  74  <variablelist>
  75   <varlistentry><term>attribute <literal>id</literal> (optional)</term>
  76    <listitem>
  77     <para>
  78      Identifier for this server. Currently not used for anything,
  79      but it might be for logging purposes.
  80    </para>
  81    </listitem>
  82   </varlistentry>
  83
  84   <varlistentry><term>attribute <literal>listenref</literal> (optional)</term>
  85    <listitem>
  86     <para>
  87      Specifies listener for this server. If this attribute is not
  88      given, the server is accessible from all listener. In order
  89      for the server to be used for real, howeever, the virtual host
  90      must match (if specified in the configuration).
  91     </para>
  92    </listitem>
  93   </varlistentry>
  94
  95   <varlistentry><term>element <literal>config</literal> (optional)</term>
  96    <listitem>
  97     <para>
  98      Specifies the server configuration. This is equivalent
  99      to the config specified using command line option
 100      <literal>-c</literal>.
 101     </para>
 102    </listitem>
 103   </varlistentry>
 104
 105   <varlistentry><term>element <literal>directory</literal> (optional)</term>
 106    <listitem>
 107     <para>
 108      Specifies a working directory for this backend server. If
 109      specifid, the YAZ fronend changes current working directory
 110      to this directory whenever a backend of this type is
 111      started (backend handler bend_start), stopped (backend handler hand_stop)
 112      and initialized (bend_init).
 113     </para>
 114    </listitem>
 115   </varlistentry>
 116
 117   <varlistentry><term>element <literal>host</literal> (optional)</term>
 118    <listitem>
 119     <para>
 120      Specifies the virtual host for this server. If this is specified
 121      a client <emphasis>must</emphasis> specify this host string in
 122      order to use this backend.
 123     </para>
 124    </listitem>
 125   </varlistentry>
 126
 127   <varlistentry><term>element <literal>cql2rpn</literal> (optional)</term>
 128    <listitem>
 129     <para>
 130      Specifies a filename that includes CQL to RPN conversion for this
 131      backend server. See &reference-tools-cql-map;
 132      If given, the backend server will only "see" a Type-1/RPN query.
 133     </para>
 134    </listitem>
 135   </varlistentry>
 136
 137   <varlistentry><term>element <literal>ccl2rpn</literal> (optional)</term>
 138    <listitem>
 139     <para>
 140      Specifies a filename that includes CCL to RPN conversion for this
 141      backend server. See &reference-tools-ccl-qualifiers;
 142      If given, the backend server will only "see" a Type-1/RPN query.
 143     </para>
 144    </listitem>
 145   </varlistentry>
 146
 147   <varlistentry><term>element <literal>stylesheet</literal> (optional)</term>
 148    <listitem>
 149     <para>
 150      Specifies the stylesheet reference to be part of SRU HTTP responses
 151      when the client does not specify one. If neither this is given, nor
 152      the client specifies one, no stylesheet reference is part of the
 153      SRU HTTP response.
 154     </para>
 155    </listitem>
 156   </varlistentry>
 157
 158   <varlistentry><term>element <literal>docpath</literal> (optional)</term>
 159    <listitem>
 160     <para>
 161      Specifies a path for local file access using HTTP. All URLs with
 162      a leading prefix (/ exluded) that matches the value of docpath
 163      are used for file access. For example, if the server is to offer
 164      access in directory <literal>xsl</literal>, the docpath would be
 165      <literal>xsl</literal> and all URLs of the form
 166      <literal>http://host/exl</literal> will result in a local file access.
 167     </para>
 168    </listitem>
 169   </varlistentry>
 170
 171   <varlistentry><term>element <literal>explain</literal> (optional)</term>
 172    <listitem>
 173     <para>
 174      Specifies SRW/SRU ZeeRex content for this server. Copied verbatim
 175      to the client. As things are now, some of the Explain content
 176      seeem redundant because host information, etc. is also stored
 177      elsewhere.
 178     </para>
 179    </listitem>
 180   </varlistentry>
 181
 182   <varlistentry><term>element <literal>maximumrecordsize</literal> (optional)</term>
 183    <listitem>
 184     <para>
 185      Specifies maximum record size/message size, in bytes. This
 186      value also servers as maximum size of <emphasis>incoming</emphasis>
 187      packages (for Record Updates etc). It's the same value as that
 188      given by the <literal>-k</literal> option.
 189     </para>
 190    </listitem>
 191   </varlistentry>
 192
 193   <varlistentry><term>element <literal>retrievalinfo</literal> (optional)</term>
 194    <listitem>
 195     <para>
 196      Enables the retrieval facility supporting conversions and
 197      specifications of record formats/types.
 198      See <xref linkend="tools.retrieval"/> for
 199      more information.
 200     </para>
 201    </listitem>
 202   </varlistentry>
 203
 204  </variablelist>
 205 </para>
 206
 207 <para>
 208  The XML below configures a server that accepts connections from
 209  two ports, TCP/IP port 9900 and a local UNIX file socket.
 210  We name the TCP/IP server <literal>public</literal> and the
 211  other server <literal>internal</literal>.
 212  </para>
 213  <screen>
 214   <![CDATA[
 215  <yazgfs>
 216   <listen id="public">tcp:@:9900</listen>
 217   <listen id="internal">unix:/var/tmp/socket</listen>
 218   <server id="server1">
 219     <host>server1.mydomain</host>
 220     <directory>/var/www/s1</directory>
 221     <config>config.cfg</config>
 222   </server>
 223   <server id="server2">
 224     <host>server2.mydomain</host>
 225     <directory>/var/www/s2</directory>
 226     <config>config.cfg</config>
 227     <cql2rpn>../etc/pqf.properties</cql2rpn>
 228     <explain xmlns="http://explain.z3950.org/dtd/2.0/">
 229       <serverInfo>
 230         <host>server2.mydomain</host>
 231         <port>9900</port>
 232         <database>a</database>
 233       </serverInfo>
 234     </explain>
 235   </server>
 236   <server id="server3" listenref="internal">
 237     <directory>/var/www/s3</directory>
 238     <config>config.cfg</config>
 239   </server>
 240  </yazgfs>
 241 ]]>
 242  </screen>
 243 <para>
 244  There are three configured backend servers. The first two
 245  servers, <literal>"server1"</literal> and <literal>"server2"</literal>,
 246  can be reached by both listener addresses - since
 247  no <literal>listenref</literal> attribute is specified.
 248  In order to distinguish between the two a virtual host has
 249  been specified for each of server in the <literal>host</literal>
 250  elements.
 251 </para>
 252 <para>
 253  For <literal>"server2"</literal> elements for CQL to RPN conversion
 254  is supported and explain information has been added (a short one here
 255  to keep the example small).
 256 </para>
 257 <para>
 258  The third server, <literal>"server3"</literal> can only be reached
 259  via listener <literal>"internal"</literal>.
 260 </para>
 261
 262 <!-- Keep this comment at the end of the file
 263 Local variables:
 264 mode: sgml
 265 sgml-omittag:t
 266 sgml-shorttag:t
 267 sgml-minimize-attributes:nil
 268 sgml-always-quote-attributes:t
 269 sgml-indent-step:1
 270 sgml-indent-data:t
 271 sgml-parent-document: "yaz.xml"
 272 sgml-local-catalogs: nil
 273 sgml-namecase-general:t
 274 End:
 275 -->