doc/book.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   4 [
   5      <!ENTITY copyright SYSTEM "copyright.xml">
   6      <!ENTITY % local SYSTEM "local.ent">
   7      %local;
   8      <!ENTITY manref SYSTEM "manref.xml">
   9      <!ENTITY gpl2 SYSTEM "gpl-2.0.xml">
  10      <!ENTITY % idcommon SYSTEM "common/common.ent">
  11      %idcommon;
  12 ]>
  13 <book>
  14  <bookinfo>
  15   <title>Metaproxy - User's Guide and Reference</title>
  16   <authorgroup>
  17    <author>
  18     <firstname>Adam</firstname><surname>Dickmeiss</surname>
  19    </author>
  20    <author>
  21     <firstname>Marc</firstname><surname>Cromme</surname>
  22    </author>
  23    <author>
  24     <firstname>Mike</firstname><surname>Taylor</surname>
  25    </author>
  26   </authorgroup>
  27   <releaseinfo>&version;</releaseinfo>
  28   <copyright>
  29    <year>2005-2014</year>
  30    <holder>Index Data</holder>
  31   </copyright>
  32   <abstract>
  33    <simpara>
  34     This manual is part of Metaproxy version &version;.
  35     </simpara>
  36    <simpara>
  37     Metaproxy is a universal router, proxy and encapsulated
  38     metasearcher for information retrieval protocols.  It accepts,
  39     processes, interprets and redirects requests from IR clients using
  40     standard protocols such as the binary
  41     <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink>
  42     and  the information search and retrieval
  43     web service <ulink url="&url.sru;">SRU</ulink>
  44     as well as functioning as a limited
  45     <ulink url="&url.http;">HTTP</ulink> server.
  46    </simpara>
  47    <simpara>
  48     Metaproxy is configured by an XML file which
  49     specifies how the software should function in terms of routes that
  50     the request packets can take through the proxy, each step on a
  51     route being an instantiation of a filter.  Filters come in many
  52     types, one for each operation: accepting Z39.50 packets, logging,
  53     query transformation, multiplexing, etc.  Further filter-types can
  54     be added as loadable modules to extend Metaproxy functionality,
  55     using the filter API.
  56    </simpara>
  57    <simpara>
  58     Metaproxy is covered by the GNU General Public License version 2.
  59    </simpara>
  60    <simpara>
  61     <inlinemediaobject>
  62      <imageobject>
  63       <imagedata fileref="common/id.png" format="PNG"/>
  64      </imageobject>
  65      <imageobject>
  66       <imagedata fileref="common/id.eps" format="EPS"/>
  67      </imageobject>
  68     </inlinemediaobject>
  69    </simpara>
  70   </abstract>
  71  </bookinfo>
  72
  73  <chapter id="introduction">
  74   <title>Introduction</title>
  75
  76   <para>
  77    <ulink url="&url.metaproxy;">Metaproxy</ulink>
  78    is a stand alone program that acts as a universal router, proxy and
  79    encapsulated metasearcher for information retrieval protocols such
  80    as <ulink url="&url.z39.50;">Z39.50</ulink> and
  81    <ulink url="&url.sru;">SRU</ulink>.
  82    To clients, it acts as a server of these protocols: it can be searched,
  83    records can be retrieved from it, etc.
  84    To servers, it acts as a client: it searches in them,
  85    retrieves records from them, etc.  it satisfies its clients'
  86    requests by transforming them, multiplexing them, forwarding them
  87    on to zero or more servers, merging the results, transforming
  88    them, and delivering them back to the client.  In addition, it
  89    acts as a simple <ulink url="&url.http;">HTTP</ulink> server; support
  90    for further protocols can be added in a modular fashion, through the
  91    creation of new filters.
  92   </para>
  93   <screen>
  94    Anything goes in!
  95    Anything goes out!
  96    Fish, bananas, cold pyjamas,
  97    Mutton, beef and trout!
  98         - attributed to Cole Porter.
  99   </screen>
 100   <para>
 101    Metaproxy is a more capable alternative to
 102    <ulink url="&url.yazproxy;">YAZ Proxy</ulink>,
 103    being more powerful, flexible, configurable and extensible.  Among
 104    its many advantages over the older, more pedestrian work are
 105    support for multiplexing (encapsulated metasearching), routing by
 106    database name, authentication and authorization and serving local
 107    files via HTTP.  Equally significant, its modular architecture
 108    facilitites the creation of pluggable modules implementing further
 109    functionality.
 110   </para>
 111   <para>
 112    This manual will describe how to install Metaproxy
 113    before giving an overview of its architecture, then discussing the
 114    key concept of a filter in some depth and giving an overview of
 115    the various filter types, then discussing the configuration file
 116    format.  After this come several optional chapters which may be
 117    freely skipped: a detailed discussion of virtual databases and
 118    multi-database searching, some notes on writing extensions
 119    (additional filter types) and a high-level description of the
 120    source code.  Finally comes the reference guide, which contains
 121    instructions for invoking the <command>metaproxy</command>
 122    program, and detailed information on each type of filter,
 123    including examples.
 124   </para>
 125  </chapter>
 126
 127  <chapter id="installation">
 128   <title>Installation</title>
 129   <para>
 130    Metaproxy depends on the following tools/libraries:
 131    <variablelist>
 132     <varlistentry><term><ulink url="&url.yazplusplus;">YAZ++</ulink></term>
 133      <listitem>
 134       <para>
 135        This is a C++ library based on <ulink url="&url.yaz;">YAZ</ulink>.
 136       </para>
 137      </listitem>
 138     </varlistentry>
 139     <varlistentry><term><ulink url="&url.libxslt;">Libxslt</ulink></term>
 140      <listitem>
 141       <para>This is an XSLT processor - based on
 142        <ulink url="&url.libxml2;">Libxml2</ulink>. Both Libxml2 and
 143        Libxslt must be installed with the development components
 144        (header files, etc.) as well as the run-time libraries.
 145       </para>
 146      </listitem>
 147     </varlistentry>
 148     <varlistentry><term><ulink url="&url.boost;">Boost</ulink></term>
 149      <listitem>
 150       <para>
 151        The popular C++ library. Initial versions of Metaproxy
 152        was built with 1.32 but this is no longer supported.
 153        Metaproxy is known to work with Boost version 1.33 through 1.55.
 154       </para>
 155      </listitem>
 156     </varlistentry>
 157    </variablelist>
 158   </para>
 159   <para>
 160    In order to compile Metaproxy a modern C++ compiler is
 161    required. Boost, in particular, requires the C++ compiler
 162    to facilitate the newest features. Refer to Boost
 163    <ulink url="&url.boost.compilers.status;">Compiler Status</ulink>
 164    for more information.
 165   </para>
 166   <para>
 167    We have successfully built Metaproxy using the compilers
 168    <ulink url="&url.gcc;">GCC</ulink> and
 169    <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink>.
 170   </para>
 171
 172   <para>
 173    As an option, Metaproxy may also be compiled with
 174    <ulink url="&url.usemarcon;">USEMARCON</ulink> support which allows for
 175    MARC conversions for the <xref linkend="ref-record_transform"/> filter.
 176   </para>
 177   <section id="installation.unix">
 178    <title>Installation on Unix (from Source)</title>
 179    <para>
 180     Here is a quick step-by-step guide on how to compile all the
 181     tools that Metaproxy uses. Only few systems have none of the required
 182     tools binary packages. If, for example, Libxml2/libxslt are already
 183     installed as development packages use those (and omit compilation).
 184    </para>
 185
 186    <note>
 187     <para>
 188      <ulink url="&url.usemarcon;">USEMARCON</ulink> is not available
 189      as a package at the moment, so Metaproxy must be built from source
 190      if that is to be used.
 191     </para>
 192    </note>
 193
 194    <section id="libxml2.fromsource">
 195     <title>Libxml2/libxslt</title>
 196     <para>
 197      Libxml2/libxslt:
 198     </para>
 199     <screen>
 200      gunzip -c libxml2-version.tar.gz|tar xf -
 201      cd libxml2-version
 202      ./configure
 203      make
 204      su
 205      make install
 206     </screen>
 207     <screen>
 208      gunzip -c libxslt-version.tar.gz|tar xf -
 209      cd libxslt-version
 210      ./configure
 211      make
 212      su
 213      make install
 214     </screen>
 215    </section>
 216    <section id="usemarcon">
 217     <title>USEMARCON (optional)</title>
 218     <screen>
 219      gunzip -c usemarcon317.tar.gz|tar xf -
 220      cd usemarcon317
 221      ./configure
 222      make
 223      su
 224      make install
 225     </screen>
 226    </section>
 227
 228    <section id="yaz.fromsource">
 229     <title>YAZ/YAZ++</title>
 230     <screen>
 231      gunzip -c yaz-version.tar.gz|tar xf -
 232      cd yaz-version
 233      ./configure
 234      make
 235      su
 236      make install
 237     </screen>
 238     <screen>
 239      gunzip -c yazpp-version.tar.gz|tar xf -
 240      cd yazpp-version
 241      ./configure
 242      make
 243      su
 244      make install
 245     </screen>
 246    </section>
 247    <section>
 248     <title id="boost.fromsource">Boost</title>
 249     <para>
 250      Metaproxy needs components thread and test from
 251      Boost.
 252     </para>
 253     <screen>
 254      gunzip -c boost-version.tar.gz|tar xf -
 255      cd boost-version
 256      ./configure --with-libraries=thread,test,regex --with-toolset=gcc
 257      make
 258      su
 259      make install
 260     </screen>
 261     <para>
 262      However, under the hood bjam is used. You can invoke that with
 263     </para>
 264     <screen>
 265      ./bjam --toolset=gcc --with-thread --with-test --with-regex stage
 266     </screen>
 267     <para>
 268      Replace <literal>stage</literal> with <literal>clean</literal> /
 269      <literal>install</literal> to perform clean and install respectively.
 270     </para>
 271     <para>
 272      Add <literal>--prefix=DIR</literal> to install Boost in other
 273      prefix than <literal>/usr/local</literal>.
 274     </para>
 275    </section>
 276    <section id="metaproxy.fromsource">
 277     <title>Metaproxy</title>
 278     <screen>
 279      gunzip -c metaproxy-version.tar.gz|tar xf -
 280      cd metaproxy-version
 281      ./configure
 282      make
 283      su
 284      make install
 285     </screen>
 286     <para>
 287      You may have to tell configure where Boost is installed by supplying
 288      options <literal>--with-boost</literal> and <literal>--with-boost-toolset</literal>.
 289      The former sets the PREFIX for Boost (same as --prefix for Boost above).
 290      The latter the compiler toolset (eg. gcc34).
 291     </para>
 292     <para>
 293      Pass <literal>--help</literal> to configure to get a list of
 294      available options.
 295     </para>
 296    </section>
 297   </section>
 298
 299   <section id="installation.debian">
 300    <title>Installation on Debian GNU/Linux</title>
 301    <para>
 302     All dependencies for Metaproxy are available as
 303     <ulink url="&url.debian;">Debian</ulink> packages.
 304    </para>
 305    <para>
 306     The procedures for Debian based systems, such as
 307     <ulink url="&url.ubuntu;">Ubuntu</ulink> is probably similar
 308    </para>
 309    <para>
 310     There is currently no official Debian package for YAZ++.
 311     And the official Debian package for YAZ is probably too old.
 312     But Index Data builds "new" versions of those for Debian (i386, amd64 only).
 313    </para>
 314    <para>
 315     Update the <filename>/etc/apt/sources.list</filename>
 316     to include the Index Data repository.
 317     See YAZ' <ulink url="&url.yaz.download.debian;">Download Debian</ulink>
 318     for more information.
 319    </para>
 320    <screen>
 321     apt-get install libxslt1-dev
 322     apt-get install libyazpp6-dev
 323     apt-get install libboost-dev
 324     apt-get install libboost-system-dev
 325     apt-get install libboost-thread-dev
 326     apt-get install libboost-test-dev
 327     apt-get install libboost-regex-dev
 328    </screen>
 329    <para>
 330     With these packages installed, the usual configure + make
 331     procedure can be used for Metaproxy as outlined in
 332     <xref linkend="installation.unix"/>.
 333    </para>
 334   </section>
 335
 336   <section id="installation.rpm">
 337    <title>Installation on RPM based Linux Systems</title>
 338    <para>
 339     All external dependencies for Metaproxy are available as
 340     RPM packages, either from your distribution site, or from the
 341     <ulink url="http://fr.rpmfind.net/">RPMfind</ulink> site.
 342    </para>
 343    <para>
 344     For example, an installation of the requires Boost C++ development
 345     libraries on RedHat Fedora C4 and C5 can be done like this:
 346     <screen>
 347     wget ftp://fr.rpmfind.net/wlinux/fedora/core/updates/testing/4/SRPMS/boost-1.33.0-3.fc4.src.rpm
 348     sudo rpmbuild --buildroot src/ --rebuild -p fc4/boost-1.33.0-3.fc4.src.rpm
 349     sudo rpm -U /usr/src/redhat/RPMS/i386/boost-*rpm
 350     </screen>
 351    </para>
 352    <para>
 353     The  <ulink url="&url.yaz;">YAZ</ulink> library is needed to
 354     compile &metaproxy;, see there
 355     for more information on available RPM packages.
 356    </para>
 357    <para>
 358     There is currently no official RPM package for YAZ++.
 359     See the <ulink url="&url.yazplusplus;">YAZ++</ulink> pages
 360     for more information on a Unix tarball install.
 361    </para>
 362    <para>
 363     With these packages installed, the usual configure + make
 364     procedure can be used for Metaproxy as outlined in
 365     <xref linkend="installation.unix"/>.
 366    </para>
 367   </section>
 368
 369   <section id="installation.windows">
 370    <title>Installation on Windows</title>
 371    <para>
 372     Metaproxy can be compiled with Microsoft
 373     <ulink url="&url.vstudio;">Visual Studio</ulink>.
 374     Versions 2003 (C 7.1), 2005 (C 8.0), 2008 (C 9.0) and 2013 (C 12.0)
 375     are known to work.
 376    </para>
 377    <section id="installation.windows.boost">
 378     <title>Boost</title>
 379     <para>
 380      For Windows, it's easiest to get the precompiled Boost
 381      package from <ulink url="&url.boost.windows.download;">here</ulink>.
 382      Several versions of the Boost libraries may be selected when
 383      installing Boost for windows. Please choose at least the
 384      <emphasis>multithreaded</emphasis> (non-DLL) version because
 385      the Metaproxy makefile uses that.
 386     </para>
 387     <para>
 388      For more information about installing Boost refer to the
 389      <ulink url="&url.boost.getting.started;">getting started</ulink>
 390      pages.
 391     </para>
 392    </section>
 393
 394    <section id="installation.windows.libxslt">
 395     <title>Libxslt</title>
 396     <para>
 397      <ulink url="&url.libxslt;">Libxslt</ulink> can be downloaded
 398      for Windows from
 399      <ulink url="&url.libxml2.download.windows;">here</ulink>.
 400     </para>
 401     <para>
 402      Libxslt also requires libxml2 to operate.
 403     </para>
 404    </section>
 405
 406    <section id="installation.windows.yaz">
 407     <title>YAZ</title>
 408     <para>
 409      <ulink url="&url.yaz;">YAZ</ulink> can be downloaded
 410      for Windows from
 411      <ulink url="&url.yaz.download.win32;">here</ulink>.
 412     </para>
 413    </section>
 414
 415    <section id="installation.windows.yazplusplus">
 416     <title>YAZ++</title>
 417     <para>
 418      Get <ulink url="&url.yazplusplus;">YAZ++</ulink> as well.
 419      Version 1.5.2 or later is required.
 420     </para>
 421     <para>
 422      YAZ++ includes NMAKE makefiles, similar to those found in the
 423      YAZ package.
 424     </para>
 425    </section>
 426
 427    <section id="installation.windows.metaproxy">
 428     <title>Metaproxy</title>
 429     <para>
 430      Metaproxy is shipped with NMAKE makefiles as well - similar
 431      to those found in the YAZ++/YAZ packages. Adjust this Makefile
 432      to point to the proper locations of Boost, Libxslt, Libxml2,
 433      zlib, iconv, yaz and yazpp.
 434     </para>
 435
 436     <variablelist>
 437      <varlistentry><term><literal>DEBUG</literal></term>
 438       <listitem><para>
 439         If set to 1, the software is
 440         compiled with debugging libraries (code generation is
 441         multi-threaded debug DLL).
 442         If set to 0, the software is compiled with release libraries
 443         (code generation is multi-threaded DLL).
 444        </para></listitem>
 445      </varlistentry>
 446
 447      <varlistentry>
 448       <term><literal>BOOST</literal></term>
 449       <listitem>
 450        <para>
 451         Boost install location
 452        </para>
 453       </listitem>
 454      </varlistentry>
 455
 456      <varlistentry>
 457       <term><literal>BOOST_VERSION</literal></term>
 458       <listitem>
 459        <para>
 460         Boost version (replace . with _).
 461        </para>
 462       </listitem>
 463      </varlistentry>
 464
 465      <varlistentry>
 466       <term><literal>BOOST_TOOLSET</literal></term>
 467       <listitem>
 468        <para>
 469         Boost toolset.
 470        </para>
 471       </listitem>
 472      </varlistentry>
 473
 474      <varlistentry>
 475       <term><literal>LIBXSLT_DIR</literal>,
 476        <literal>LIBXML2_DIR</literal> ..</term>
 477       <listitem>
 478        <para>
 479         Specify the locations of Libxslt, libiconv, libxml2 and
 480         libxslt.
 481        </para>
 482       </listitem>
 483      </varlistentry>
 484
 485     </variablelist>
 486
 487     <para>
 488      After successful compilation you'll find
 489      <literal>metaproxy.exe</literal> in the
 490      <literal>bin</literal> directory.
 491     </para>
 492    </section>
 493
 494
 495   </section>
 496  </chapter>
 497
 498 <chapter id="yazproxy-comparison">
 499  <title>YAZ Proxy Comparison</title>
 500  <para>
 501   The table below lists facilities either supported by either
 502    <ulink url="&url.yazproxy;">YAZ Proxy</ulink> or Metaproxy.
 503  </para>
 504 <table id="yazproxy-comparison-table">
 505  <title>Metaproxy / YAZ Proxy comparison</title>
 506  <tgroup cols="3">
 507   <thead>
 508    <row>
 509     <entry>Facility</entry>
 510     <entry>Metaproxy</entry>
 511     <entry>YAZ Proxy</entry>
 512    </row>
 513   </thead>
 514   <tbody>
 515    <row>
 516     <entry>Z39.50 server</entry>
 517     <entry>Using filter <xref linkend="ref-frontend_net"/></entry>
 518     <entry>Supported</entry>
 519    </row>
 520    <row>
 521     <entry>SRU server</entry>
 522     <entry>Supported with filter <xref linkend="ref-sru_z3950"/></entry>
 523     <entry>Supported</entry>
 524    </row>
 525    <row>
 526     <entry>Z39.50 client</entry>
 527     <entry>Supported with filter <xref linkend="ref-z3950_client"/></entry>
 528     <entry>Supported</entry>
 529    </row>
 530    <row>
 531     <entry>SRU client</entry>
 532     <entry>Supported with filter <xref linkend="ref-zoom"/></entry>
 533     <entry>Unsupported</entry>
 534    </row>
 535    <row>
 536     <entry>Connection reuse</entry>
 537     <entry>Supported with filter <literal>session_shared</literal></entry>
 538     <entry>Supported</entry>
 539    </row>
 540    <row>
 541     <entry>Connection share</entry>
 542     <entry>Supported with filter <literal>session_shared</literal></entry>
 543     <entry>Unsupported</entry>
 544    </row>
 545    <row>
 546     <entry>Result set reuse</entry>
 547     <entry>Supported with filter <literal>session_shared</literal></entry>
 548     <entry>Within one Z39.50 session / HTTP keep-alive</entry>
 549    </row>
 550    <row>
 551     <entry>Record cache</entry>
 552     <entry>Supported by filter <literal>session_shared</literal></entry>
 553     <entry>Supported for last result set within one Z39.50/HTTP-keep alive session</entry>
 554    </row>
 555    <row>
 556     <entry>Z39.50 Virtual database, i.e. select any Z39.50 target for database</entry>
 557     <entry>Supported with filter <literal>virt_db</literal></entry>
 558     <entry>Unsupported</entry>
 559    </row>
 560    <row>
 561     <entry>SRU Virtual database, i.e. select any Z39.50 target for path</entry>
 562     <entry>Supported with filter <literal>virt_db</literal>,
 563      <literal>sru_z3950</literal></entry>
 564     <entry>Supported</entry>
 565    </row>
 566    <row>
 567     <entry>Multi target search</entry>
 568     <entry>Supported with filter <literal>multi</literal> (round-robin)</entry>
 569     <entry>Unsupported</entry>
 570    </row>
 571    <row>
 572     <entry>Retrieval and search limits</entry>
 573     <entry>Supported using filter <literal>limit</literal></entry>
 574     <entry>Supported</entry>
 575    </row>
 576    <row>
 577     <entry>Bandwidth limits</entry>
 578     <entry>Supported using filter <literal>limit</literal></entry>
 579     <entry>Supported</entry>
 580    </row>
 581    <row>
 582     <entry>Connect limits</entry>
 583     <entry>Supported by filter <literal>frontend_net</literal> (connect-max)</entry>
 584     <entry>Supported</entry>
 585    </row>
 586    <row>
 587     <entry>Retrieval sanity check and conversions</entry>
 588     <entry>Supported using filter <literal>record_transform</literal></entry>
 589     <entry>Supported</entry>
 590    </row>
 591    <row>
 592     <entry>Query check</entry>
 593     <entry>
 594       Supported by <literal>query_rewrite</literal> which may be check
 595       a query and throw diagnostics (errors)
 596     </entry>
 597     <entry>Supported</entry>
 598    </row>
 599    <row>
 600     <entry>Query rewrite</entry>
 601     <entry>Supported with <literal>query_rewrite</literal></entry>
 602     <entry>Unsupported</entry>
 603    </row>
 604    <row>
 605     <entry>Session invalidate for -1 hits</entry>
 606     <entry>Unsupported</entry>
 607     <entry>Supported</entry>
 608    </row>
 609    <row>
 610     <entry>Architecture</entry>
 611     <entry>Multi-threaded + select for networked modules such as
 612       <literal>frontend_net</literal>)</entry>
 613     <entry>Single-threaded using select</entry>
 614    </row>
 615
 616    <row>
 617     <entry>Extensability</entry>
 618     <entry>Most functionality implemented as loadable modules</entry>
 619     <entry>Unsupported and experimental</entry>
 620    </row>
 621
 622    <row>
 623     <entry><ulink url="&url.usemarcon;">USEMARCON</ulink></entry>
 624     <entry>Supported with <literal>record_transform</literal></entry>
 625     <entry>Supported</entry>
 626    </row>
 627
 628    <row>
 629     <entry>Portability</entry>
 630     <entry>
 631      Requires YAZ, YAZ++ and modern C++ compiler supporting
 632      <ulink url="&url.boost;">Boost</ulink>.
 633     </entry>
 634     <entry>
 635      Requires YAZ and YAZ++.
 636      STL is not required so pretty much any C++ compiler out there should work.
 637     </entry>
 638    </row>
 639
 640   </tbody>
 641  </tgroup>
 642 </table>
 643 </chapter>
 644
 645  <chapter id="architecture">
 646   <title>The Metaproxy Architecture</title>
 647   <para>
 648    The Metaproxy architecture is based on three concepts:
 649    the <emphasis>package</emphasis>,
 650    the <emphasis>route</emphasis>
 651    and the <emphasis>filter</emphasis>.
 652   </para>
 653   <variablelist>
 654    <varlistentry>
 655     <term>Packages</term>
 656     <listitem>
 657      <para>
 658       A package is request or response, encoded in some protocol,
 659       issued by a client, making its way through Metaproxy, send to or
 660       received from a server, or sent back to the client.
 661      </para>
 662      <para>
 663       The core of a package is the protocol unit - for example, a
 664       Z39.50 Init Request or Search Response, or an SRU searchRetrieve
 665       URL or Explain Response.  In addition to this core, a package
 666       also carries some extra information added and used by Metaproxy
 667       itself.
 668      </para>
 669      <para>
 670       In general, packages are doctored as they pass through
 671       Metaproxy.  For example, when the proxy performs authentication
 672       and authorization on a Z39.50 Init request, it removes the
 673       authentication credentials from the package so that they are not
 674       passed onto the back-end server; and when search-response
 675       packages are obtained from multiple servers, they are merged
 676       into a single unified package that makes its way back to the
 677       client.
 678      </para>
 679     </listitem>
 680    </varlistentry>
 681    <varlistentry>
 682     <term>Routes</term>
 683     <listitem>
 684      <para>
 685       Packages make their way through routes, which can be thought of
 686       as programs that operate on the package data-type.  Each
 687       incoming package initially makes its way through a default
 688       route, but may be switched to a different route based on various
 689       considerations.  Routes are made up of sequences of filters (see
 690       below).
 691      </para>
 692     </listitem>
 693    </varlistentry>
 694    <varlistentry>
 695     <term>Filters</term>
 696     <listitem>
 697      <para>
 698       Filters provide the individual instructions within a route, and
 699       effect the necessary transformations on packages.  A particular
 700       configuration of Metaproxy is essentially a set of filters,
 701       described by configuration details and arranged in order in one
 702       or more routes.  There are many kinds of filter - about a dozen
 703       at the time of writing with more appearing all the time - each
 704       performing a specific function and configured by different
 705       information.
 706      </para>
 707      <para>
 708       The word ``filter'' is sometimes used rather loosely, in two
 709       different ways: it may be used to mean a particular
 710       <emphasis>type</emphasis> of filter, as when we speak of ``the
 711       auth_simple filter'' or ``the multi filter''; or it may be used
 712       to be a specific <emphasis>instance</emphasis> of a filter
 713       within a Metaproxy configuration.  For example, a single
 714       configuration will often contain multiple instances of the
 715       <literal>z3950_client</literal> filter.  In
 716       operational terms, of these is a separate filter.  In practice,
 717       context always make it clear which sense of the word ``filter''
 718       is being used.
 719      </para>
 720      <para>
 721       Extensibility of Metaproxy is primarily through the creation of
 722       plugins that provide new filters.  The filter API is small and
 723       conceptually simple, but there are many details to master.  See
 724       the section below on
 725       <link linkend="filters">Filters</link>.
 726      </para>
 727     </listitem>
 728    </varlistentry>
 729   </variablelist>
 730   <para>
 731    Since packages are created and handled by the system itself, and
 732    routes are conceptually simple, most of the remainder of this
 733    document concentrates on filters.  After a brief overview of the
 734    filter types follows, along with some thoughts on possible future
 735    directions.
 736   </para>
 737  </chapter>
 738
 739
 740
 741  <chapter id="filters">
 742   <title>Filters</title>
 743
 744
 745   <section id="filters-introductory-notes">
 746    <title>Introductory notes</title>
 747    <para>
 748     It's useful to think of Metaproxy as an interpreter providing a small
 749     number of primitives and operations, but operating on a very
 750     complex data type, namely the ``package''.
 751    </para>
 752    <para>
 753     A package represents a Z39.50 or SRU/W request (whether for Init,
 754     Search, Scan, etc.)  together with information about where it came
 755     from.  Packages are created by front-end filters such as
 756     <literal>frontend_net</literal> (see below), which reads them from
 757     the network; other front-end filters are possible.  They then pass
 758     along a route consisting of a sequence of filters, each of which
 759     transforms the package and may also have side-effects such as
 760     generating logging.  Eventually, the route will yield a response,
 761     which is sent back to the origin.
 762    </para>
 763    <para>
 764     There are many kinds of filter: some that are defined statically
 765     as part of Metaproxy, and others may be provided by third parties
 766     and dynamically loaded.  They all conform to the same simple API
 767     of essentially two methods: <function>configure()</function> is
 768     called at startup time, and is passed an XML DOM tree representing that
 769     part of the configuration file that pertains to this filter
 770     instance: it is expected to walk that tree extracting relevant
 771     information; and <function>process()</function> is called every
 772     time the filter has to processes a package.
 773    </para>
 774    <para>
 775     While all filters provide the same API, there are different modes
 776     of functionality.  Some filters are sources: they create
 777     packages
 778     (<literal>frontend_net</literal>);
 779     others are sinks: they consume packages and return a result
 780     (<literal>backend_test</literal>,
 781     <literal>bounce</literal>,
 782     <literal>http_file</literal>,
 783     <literal>z3950_client</literal>);
 784     the others are true filters, that read, process and pass on the
 785     packages they are fed
 786     (<literal>auth_simple</literal>,
 787     <literal>log</literal>,
 788     <literal>multi</literal>,
 789     <literal>query_rewrite</literal>,
 790     <literal>record_transform</literal>,
 791     <literal>session_shared</literal>,
 792     <literal>sru_z3950</literal>,
 793     <literal>template</literal>,
 794     <literal>virt_db</literal>).
 795    </para>
 796  </section>
 797
 798
 799   <section id="overview.filter.types">
 800    <title>Overview of filter types</title>
 801    <para>
 802     We now briefly consider each of the types of filter supported by
 803     the core Metaproxy binary.  This overview is intended to give a
 804     flavor of the available functionality; more detailed information
 805     about each type of filter is included below in
 806     <xref linkend="reference"/>.
 807    </para>
 808    <para>
 809     The filters are here named by the string that is used as the
 810     <literal>type</literal> attribute of a
 811     <literal>&lt;filter&gt;</literal> element in the configuration
 812     file to request them, with the name of the class that implements
 813     them in parentheses.  (The classname is not needed for normal
 814     configuration and use of Metaproxy; it is useful only to
 815     developers.)
 816    </para>
 817    <para>
 818     The filters are here listed in alphabetical order:
 819    </para>
 820
 821 <!--
 822
 823 ### New filters:
 824
 825 New virt_db-alike that does inteligent peer choice, explain merging,
 826 adds FD&N to explain.  Keeps init responses (like "virt_db Classic"),
 827 makes routing choices based on local explain knowledge.  Ref IDDI
 828 paper.
 829
 830 Filter to convert Explain Classic to ZeeRex.
 831
 832 CQL2PQF (which needs augmented ZeeRex) - MARC for Talis.
 833
 834 SRU2Z39.50 (ditto).
 835
 836 Figure out what additional information we need in:
 837         ZeeRex (check against D3.1)
 838         Init request (e.g. loop detection)
 839         Query package (e.g. number of hops)
 840         Query response (e.g. record source)
 841
 842 -->
 843
 844    <section id="auth_simple">
 845     <title><literal>auth_simple</literal>
 846      (mp::filter::AuthSimple)</title>
 847     <para>
 848      Simple authentication and authorization.  The configuration
 849      specifies the name of a file that is the user register, which
 850      lists <varname>username</varname>:<varname>password</varname>
 851      pairs, one per line, colon separated. When a session begins, it
 852      is rejected unless username and passsword are supplied, and match
 853      a pair in the register.  The configuration file may also specific
 854      the name of another file that is the target register: this lists
 855      lists <varname>username</varname>:<varname>dbname</varname>,<varname>dbname</varname>...
 856      sets, one per line, with multiple database names separated by
 857      commas.  When a search is processed, it is rejected unless the
 858      database to be searched is one of those listed as available to
 859      the user.
 860     </para>
 861    </section>
 862
 863    <section id="backend_test">
 864     <title><literal>backend_test</literal>
 865     (mp::filter::Backend_test)</title>
 866     <para>
 867      A partial sink that provides dummy responses in the manner of the
 868      <literal>yaz-ztest</literal> Z39.50 server.  This is useful only
 869      for testing.  Seriously, you don't need this.  Pretend you didn't
 870      even read this section.
 871     </para>
 872    </section>
 873
 874    <section id="bounce">
 875     <title><literal>bounce</literal>
 876     (mp::filter::Bounce)</title>
 877     <para>
 878      A sink that swallows <emphasis>all packages</emphasis>,
 879      and returns them almost unprocessed.
 880      It never sends any package of any type further down the row, but
 881      sets Z39.50 packages to Z_Close, and HTTP_Request packages to
 882      HTTP_Response err code 400 packages, and adds a suitable bounce
 883      message.
 884      The bounce filter is usually added at end of each filter chain route
 885      to prevent infinite hanging of for example HTTP
 886      requests packages when only the Z39.50 client partial sink
 887      filter is found in the
 888      route.
 889     </para>
 890    </section>
 891
 892    <section id="cql_rpn">
 893     <title><literal>cql_rpn</literal>
 894     (mp::filter::CQLtoRPN)</title>
 895     <para>
 896      A query language transforming filter which catches Z39.50
 897      <literal>searchRequest</literal>
 898      packages containing <literal>CQL</literal> queries, transforms
 899      those to <literal>RPN</literal> queries,
 900      and sends the <literal>searchRequests</literal> on to the next
 901      filters. It is among other things useful in a SRU context.
 902     </para>
 903    </section>
 904
 905    <section id="frontend_net">
 906     <title><literal>frontend_net</literal>
 907      (mp::filter::FrontendNet)</title>
 908     <para>
 909      A source that accepts Z39.50 connections from a port
 910      specified in the configuration, reads protocol units, and
 911      feeds them into the next filter in the route.  When the result is
 912      received, it is returned to the original origin.
 913     </para>
 914    </section>
 915
 916    <section id="http_file">
 917     <title><literal>http_file</literal>
 918      (mp::filter::HttpFile)</title>
 919     <para>
 920      A partial sink which swallows only
 921      <literal>HTTP_Request</literal> packages, and
 922      returns the contents of files from the local
 923      filesystem in response to HTTP requests.
 924      It lets Z39.50 packages and all other forthcoming package types
 925      pass untouched.
 926      (Yes, Virginia, this
 927      does mean that Metaproxy is also a Web-server in its spare time.  So
 928      far it does not contain either an email-reader or a Lisp
 929      interpreter, but that day is surely coming.)
 930     </para>
 931    </section>
 932
 933    <section id="load_balance">
 934     <title><literal>load_balance</literal>
 935      (mp::filter::LoadBalance)</title>
 936     <para>
 937      Performs load balancing for incoming Z39.50 init requests.
 938      It is used together with the <literal>virt_db</literal> filter,
 939      but unlike the <literal>multi</literal> filter it does send an
 940      entire session to only one of the virtual backends. The
 941      <literal>load_balance</literal> filter is assuming that
 942      all backend targets have equal content, and chooses the backend
 943      with least load cost for a new session.
 944     <warning>
 945      <para>
 946       This filter is experimental and yet not mature for heavy load
 947       production sites.
 948      </para>
 949     </warning>
 950    </para>
 951    </section>
 952
 953    <section id="log">
 954     <title><literal>log</literal>
 955      (mp::filter::Log)</title>
 956     <para>
 957      Writes logging information to standard output, and passes on
 958      the package unchanged. A log file name can be specified, as well
 959      as multiple different logging formats.
 960    </para>
 961    </section>
 962
 963    <section id="multi">
 964    <title><literal>multi</literal>
 965      (mp::filter::Multi)</title>
 966     <para>
 967      Performs multi-database searching.
 968      See
 969      <link linkend="multidb">the extended discussion</link>
 970      of virtual databases and multi-database searching below.
 971     </para>
 972    </section>
 973
 974    <section id="query_rewrite">
 975    <title><literal>query_rewrite</literal>
 976      (mp::filter::QueryRewrite)</title>
 977     <para>
 978      Rewrites Z39.50 <literal>Type-1</literal>
 979      and <literal>Type-101</literal> (``<literal>RPN</literal>'')
 980      queries by a
 981      three-step process: the query is transliterated from Z39.50
 982      packet structures into an XML representation; that XML
 983      representation is transformed by an XSLT stylesheet; and the
 984      resulting XML is transliterated back into the Z39.50 packet
 985      structure.
 986     </para>
 987    </section>
 988
 989
 990    <section id="record_transform">
 991     <title><literal>record_transform</literal>
 992     (mp::filter::RecordTransform)</title>
 993     <para>
 994      This filter acts only on Z3950 present requests, and let all
 995      other types of packages and requests pass untouched. It's use is
 996      twofold: blocking Z3950  present requests, which the backend
 997      server does not understand and can not honor, and transforming
 998      the present syntax and elementset name according to the rules
 999      specified, to fetch only existing record formats, and transform
