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