doc/sru_z3950.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-sru_z3950">
   8  <refmeta>
   9   <refentrytitle>sru_z3950</refentrytitle>
  10   <manvolnum>3mp</manvolnum>
  11   <refmiscinfo>Metaproxy Module</refmiscinfo>
  12  </refmeta>
  13
  14  <refnamediv>
  15   <refname>sru_z3950</refname>
  16   <refpurpose>Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
  17  </refnamediv>
  18
  19  <refsect1><title>DESCRIPTION</title>
  20   <para>
  21    The <literal>sru_z3950</literal> Metaproxy filter transforms valid
  22    SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
  23    received hit counts and XML records into suitable SRU response messages.
  24   </para>
  25   <para>
  26    Multiple database elements defining the names of the accepted
  27    databases are allowed in the configuration file. Each
  28    of them must contain their own explain record, or must be empty.
  29    Notice that explain
  30    records come in SRU and Z39.50 flavors, and this filter requires
  31    the SRU version. See the
  32    <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
  33    standard pages and the
  34    <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
  35    for more information.
  36   </para>
  37   <para>
  38    All Z39.50 packages and all HTTP packages that do not resolve to
  39    one configured database name are passed unaltered to the next
  40    filters on the route.
  41    </para>
  42   <para>
  43    The SRU <literal>explain</literal> operation is supported,
  44    returning either the absolute minimum required by the standard, or
  45    a  full  pre-defined ZeeReX explain record.
  46   </para>
  47   <para>
  48    It supports the SRU <literal>searchRetrieve</literal> operation, which
  49    is transformed into successive Z3950 <literal>init</literal>,
  50    <literal>search</literal> and <literal>present</literal> requests.
  51   </para>
  52   <para>
  53    The SRU <literal>scan</literal> operation is not supported.
  54    </para>
  55   <para>
  56    This filter does not handle CQL-to-PQF translations. In case that
  57    the backends do not understand CQL, you need to append the
  58    <literal>cql_pqf</literal> metaproxy filter.
  59   </para>
  60   <para>
  61     This module supports the following SRU extra parameters:
  62     <variablelist>
  63       <varlistentry>
  64         <term>x-target</term>
  65         <listitem>
  66           <para>
  67             Specifies backend Z39.50 target.
  68           </para>
  69         </listitem>
  70       </varlistentry>
  71       <varlistentry>
  72         <term>x-max-sockets</term>
  73         <listitem>
  74           <para>
  75             Specifies maximum number of sockets to use for a Z39.50 backend
  76             client (for one given target host/db).
  77           </para>
  78         </listitem>
  79       </varlistentry>
  80     </variablelist>
  81   </para>
  82  </refsect1>
  83
  84  <refsect1><title>EXAMPLES</title>
  85   <para>
  86    A typical configuration looks like this:
  87    <screen><![CDATA[
  88     <filter type="sru_z3950">
  89       <database name="Default">
  90         <explain xmlns="http://explain.z3950.org/dtd/2.0/">
  91           ...
  92         </explain>
  93       </database>
  94       <database name="Dummy">
  95     </filter>
  96
  97 ]]>
  98    </screen>
  99   </para>
 100  </refsect1>
 101
 102  <refsect1><title>SEE ALSO</title>
 103   <para>
 104    <citerefentry>
 105     <refentrytitle>metaproxy</refentrytitle>
 106     <manvolnum>1</manvolnum>
 107    </citerefentry>
 108   </para>
 109  </refsect1>
 110
 111  &copyright;
 112 </refentry>
 113
 114 <!-- Keep this comment at the end of the file
 115 Local variables:
 116 mode: sgml
 117 sgml-omittag:t
 118 sgml-shorttag:t
 119 sgml-minimize-attributes:nil
 120 sgml-always-quote-attributes:t
 121 sgml-indent-step:1
 122 sgml-indent-data:t
 123 sgml-parent-document:nil
 124 sgml-local-catalogs: nil
 125 sgml-namecase-general:t
 126 End:
 127 -->