1000      them on the fly to requested record syntaxes.
1001     </para>
1002    </section>
1003
1004    <section id="session_shared">
1005     <title><literal>session_shared</literal>
1006      (mp::filter::SessionShared)</title>
1007     <para>
1008      This filter implements global sharing of
1009      result sets (i.e. between threads and therefore between
1010      clients), yielding performance improvements by clever resource
1011      pooling.
1012     </para>
1013    </section>
1014
1015    <section id="sru_z3950">
1016     <title><literal>sru_z3950</literal>
1017     (mp::filter::SRUtoZ3950)</title>
1018     <para>
1019      This filter transforms valid
1020      SRU GET/POST/SOAP searchRetrieve requests to Z3950 init, search,
1021      and present requests, and wraps the
1022      received hit counts and XML records into suitable SRU response
1023      messages.
1024      The <literal>sru_z3950</literal> filter  processes also  SRU
1025      GET/POST/SOAP explain requests, returning
1026      either the absolute minimum required by the standard, or a  full
1027      pre-defined ZeeReX explain record.
1028      See the
1029      <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
1030      standard pages and the
1031      <ulink url="&url.sru.explain;">SRU Explain</ulink> pages
1032      for more information on the correct explain syntax.
1033      SRU scan requests are not supported yet.
1034     </para>
1035    </section>
1036
1037    <section id="template">
1038     <title><literal>template</literal>
1039      (mp::filter::Template)</title>
1040     <para>
1041      Does nothing at all, merely passing the packet on.  (Maybe it
1042      should be called <literal>nop</literal> or
1043      <literal>passthrough</literal>?)  This exists not to be used, but
1044      to be copied - to become the skeleton of new filters as they are
1045      written.  As with <literal>backend_test</literal>, this is not
1046      intended for civilians.
1047     </para>
1048    </section>
1049
1050    <section id="virt_db">
1051     <title><literal>virt_db</literal>
1052      (mp::filter::VirtualDB)</title>
1053     <para>
1054      Performs virtual database selection: based on the name of the
1055      database in the search request, a server is selected, and its
1056      address added to the request in a <literal>VAL_PROXY</literal>
1057      otherInfo packet.  It will subsequently be used by a
1058      <literal>z3950_client</literal> filter.
1059      See
1060      <link linkend="multidb">the extended discussion</link>
1061      of virtual databases and multi-database searching below.
1062     </para>
1063    </section>
1064
1065    <section id="z3950_client">
1066     <title><literal>z3950_client</literal>
1067      (mp::filter::Z3950Client)</title>
1068     <para>
1069      A partial sink which swallows only Z39.50 packages.
1070      It performs Z39.50 searching and retrieval by proxying the
1071      packages that are passed to it.  Init requests are sent to the
1072      address specified in the <literal>VAL_PROXY</literal> otherInfo
1073      attached to the request: this may have been specified by client,
1074      or generated by a <literal>virt_db</literal> filter earlier in
1075      the route.  Subsequent requests are sent to the same address,
1076      which is remembered at Init time in a Session object.
1077      HTTP_Request packages and all other forthcoming package types
1078      are passed untouched.
1079     </para>
1080   </section>
1081
1082
1083    <section id="zeerex_explain">
1084     <title><literal>zeerex_explain</literal>
1085      (mp::filter::ZeerexExplain)</title>
1086     <para>
1087      This filter acts as a sink for
1088      Z39.50 explain requests, returning a static ZeeReX
1089      Explain XML record from the config section. All other packages
1090      are passed through.
1091      See the
1092      <ulink url="&url.zeerex.explain;">ZeeReX Explain</ulink>
1093      standard pages
1094      for more information on the correct explain syntax.
1095     </para>
1096     <warning>
1097      <para>
1098       This filter is not yet completed.
1099      </para>
1100     </warning>
1101    </section>
1102
1103
1104   </section>
1105
1106
1107   <section id="future.directions">
1108    <title>Future directions</title>
1109   <para>
1110     Some other filters that do not yet exist, but which would be
1111     useful, are briefly described.  These may be added in future
1112     releases (or may be created by third parties, as loadable
1113     modules).
1114    </para>
1115
1116    <variablelist>
1117     <varlistentry>
1118      <term><literal>frontend_cli</literal> (source)</term>
1119     <listitem>
1120       <para>
1121        Command-line interface for generating requests.
1122       </para>
1123      </listitem>
1124     </varlistentry>
1125     <varlistentry>
1126      <term><literal>sru_client</literal> (sink)</term>
1127      <listitem>
1128       <para>
1129        SRU/GET and SRU/SOAP searching and retrieval.
1130       </para>
1131      </listitem>
1132     </varlistentry>
1133     <varlistentry>
1134      <term><literal>opensearch_client</literal> (sink)</term>
1135      <listitem>
1136       <para>
1137        A9 OpenSearch searching and retrieval.
1138       </para>
1139      </listitem>
1140     </varlistentry>
1141    </variablelist>
1142   </section>
1143  </chapter>
1144
1145
1146
1147  <chapter id="configuration">
1148   <title>Configuration: the Metaproxy configuration file format</title>
1149
1150
1151   <section id="configuration-introductory-notes">
1152    <title>Introductory notes</title>
1153    <para>
1154     If Metaproxy is an interpreter providing operations on packages, then
1155     its configuration file can be thought of as a program for that
1156     interpreter.  Configuration is by means of a single XML file, the name
1157     of which is supplied as the sole command-line argument to the
1158     <command>metaproxy</command> program.  (See
1159     <xref linkend="reference"/> below for more information on invoking
1160     Metaproxy.)
1161    </para>
1162   </section>
1163
1164   <section id="overview.xml.structure">
1165    <title>Overview of the config file XML structure</title>
1166    <para>
1167     All elements and attributes are in the namespace
1168     <ulink url="http://indexdata.com/metaproxy"/>.
1169      This is most easily achieved by setting the default namespace on
1170      the top-level element, as here:
1171    </para>
1172    <screen>
1173     &lt;metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0"&gt;
1174    </screen>
1175    <para>
1176     The top-level element is &lt;metaproxy&gt;.  This contains
1177     a &lt;dlpath&gt; element,
1178     a &lt;start&gt; element,
1179     a &lt;filters&gt; element and
1180     a &lt;routes&gt; element, in that order.  &lt;dlpath&gt; and
1181     &lt;filters&gt; are optional; the other two are mandatory.
1182     All four are non-repeatable.
1183    </para>
1184    <para>
1185      The &lt;dlpath;&gt; element contains a text element which
1186      specifies the location of filter modules. This is only needed
1187      if Metaproxy must load 3rd party filters (most filters with Metaproxy
1188      are built into the Metaproxy application).
1189    </para>
1190   <para>
1191     The &lt;start&gt; element is empty, but carries a
1192     <literal>route</literal> attribute, whose value is the name of
1193     route at which to start running - analogous to the name of the
1194     start production in a formal grammar.
1195    </para>
1196   <para>
1197     If present, &lt;filters&gt; contains zero or more &lt;filter&gt;
1198     elements.  Each filter carries a <literal>type</literal> attribute
1199     which specifies what kind of filter is being defined
1200     (<literal>frontend_net</literal>, <literal>log</literal>, etc.)
1201     and contain various elements that provide suitable configuration
1202     for a filter of its type.  The filter-specific elements are
1203     described in
1204     <xref linkend="reference"/>.
1205     Filters defined in this part of the file must carry an
1206     <literal>id</literal> attribute so that they can be referenced
1207     from elsewhere.
1208    </para>
1209    <para>
1210     &lt;routes&gt; contains one or more &lt;route&gt; elements, each
1211     of which must carry an <literal>id</literal> element.  One of the
1212     routes must have the ID value that was specified as the start
1213     route in the &lt;start&gt; element's <literal>route</literal>
1214     attribute.  Each route contains zero or more &lt;filter&gt;
1215     elements.  These are of two types.  They may be empty, but carry a
1216     <literal>refid</literal> attribute whose value is the same as the
1217     <literal>id</literal> of a filter previously defined in the
1218     &lt;filters&gt; section.  Alternatively, a route within a filter
1219     may omit the <literal>refid</literal> attribute, but contain
1220     configuration elements similar to those used for filters defined
1221     in the &lt;filters&gt; section.  (In other words, each filter in a
1222     route may be included either by reference or by physical
1223     inclusion.)
1224    </para>
1225   </section>
1226
1227
1228   <section id="example.configuration">
1229    <title>An example configuration</title>
1230    <para>
1231     The following is a small, but complete, Metaproxy configuration
1232     file (included in the distribution as
1233     <literal>metaproxy/etc/config1.xml</literal>).
1234     This file defines a very simple configuration that simply proxies
1235     to whatever back-end server the client requests, but logs each
1236     request and response.  This can be useful for debugging complex
1237     client-server dialogues.
1238    </para>
1239    <screen><![CDATA[<?xml version="1.0"?>
1240 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
1241   <dlpath>/usr/lib/metaproxy/modules</dlpath>
1242   <start route="start"/>
1243   <filters>
1244     <filter id="frontend" type="frontend_net">
1245       <port>@:9000</port>
1246     </filter>
1247     <filter id="backend" type="z3950_client">
1248     </filter>
1249   </filters>
1250   <routes>
1251     <route id="start">
1252       <filter refid="frontend"/>
1253       <filter type="log"/>
1254       <filter refid="backend"/>
1255       <filter type="bounce"/>
1256     </route>
1257   </routes>
1258 </metaproxy>
1259 ]]></screen>
1260    <para>
1261     It works by defining a single route, called
1262     <literal>start</literal>, which consists of a sequence of four
1263     filters.  The first and last of these are included by reference:
1264     their <literal>&lt;filter&gt;</literal> elements have
1265     <literal>refid</literal> attributes that refer to filters defined
1266     within the prior <literal>&lt;filters&gt;</literal> section.  The
1267     middle filter is included inline in the route.
1268    </para>
1269    <para>
1270     The four filters in the route are as follows: first, a
1271     <literal>frontend_net</literal> filter accepts Z39.50 requests
1272     from any host on port 9000; then these requests are passed through
1273     a <literal>log</literal> filter that emits a message for each
1274     request; they are then fed into a <literal>z3950_client</literal>
1275     filter, which forwards all Z39.50 requests to the client-specified
1276     back-end Z39.509 server. Those Z39.50 packages are returned by the
1277     <literal>z3950_client</literal> filter, with the response data
1278     filled by the external Z39.50 server targeted.
1279     All non-Z39.50 packages are passed through to the
1280     <literal>bounce</literal> filter, which definitely bounces
1281     everything, including fish, bananas, cold pyjamas,
1282     mutton, beef and trout packages.
1283     When the response arrives, it is handed
1284     back to the <literal>log</literal> filter, which emits another
1285     message; and then to the <literal>frontend_net</literal> filter,
1286     which returns the response to the client.
1287    </para>
1288   </section>
1289
1290   <section id="config-file-modularity">
1291    <title>Config file modularity</title>
1292    <para>
1293     Metaproxy XML configuration snippets can be reused by other
1294     filters using the <literal>XInclude</literal> standard, as seen in
1295     the <literal>/etc/config-sru-to-z3950.xml</literal> example SRU
1296     configuration.
1297    <screen><![CDATA[
1298     <filter id="sru" type="sru_z3950">
1299       <database name="Default">
1300        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
1301                     href="explain.xml"/>
1302       </database>
1303     </filter>
1304 ]]></screen>
1305     </para>
1306   </section>
1307
1308   <section id="config-file-syntax-check">
1309    <title>Config file syntax checking</title>
1310    <para>
1311     The distribution contains RelaxNG Compact and XML syntax checking
1312     files, as well as XML Schema files. These are found in the
1313     distribution paths
1314    <screen>
1315     xml/schema/metaproxy.rnc
1316     xml/schema/metaproxy.rng
1317     xml/schema/metaproxy.xsd
1318    </screen>
1319     and can be used to verify or debug the XML structure of
1320     configuration files. For example, using the utility
1321     <filename>xmllint</filename>, syntax checking is done like this:
1322    <screen>
1323     xmllint --noout --schema xml/schema/metaproxy.xsd etc/config-local.xml
1324     xmllint --noout --relaxng xml/schema/metaproxy.rng etc/config-local.xml
1325    </screen>
1326     (A recent version of <literal>libxml2</literal> is required, as
1327     support for XML Schemas is a relatively recent addition.)
1328    </para>
1329    <para>
1330     You can of course use any other RelaxNG or XML Schema compliant tool
1331     you wish.
1332    </para>
1333    </section>
1334  </chapter>
1335
1336
1337
1338  <chapter id="multidb">
1339   <title>Virtual databases and multi-database searching</title>
1340
1341
1342   <section id="multidb-introductory-notes">
1343    <title>Introductory notes</title>
1344    <para>
1345     Two of Metaproxy's filters are concerned with multiple-database
1346     operations.  Of these, <literal>virt_db</literal> can work alone
1347     to control the routing of searches to one of a number of servers,
1348     while <literal>multi</literal> can work together with
1349     <literal>virt_db</literal> to perform multi-database searching, merging
1350     the results into a unified result-set - ``metasearch in a box''.
1351    </para>
1352    <para>
1353     The interaction between
1354     these two filters is necessarily complex: it reflects the real,
1355     irreducible complexity of multi-database searching in a protocol such
1356     as Z39.50 that separates initialization from searching, and in
1357     which the database to be searched is not known at initialization
1358     time.
1359    </para>
1360    <para>
1361     It's possible to use these filters without understanding the
1362     details of their functioning and the interaction between them; the
1363     next two sections of this chapter are ``HOW-TO'' guides for doing
1364     just that.  However, debugging complex configurations will require
1365     a deeper understanding, which the last two sections of this
1366     chapters attempt to provide.
1367    </para>
1368   </section>
1369
1370
1371   <section id="multidb.virt_db">
1372    <title>Virtual databases with the <literal>virt_db</literal> filter</title>
1373    <para>
1374     Working alone, the purpose of the
1375     <literal>virt_db</literal>
1376     filter is to route search requests to one of a selection of
1377     back-end databases.  In this way, a single Z39.50 endpoint
1378     (running Metaproxy) can provide access to several different
1379     underlying services, including those that would otherwise be
1380     inaccessible due to firewalls.  In many useful configurations, the
1381     back-end databases are local to the Metaproxy installation, but
1382     the software does not enforce this, and any valid Z39.50 servers
1383     may be used as back-ends.
1384    </para>
1385    <para>
1386     For example, a <literal>virt_db</literal>
1387     filter could be set up so that searches in the virtual database
1388     ``lc'' are forwarded to the Library of Congress bibliographic
1389     catalogue server, and searches in the virtual database ``marc''
1390     are forwarded to the toy database of MARC records that Index Data
1391     hosts for testing purposes.  A <literal>virt_db</literal>
1392     configuration to make this switch would look like this:
1393    </para>
1394    <screen><![CDATA[<filter type="virt_db">
1395   <virtual>
1396     <database>lc</database>
1397     <target>z3950.loc.gov:7090/voyager</target>
1398   </virtual>
1399   <virtual>
1400     <database>marc</database>
1401     <target>indexdata.com/marc</target>
1402   </virtual>
1403 </filter>]]></screen>
1404    <para>
1405     As well as being useful in it own right, this filter also provides
1406     the foundation for multi-database searching.
1407    </para>
1408   </section>
1409
1410
1411   <section id="multidb.multi">
1412    <title>Multi-database search with the <literal>multi</literal> filter</title>
1413    <para>
1414     To arrange for Metaproxy to broadcast searches to multiple back-end
1415     servers, the configuration needs to include two components: a
1416     <literal>virt_db</literal>
1417     filter that specifies multiple
1418     <literal>&lt;target&gt;</literal>
1419     elements, and a subsequent
1420     <literal>multi</literal>
1421     filter.  Here, for example, is a complete configuration that
1422     broadcasts searches to both the Library of Congress catalogue and
1423     Index Data's tiny testing database of MARC records:
1424    </para>
1425    <screen><![CDATA[<?xml version="1.0"?>
1426 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
1427   <start route="start"/>
1428   <routes>
1429     <route id="start">
1430       <filter type="frontend_net">
1431         <threads>10</threads>
1432         <port>@:9000</port>
1433       </filter>
1434       <filter type="virt_db">
1435         <virtual>
1436           <database>lc</database>
1437           <target>z3950.loc.gov:7090/voyager</target>
1438         </virtual>
1439         <virtual>
1440           <database>marc</database>
1441           <target>indexdata.com/marc</target>
1442         </virtual>
1443         <virtual>
1444           <database>all</database>
1445           <target>z3950.loc.gov:7090/voyager</target>
1446           <target>indexdata.com/marc</target>
1447         </virtual>
1448       </filter>
1449       <filter type="multi"/>
1450       <filter type="z3950_client">
1451         <timeout>30</timeout>
1452       </filter>
1453       <filter type="bounce"/>
1454     </route>
1455   </routes>
1456 </metaproxy>]]></screen>
1457    <para>
1458     (Using a
1459     <literal>virt_db</literal>
1460     filter that specifies multiple
1461     <literal>&lt;target&gt;</literal>
1462     elements but without a subsequent
1463     <literal>multi</literal>
1464     filter yields surprising and undesirable results, as will be
1465     described below.  Don't do that.)
1466    </para>
1467    <para>
1468     Metaproxy can be invoked with this configuration as follows:
1469    </para>
1470    <screen>../src/metaproxy --config config-simple-multi.xml</screen>
1471    <para>
1472     And thereafter, Z39.50 clients can connect to the running server
1473     (on port 9000, as specified in the configuration) and search in
1474     any of the databases
1475     <literal>lc</literal> (the Library of Congress catalogue),
1476     <literal>marc</literal> (Index Data's test database of MARC records)
1477     or
1478     <literal>all</literal> (both of these).  As an example, a session
1479     using the YAZ command-line client <literal>yaz-client</literal> is
1480     here included (edited for brevity and clarity):
1481    </para>
1482    <screen><![CDATA[$ yaz-client @:9000
1483 Connecting...OK.
1484 Z> base lc
1485 Z> find computer
1486 Search was a success.
1487 Number of hits: 10000, setno 1
1488 Elapsed: 5.521070
1489 Z> base marc
1490 Z> find computer
1491 Search was a success.
1492 Number of hits: 10, setno 3
1493 Elapsed: 0.060187
1494 Z> base all
1495 Z> find computer
1496 Search was a success.
1497 Number of hits: 10010, setno 4
1498 Elapsed: 2.237648
1499 Z> show 1
1500 [marc]Record type: USmarc
1501 001    11224466
1502 003 DLC
1503 005 00000000000000.0
1504 008 910710c19910701nju           00010 eng
1505 010    $a 11224466
1506 040    $a DLC $c DLC
1507 050 00 $a 123-xyz
1508 100 10 $a Jack Collins
1509 245 10 $a How to program a computer
1510 260 1  $a Penguin
1511 263    $a 8710
1512 300    $a p. cm.
1513 Elapsed: 0.119612
1514 Z> show 2
1515 [VOYAGER]Record type: USmarc
1516 001 13339105
1517 005 20041229102447.0
1518 008 030910s2004    caua          000 0 eng
1519 035    $a (DLC)  2003112666
1520 906    $a 7 $b cbc $c orignew $d 4 $e epcn $f 20 $g y-gencatlg
1521 925 0  $a acquire $b 1 shelf copy $x policy default
1522 955    $a pc10 2003-09-10 $a pv12 2004-06-23 to SSCD; $h sj05 2004-11-30 $e sj05 2004-11-30 to Shelf.
1523 010    $a   2003112666
1524 020    $a 0761542892
1525 040    $a DLC $c DLC $d DLC
1526 050 00 $a MLCM 2004/03312 (G)
1527 245 10 $a 007, everything or nothing : $b Prima's official strategy guide / $c created by Kaizen Media Group.
1528 246 3  $a Double-O-seven, everything or nothing
1529 246 30 $a Prima's official strategy guide
1530 260    $a Roseville, CA : $b Prima Games, $c c2004.
1531 300    $a 161 p. : $b col. ill. ; $c 28 cm.
1532 500    $a "Platforms: Nintendo GameCube, Macintosh, PC, PlayStation 2 computer entertainment system, Xbox"--P. [4] of cover.
1533 650  0 $a Video games.
1534 710 2  $a Kaizen Media Group.
1535 856 42 $3 Publisher description $u http://www.loc.gov/catdir/description/random052/2003112666.html
1536 Elapsed: 0.150623
1537 Z>
1538 ]]></screen>
1539    <para>
1540     As can be seen, the first record in the result set is from the
1541     Index Data test database, and the second from the Library of
1542     Congress database.  The result-set continues alternating records
1543     round-robin style until the point where one of the databases'
1544     records are exhausted.
1545    </para>
1546    <para>
1547     This example uses only two back-end databases; more may be used.
1548     There is no limitation imposed on the number of databases that may
1549     be metasearched in this way: issues of resource usage and
1550     administrative complexity dictate the practical limits.
1551    </para>
1552    <para>
1553     What happens when one of the databases doesn't respond?  By default,
1554     the entire multi-database search fails, and the appropriate
1555     diagnostic is returned to the client.  This is usually appropriate
1556     during development, when technicians need maximum information, but
1557     can be inconvenient in deployment, when users typically don't want
1558     to be bothered with problems of this kind and prefer just to get
1559     the records from the databases that are available.  To obtain this
1560     latter behavior add an empty
1561     <literal>&lt;hideunavailable&gt;</literal>
1562     element inside the
1563     <literal>multi</literal> filter:
1564    </para>
1565    <screen><![CDATA[      <filter type="multi">
1566         <hideunavailable/>
1567       </filter>]]></screen>
1568    <para>
1569     Under this regime, an error is reported to the client only if
1570     <emphasis>all</emphasis> the databases in a multi-database search
1571     are unavailable.
1572    </para>
1573   </section>
1574
1575
1576   <section id="multidb.what">
1577    <title>What's going on?</title>
1578    <warning>
1579     <title>Lark's vomit</title>
1580     <para>
1581      This section goes into a level of technical detail that is
1582      probably not necessary in order to configure and use Metaproxy.
1583      It is provided only for those who like to know how things work.
1584      You should feel free to skip on to the next section if this one
1585      doesn't seem like fun.
1586     </para>
1587    </warning>
1588    <para>
1589     Hold on tight - this may get a little hairy.
1590    </para>
1591    <para>
1592     In the general course of things, a Z39.50 Init request may carry
1593     with it an otherInfo packet of type <literal>VAL_PROXY</literal>,
1594     whose value indicates the address of a Z39.50 server to which the
1595     ultimate connection is to be made.  (This otherInfo packet is
1596     supported by YAZ-based Z39.50 clients and servers, but has not yet
1597     been ratified by the Maintenance Agency and so is not widely used
1598     in non-Index Data software.  We're working on it.)
1599     The <literal>VAL_PROXY</literal> packet functions
1600     analogously to the absoluteURI-style Request-URI used with the GET
1601     method when a web browser asks a proxy to forward its request: see
1602     the
1603     <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2"
1604            >Request-URI</ulink>
1605     section of
1606     <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616.html"
1607            >the HTTP 1.1 specification</ulink>.
1608    </para>
1609    <para>
1610     Within Metaproxy, Search requests that are part of the same
1611     session as an Init request that carries a
1612     <literal>VAL_PROXY</literal> otherInfo are also annotated with the
1613     same information.  The role of the <literal>virt_db</literal>
1614     filter is to rewrite this otherInfo packet dependent on the
1615     virtual database that the client wants to search.
1616    </para>
1617    <para>
1618     When Metaproxy receives a Z39.50 Init request from a client, it
1619     doesn't immediately forward that request to the back-end server.
1620     Why not?  Because it doesn't know <emphasis>which</emphasis>
1621     back-end server to forward it to until the client sends a Search
1622     request that specifies the database that it wants to search in.
1623     Instead, it just treasures the Init request up in its heart; and,
1624     later, the first time the client does a search on one of the
1625     specified virtual databases, a connection is forged to the
1626     appropriate server and the Init request is forwarded to it.  If,
1627     later in the session, the same client searches in a different
1628     virtual database, then a connection is forged to the server that
1629     hosts it, and the same cached Init request is forwarded there,
1630     too.
1631    </para>
1632    <para>
1633     All of this clever Init-delaying is done by the
1634     <literal>frontend_net</literal> filter.  The
1635     <literal>virt_db</literal> filter knows nothing about it; in
1636     fact, because the Init request that is received from the client
1637     doesn't get forwarded until a Search request is received, the
1638     <literal>virt_db</literal> filter (and the
1639     <literal>z3950_client</literal> filter behind it) doesn't even get
1640     invoked at Init time.  The <emphasis>only</emphasis> thing that a
1641     <literal>virt_db</literal> filter ever does is rewrite the
1642     <literal>VAL_PROXY</literal> otherInfo in the requests that pass
1643     through it.
1644    </para>
1645    <para>
1646     It is possible for a <literal>virt_db</literal> filter to contain
1647     multiple
1648     <literal>&lt;target&gt;</literal>
1649     elements.  What does this mean?  Only that the filter will add
1650     multiple <literal>VAL_PROXY</literal> otherInfo packets to the
1651     Search requests that pass through it.  That's because the virtual
1652     DB filter is dumb, and does exactly what it's told - no more, no
1653     less.
1654     If a Search request with multiple <literal>VAL_PROXY</literal>
1655     otherInfo packets reaches a <literal>z3950_client</literal>
1656     filter, this is an error.  That filter doesn't know how to deal
1657     with multiple targets, so it will either just pick one and search
1658     in it, or (better) fail with an error message.
1659    </para>
1660    <para>
1661     The <literal>multi</literal> filter comes to the rescue!  This is
1662     the only filter that knows how to deal with multiple
1663     <literal>VAL_PROXY</literal> otherInfo packets, and it does so by
1664     making multiple copies of the entire Search request: one for each
1665     <literal>VAL_PROXY</literal>.  Each of these new copies is then
1666     passed down through the remaining filters in the route.  (The
1667     copies are handled in parallel though the
1668     spawning of new threads.)  Since the copies each have only one
1669     <literal>VAL_PROXY</literal> otherInfo, they can be handled by the
1670     <literal>z3950_client</literal> filter, which happily deals with
1671     each one individually.  When the results of the individual
1672     searches come back up to the <literal>multi</literal> filter, it
1673     merges them into a single Search response, which is what
1674     eventually makes it back to the client.
1675    </para>
1676
1677     <mediaobject>
1678      <imageobject>
1679       <imagedata fileref="multi.pdf" format="PDF" scale="50"/>
1680      </imageobject>
1681      <imageobject>
1682       <imagedata fileref="multi.png" format="PNG"/>
1683      </imageobject>
1684      <textobject>
1685       <!-- Fall back if none of the images can be used -->
1686       <phrase>
1687        [Here there should be a diagram showing the progress of
1688        packages through the filters during a simple virtual-database
1689        search and a multi-database search, but is seems that your
1690        tool chain has not been able to include the diagram in this
1691        document.]
1692       </phrase>
1693      </textobject>
1694      <caption>
1695       <para>A picture is worth a thousand words (but only five hundred on 64-bit architectures)</para>
1696      </caption>
1697     </mediaobject>
1698   </section>
1699  </chapter>
1700
1701
1702  <chapter id="sru-server">
1703   <title>Combined SRU webservice and Z39.50 server configuration</title>
1704   <para>
1705    Metaproxy can act as
1706    <ulink url="&url.sru;">SRU</ulink> and
1707    web service server, which translates web service requests to
1708    <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink> packages and
1709    sends them off to common available targets.
1710   </para>
1711   <para>
1712   A typical setup for this operation needs a filter route including the
1713   following modules:
1714   </para>
1715
1716   <table id="sru-server-table-config" frame="top">
1717    <title>SRU/Z39.50 Server Filter Route Configuration</title>
1718    <tgroup cols="3">
1719     <thead>
1720      <row>
1721       <entry>Filter</entry>
1722       <entry>Importance</entry>
1723       <entry>Purpose</entry>
1724      </row>
1725     </thead>
1726
1727     <tbody>
1728      <row>
1729       <entry><literal>frontend_net</literal></entry>
1730       <entry>required</entry>
1731       <entry>Accepting HTTP connections and passing them to following
1732       filters. Since this filter also accepts Z39.50 connections, the
1733       server works as SRU and Z39.50 server on the same port.</entry>
1734      </row>
1735      <row>
1736       <entry><literal>sru_z3950</literal></entry>
1737       <entry>required</entry>
1738       <entry>Accepting SRU GET/POST/SOAP explain and
1739        searchRetrieve requests for the the configured databases.
1740        Explain requests are directly served from the static XML configuration.
1741        SearchRetrieve requests are
1742        transformed  to Z39.50 search and present packages.
1743        All other HTTP and Z39.50 packages are passed unaltered.</entry>
1744      </row>
1745      <row>
1746       <entry><literal>http_file</literal></entry>
1747       <entry>optional</entry>
1748       <entry>Serving HTTP requests from the filesystem. This is only
1749       needed if the server should serve XSLT stylesheets, static HTML
1750       files or Java Script for thin browser based clients.
1751        Z39.50 packages are passed unaltered.</entry>
1752      </row>
1753      <row>
1754       <entry><literal>cql_rpn</literal></entry>
1755       <entry>required</entry>
1756       <entry>Usually, Z39.50 servers do not talk CQL, hence the
1757       translation of the CQL query language to RPN is mandatory in
1758       most cases. Affects only  Z39.50 search packages.</entry>
1759      </row>
1760      <row>
1761       <entry><literal>record_transform</literal></entry>
1762       <entry>optional</entry>
1763       <entry>Some Z39.50 backend targets can not present XML record
1764       syntaxes in common wanted element sets. using this filter, one
1765       can transform binary MARC records to MARCXML records, and
1766       further transform those to any needed XML schema/format by XSLT
1767       transformations. Changes only  Z39.50 present packages.</entry>
1768      </row>
1769      <row>
1770       <entry><literal>session_shared</literal></entry>
1771       <entry>optional</entry>
1772       <entry>The stateless nature of web services requires frequent
1773       re-searching of the same targets for display of paged result set
1774       records. This might be an unacceptable burden for the accessed
1775       backend Z39.50 targets, and this mosule can be added for
1776       efficient backend target resource pooling.</entry>
1777      </row>
1778      <row>
1779       <entry><literal>z3950_client</literal></entry>
1780       <entry>required</entry>
1781       <entry>Finally, a Z39.50 package sink is needed in the filter
1782       chain to provide the response packages. The Z39.50 client module
1783       is used to access external targets over the network, but any
1784       coming local Z39.50 package sink could be used instead of.</entry>
1785      </row>
1786      <row>
1787       <entry><literal>bounce</literal></entry>
1788       <entry>required</entry>
1789       <entry>Any Metaproxy package arriving here did not do so by
1790       purpose, and is bounced back with connection closure. this
1791       prevents inifinite package hanging inside the SRU server.</entry>
1792      </row>
1793     </tbody>
1794    </tgroup>
1795   </table>
1796   <para>
1797    A typical minimal example <ulink url="&url.sru;">SRU</ulink>
1798    server configuration file is found in the tarball distribution at
1799    <literal>etc/config-sru-to-z3950.xml</literal>.
1800   </para>
1801   <para>
1802    Off course, any other metaproxy modules can be integrated into a
1803    SRU server solution, including, but not limited to, load balancing,
1804    multiple target querying
1805    (see  <xref linkend="multidb"/>), and complex RPN query rewrites.
1806   </para>
1807
1808
1809  </chapter>
1810
1811  <!--
1812  <chapter id="extensions">
1813   <title>Writing extensions for Metaproxy</title>
1814   <para>### To be written</para>
1815  </chapter>
1816  -->
1817
1818
1819
1820  <chapter id="classes">
1821   <title>Classes in the Metaproxy source code</title>
1822
1823
1824   <section id="classes-introductory-notes">
1825    <title>Introductory notes</title>
1826    <para>
1827     <emphasis>Stop!  Do not read this!</emphasis>
1828     You won't enjoy it at all.  You should just skip ahead to
1829     <xref linkend="reference"/>,
1830     which tells
1831     <!-- The remainder of this paragraph is lifted verbatim from
1832     Douglas Adams' _Hitch Hiker's Guide to the Galaxy_, chapter 8 -->
1833     you things you really need to know, like the fact that the
1834     fabulously beautiful planet Bethselamin is now so worried about
1835     the cumulative erosion by ten billion visiting tourists a year
1836     that any net imbalance between the amount you eat and the amount
1837     you excrete whilst on the planet is surgically removed from your
1838     bodyweight when you leave: so every time you go to the lavatory it
1839     is vitally important to get a receipt.
1840    </para>
1841    <para>
1842     This chapter contains documentation of the Metaproxy source code, and is
1843     of interest only to maintainers and developers.  If you need to
1844     change Metaproxy's behavior or write a new filter, then you will most
1845     likely find this chapter helpful.  Otherwise it's a waste of your
1846     good time.  Seriously: go and watch a film or something.
1847     <citetitle>This is Spinal Tap</citetitle> is particularly good.
1848    </para>
1849    <para>
1850     Still here?  OK, let's continue.
1851    </para>
1852    <para>
1853     In general, classes seem to be named big-endianly, so that
1854     <literal>FactoryFilter</literal> is not a filter that filters
1855     factories, but a factory that produces filters; and
1856     <literal>FactoryStatic</literal> is a factory for the statically
1857     registered filters (as opposed to those that are dynamically
1858     loaded).
1859    </para>
1860   </section>
1861
1862   <section id="individual.classes">
1863    <title>Individual classes</title>
1864    <para>
1865     The classes making up the Metaproxy application are here listed by
1866     class-name, with the names of the source files that define them in
1867     parentheses.
1868    </para>
1869
1870    <section id="class-FactoryFilter">
1871     <title><literal>mp::FactoryFilter</literal>
1872      (<filename>factory_filter.cpp</filename>)</title>
1873     <para>
1874      A factory class that exists primarily to provide the
1875      <literal>create()</literal> method, which takes the name of a
1876      filter class as its argument and returns a new filter of that
1877      type.  To enable this, the factory must first be populated by
1878      calling <literal>add_creator()</literal> for static filters (this
1879      is done by the <literal>FactoryStatic</literal> class, see below)
1880      and <literal>add_creator_dyn()</literal> for filters loaded
1881      dynamically.
1882     </para>
1883    </section>
1884
1885    <section id="class-FactoryStatic">
1886     <title><literal>mp::FactoryStatic</literal>
1887      (<filename>factory_static.cpp</filename>)</title>
1888     <para>
1889      A subclass of <literal>FactoryFilter</literal> which is
1890      responsible for registering all the statically defined filter
1891      types.  It does this by knowing about all those filters'
1892      structures, which are listed in its constructor.  Merely
1893      instantiating this class registers all the static classes.  It is
1894      for the benefit of this class that <literal>struct
1895       metaproxy_1_filter_struct</literal> exists, and that all the filter
1896      classes provide a static object of that type.
1897     </para>
1898    </section>
1899
1900    <section id="class-filter-Base">
1901     <title><literal>mp::filter::Base</literal>
1902      (<filename>filter.cpp</filename>)</title>
1903     <para>
1904      The virtual base class of all filters.  The filter API is, on the
1905      surface at least, extremely simple: two methods.
1906      <literal>configure()</literal> is passed an XML DOM tree representing
1907      that part of the configuration file that pertains to this filter
1908      instance, and is expected to walk that tree extracting relevant
1909      information.  And <literal>process()</literal> processes a
1910      package (see below).  That surface simplicity is a bit
1911      misleading, as <literal>process()</literal> needs to know a lot
1912      about the <literal>Package</literal> class in order to do
1913      anything useful.
1914     </para>
1915    </section>
1916
1917    <section id="class-AuthSimple">
1918     <title><literal>mp::filter::AuthSimple</literal>,
1919      <literal>Backend_test</literal>, etc.
1920      (<filename>filter_auth_simple.cpp</filename>,
1921      <filename>filter_backend_test.cpp</filename>, etc.)</title>
1922     <para>
1923      Individual filters.  Each of these is implemented by a header and
1924      a source file, named <filename>filter_*.hpp</filename> and
1925      <filename>filter_*.cpp</filename> respectively.  All the header
1926      files should be pretty much identical, in that they declare the
1927      class, including a private <literal>Rep</literal> class and a
1928      member pointer to it, and the two public methods.
1929     </para>
1930     <para>
1931      The source file for each filter needs to supply:
1932     </para>
1933     <itemizedlist>
1934      <listitem>
1935       <para>
1936        A definition of the private <literal>Rep</literal> class.
1937       </para>
1938      </listitem>
1939      <listitem>
1940       <para>
1941        Some boilerplate constructors and destructors.
1942       </para>
1943      </listitem>
1944      <listitem>
1945       <para>
1946        A <literal>configure()</literal> method that uses the
1947        appropriate XML fragment.
1948       </para>
1949      </listitem>
1950      <listitem>
1951       <para>
1952        Most important, the <literal>process()</literal> method that
1953        does all the actual work.
1954       </para>
1955      </listitem>
1956     </itemizedlist>
1957    </section>
1958
1959    <section id="class-Package">
1960     <title><literal>mp::Package</literal>
1961      (<filename>package.cpp</filename>)</title>
1962     <para>
1963      Represents a package on its way through the series of filters
1964      that make up a route.  This is essentially a Z39.50 or SRU APDU
1965      together with information about where it came from, which is
1966      modified as it passes through the various filters.
1967     </para>
1968    </section>
1969
1970    <section id="class-Pipe">
1971     <title><literal>mp::Pipe</literal>
1972      (<filename>pipe.cpp</filename>)</title>
1973     <para>
1974      This class provides a compatibility layer so that we have an IPC
1975      mechanism that works the same under Unix and Windows.  It's not
1976      particularly exciting.
1977     </para>
1978    </section>
1979
1980    <section id="class-RouterChain">
1981     <title><literal>mp::RouterChain</literal>
1982      (<filename>router_chain.cpp</filename>)</title>
1983     <para>
1984      ### to be written
1985     </para>
1986    </section>
1987
1988    <section id="class-RouterFleXML">
1989     <title><literal>mp::RouterFleXML</literal>
1990      (<filename>router_flexml.cpp</filename>)</title>
1991     <para>
1992      ### to be written
1993     </para>
1994    </section>
1995
1996    <section id="class-Session">
1997     <title><literal>mp::Session</literal>
1998      (<filename>session.cpp</filename>)</title>
1999     <para>
2000      ### to be written
2001     </para>
2002    </section>
2003
2004    <section id="class-ThreadPoolSocketObserver">
2005     <title><literal>mp::ThreadPoolSocketObserver</literal>
2006      (<filename>thread_pool_observer.cpp</filename>)</title>
2007     <para>
2008      ### to be written
2009     </para>
2010    </section>
2011
2012    <section id="class-util">
2013     <title><literal>mp::util</literal>
2014      (<filename>util.cpp</filename>)</title>
2015     <para>
2016      A namespace of various small utility functions and classes,
2017      collected together for convenience.  Most importantly, includes
2018      the <literal>mp::util::odr</literal> class, a wrapper for YAZ's
2019      ODR facilities.
2020     </para>
2021    </section>
2022
2023    <section id="class-xml">
2024     <title><literal>mp::xml</literal>
2025      (<filename>xmlutil.cpp</filename>)</title>
2026     <para>
2027      A namespace of various XML utility functions and classes,
2028      collected together for convenience.
2029     </para>
2030    </section>
2031   </section>
2032
2033
2034   <section id="other.source.files">
2035    <title>Other Source Files</title>
2036    <para>
2037     In addition to the Metaproxy source files that define the classes
2038     described above, there are a few additional files which are
2039     briefly described here:
2040    </para>
2041    <variablelist>
2042     <varlistentry>
2043      <term><literal>metaproxy_prog.cpp</literal></term>
2044      <listitem>
2045       <para>
2046        The main function of the <command>metaproxy</command> program.
2047       </para>
2048      </listitem>
2049     </varlistentry>
2050     <varlistentry>
2051      <term><literal>ex_router_flexml.cpp</literal></term>
2052      <listitem>
2053       <para>
2054        Identical to <literal>metaproxy_prog.cpp</literal>: it's not clear why.
2055       </para>
2056      </listitem>
2057     </varlistentry>
2058     <varlistentry>
2059      <term><literal>test_*.cpp</literal></term>
2060      <listitem>
2061       <para>
2062        Unit-tests for various modules.
2063       </para>
2064      </listitem>
2065     </varlistentry>
2066    </variablelist>
2067    <para>
2068     ### Still to be described:
2069     <literal>ex_filter_frontend_net.cpp</literal>,
2070     <literal>filter_dl.cpp</literal>,
2071     <literal>plainfile.cpp</literal>,
2072     <literal>tstdl.cpp</literal>.
2073    </para>
2074   </section>
2075  </chapter>
2076
2077
2078  <reference id="reference">
2079   <title>Reference</title>
2080    <partintro id="reference-introduction">
2081     <para>
2082      The material in this chapter is drawn directly from the individual
2083      manual entries.  In particular, the Metaproxy invocation section is
2084      available using <command>man metaproxy</command>, and the section
2085      on each individual filter is available using the name of the filter
2086      as the argument to the <command>man</command> command.
2087     </para>
2088    </partintro>
2089    &manref;
2090  </reference>
2091
2092 <appendix id="license">
2093  <title>License</title>
2094
2095   &copyright;
2096
2097   <para>
2098    Metaproxy is free software; you can redistribute it and/or modify it under
2099    the terms of the GNU General Public License as published by the Free
2100    Software Foundation; either version 2, or (at your option) any later
2101    version.
2102    </para>
2103
2104   <para>
2105    Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
2106    WARRANTY; without even the implied warranty of MERCHANTABILITY or
2107    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
2108    for more details.
2109   </para>
2110
2111   <para>
2112    You should have received a copy of the GNU General Public License
2113    along with Metaproxy; see the file LICENSE.  If not, write to the
2114    Free Software Foundation,
2115    51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
2116    </para>
2117
2118  </appendix>
2119
2120  &gpl2;
2121 </book>
2122
2123 <!-- Keep this comment at the end of the file
2124 Local variables:
2125 mode: nxml
2126 nxml-child-indent: 1
2127 End:
2128 -->