This filter implements a generic client based on
<ulink url="&url.yaz.zoom;">ZOOM</ulink> of YAZ.
The client implements the protocols that ZOOM C does: Z39.50, SRU
- (GET, POST, SOAP) and SOLR .
+ (GET, POST, SOAP) and Solr .
</para>
<para>
</para>
</listitem>
</varlistentry>
+ <varlistentry id="auth_hostname">
+ <term>attribute <literal>auth_hostname</literal></term>
+ <listitem>
+ <para>
+ Limits IP lookup to a given logical hostname.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>attribute <literal>realm</literal></term>
<listitem>
</para>
<para>
Step 1: for CCL, the query is converted to RPN via
- <link linkend="cclmap"><literal>cclmap</literal></link> elements part of
+ <link linkend="zoom-torus-cclmap"><literal>cclmap</literal></link>
+ elements part of
the target profile as well as
<link linkend="cclmap_base">base CCL maps</link>.
</para>
<para>
Step 2: If the target is Z39.50-based, it is passed verbatim (RPN).
If the target is SRU-based, the RPN will be converted to CQL.
- If the target is SOLR-based, the RPN will be converted to SOLR's query
+ If the target is Solr-based, the RPN will be converted to Solr's query
type.
</para>
</refsect1>
The ZOOM module actively handle CQL sorting - using the SORTBY parameter
which was introduced in SRU version 1.2. The conversion from SORTBY clause
to native sort for some target is driven by the two parameters:
- <link linkend="sortStrategy"><literal>sortStrategy</literal></link>
- and <link linkend="sortmap"><literal>sortmap_</literal><replaceable>field</replaceable></link>.
+ <link linkend="zoom-torus-sortStrategy">
+ <literal>sortStrategy</literal>
+ </link>
+ and <link linkend="zoom-torus-sortmap">
+ <literal>sortmap_</literal><replaceable>field</replaceable>
+ </link>.
</para>
<para>
If a sort field that does not have an equivalent
</listitem>
</varlistentry>
- <varlistentry id="cclmap">
+ <varlistentry>
+ <term id="zoom-torus-authenticationMode">authenticationMode</term><listitem>
+ <para>
+ Specifies how authentication parameters are passed to server
+ for SRU. Possible values are: <literal>url</literal>
+ and <literal>basic</literal>. For the url mode username and password
+ are carried in URL arguments x-username and x-password.
+ For the basic mode, HTTP basic authentication is used.
+ The settings only takes effect
+ if <link linkend="zoom-torus-authentication">authentication</link>
+ is set.
+ </para>
+ <para>
+ If this value is omitted HTTP basic authencation is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="zoom-torus-cclmap">
<term>cclmap_<replaceable>field</replaceable></term><listitem>
<para>
This value specifies CCL field (qualifier) definition for some
</listitem>
</varlistentry>
- <varlistentry id="sortmap">
+ <varlistentry id="zoom-torus-sortmap">
<term>sortmap_<replaceable>field</replaceable></term><listitem>
<para>
This value the native field for a target. The form of the value is
- given by <link linkend="sortStrategy">sortStrategy</link>.
+ given by <link linkend="zoom-torus-sortStrategy">sortStrategy</link>.
</para>
</listitem>
</varlistentry>
- <varlistentry id="sortStrategy">
+ <varlistentry id="zoom-torus-sortStrategy">
<term>sortStrategy</term><listitem>
<para>
Specifies sort strategy for a target. One of:
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="sruVersion">
<term>sruVersion</term><listitem>
<para>
Specifies the SRU version to use. It unset, version 1.2 will be
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="transform">
<term>transform</term><listitem>
<para>
Specifies a XSL stylesheet filename to be used if record
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="udb">
<term>udb</term><listitem>
<para>
This value is required and specifies the unique database for
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="zurl">
<term>zurl</term><listitem>
<para>
This is setting is mandatory and specifies the ZURL of the
is a comma rather than a question mark. What follows question mark are
HTTP arguments (in this case SRU arguments).
</para>
+ <para>
+ The database parameters, in alphabetical order, are:
+ </para>
<variablelist>
<varlistentry>
<term>content-password</term>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>retry</term>
+ <listitem>
+ <para>
+ Optional paramater. If the value is 0, retry on failure is
+ disabled for the ZOOM module. Any other value enables retry
+ on failure. If this parameter is omitted, then the value of
+ <literal>retryOnFailure</literal>
+ from the Torus record is used (same values).
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>torus_url</term>