SRW/SRU in most places.
-YAZ proxy - A Z39.50/SRW/SRU proxy.
+YAZ proxy - A Z39.50/SRU proxy.
-$Id: README,v 1.5 2004-04-11 17:31:51 adam Exp $
+$Id: README,v 1.6 2006-06-14 10:12:23 adam Exp $
Introduction
------------
-YAZ proxy is a powerful general purpose Z39.50/SRW/SRU proxy.
+YAZ proxy is a powerful general purpose Z39.50/SRU proxy.
The proxy application and development library is covered by the
GPL - see LICENSE for details.
categoryValue [2] IMPLICIT INTEGER}
The InfoCategory is present with categoryTypeId set to the PROXY OID
-and categoryValue set to 0. The information in OtherInformation uses
+and categoryValue set to 1. The information in OtherInformation uses
characterInfo to represent the target using the form target[:port][/db].
For clients that don't set the PROXY OtherInformation, a default
<chapter id="installation">
- <!-- $Id: installation.xml,v 1.11 2006-04-26 12:17:23 adam Exp $ -->
+ <!-- $Id: installation.xml,v 1.12 2006-06-14 10:12:26 adam Exp $ -->
<title>Installation</title>
<para>
You need a C++ compiler to compile and use YAZ proxy.
<ulink url="&url.libxslt;">libXSLT</ulink> are installed.
YAZ must be configured with libxml2 support.
If not,
- <ulink url="&url.sru;">SRW/SRU</ulink>
+ <ulink url="&url.sru;">SRU</ulink>
is not supported.
The YAZ Proxy uses libXSLT for record conversions via XSLT.
</para>
-<!-- $Id: introduction.xml,v 1.8 2006-04-26 12:17:23 adam Exp $ -->
+<!-- $Id: introduction.xml,v 1.9 2006-06-14 10:12:26 adam Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
The <ulink url="&url.yazproxy;">YAZ Proxy</ulink> is
<itemizedlist>
<listitem>
<para>
- <ulink url="&url.sru;">SRW/SRU</ulink>
+ <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
server function, to allow any
<ulink url="&url.z39.50;">Z39.50</ulink>
- server to also support the SRW/SRU protocols.
+ server to also support the SRU protocols.
</para>
</listitem>
</orderedlist>
</para>
<para>
- If the proxy receives an SRW/SRU request, the following rules are used.
+ If the proxy receives an SRU request, the following rules are used.
<orderedlist>
<listitem>
<para>If default target has Explain information with a
<literal>database</literal> that matches the path of the
- HTTP request of SRW/SRU that backend server is used for
- SRW/SRU operation.
- </para>
+ HTTP request of SRU that backend server is used for SRU operation.
+ </para>
</listitem>
<listitem>
<para>
</listitem>
</orderedlist>
</para>
- <note>
- <para>
- We know it is stupid to only check for explain in default target.
- It means that it is only possible to offer one SRW/SRU server.
- We expect to improve that in the next version of the YAZ proxy.
- </para>
- </note>
</section>
<section id="proxy-keepalive">
<title>Keep-alive Facility</title>
</para>
<para>
If attribute <literal>identifier</literal> is given that is the
- SRW/SRU record schema identifier for the resulting output record (after
+ SRU record schema identifier for the resulting output record (after
MARCXML and/or XSLT conversion).
</para>
<para>
If sub element <literal>title</literal> is given (as child element
- of <literal>syntax</literal>, then that is the official SRW/SRU
+ of <literal>syntax</literal>, then that is the official SRU
name of the resulting record schema.
</para>
<para>
<title>explain</title>
<para>
The <literal>explain</literal> element includes Explain information
- for SRW/SRU about the server in the target section. This
+ for SRU about the server in the target section. This
information must have a <literal>serverInfo</literal> element
with a database that this target must be available as (URL path).
For example,
</explain>
]]>
</screen>
- In the above case, the SRW/SRU service is available as
+ In the above case, the SRU service is available as
<literal>http://myhost.org:8000/mydatabase</literal>.
</para>
The content of the <literal>cql2rpn</literal> element specifies
the path from the working directory to a CQL-to-RPN conversion
file for the server in the target section. This element
- is required for SRW/SRU searches to operate against Z39.50
+ is required for SRU searches to operate against Z39.50
servers that don't support CQL. Most Z39.50 servers only support
Type-1/RPN so this is usually required.
</para>
</para>
<para>
If this is specified the proxy will act as a Z39.50 server
- supporting character set negotiation. And in SRW/SRU mode
+ supporting character set negotiation. And in SRU mode
it will convert from UTF-8 (UNICODE) to this native character
set (if possible).
</para>
The <literal>categoryTypeId</literal> is either
OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
for proxy target and proxy cookie respectively. The
- integer element <literal>category</literal> is set to 0.
+ <literal>categoryValue</literal> is set to 1.
The value proxy and cookie is stored in element
<literal>characterInfo</literal> of the <literal>information</literal>
choice.
<screen><![CDATA[
<?xml version="1.0"?>
<!-- XML Schema for YAZ proxy config file.
- $Id: reference.xml,v 1.19 2006-04-26 12:17:23 adam Exp $
+ $Id: reference.xml,v 1.20 2006-06-14 10:12:26 adam Exp $
-->
<xs:schema
xmlns:xs="http://www.w3.org/2001/XMLSchema"
This chapter includes a few examples.
</para>
<para>
- The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging
+ The YAZ Proxy is useful for debugging SRU/Z39.50 software, logging
APDUs, redirecting Z39.50 packages through firewalls, etc.
Furthermore, it offers facilities that often
boost performance for connection-less Z39.50 clients such
</example>
<example id="example-srw-service">
- <title>Offering SRW/SRU/Z39.50 service</title>
+ <title>Offering SRU/Z39.50 service</title>
<para>
- In order to offer SRW/SRU service we must be specify sufficient
- information to allow the proxy to convert from SRW/SRU to Z39.50.
+ In order to offer SRU service we must be specify sufficient
+ information to allow the proxy to convert from SRU to Z39.50.
This involves translating CQL queries
to Type-1 (also called RPN/PQF), since most
Z39.50 servers do not support CQL. The conversion
recommended).
</para>
<para>
- An explain record for the SRW/SRU service must also be created.
+ An explain record for the SRU service must also be created.
</para>
<para>
The following is a relatively simple configuration file for
given by <literal>url</literal>.
</para>
<para>
- The server may return USMARC/MARC21 (Z39.50/SRW/SRU) and
- MARCXML (SRW/SRU only) as specified by the
+ The server may return USMARC/MARC21 (Z39.50/SRU) and
+ MARCXML (SRU only) as specified by the
<link linkend="proxy-config-syntax">syntax</link> elements.
</para>
<screen><![CDATA[
<?xml version="1.0"?>
-<!-- $Id: using.xml,v 1.6 2005-03-14 13:16:03 adam Exp $ -->
+<!-- $Id: using.xml,v 1.7 2006-06-14 10:12:26 adam Exp $ -->
<proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<target name="bagel">
<url>indexdata.dk</url>
</refmeta>
<refnamediv>
<refname>yazproxy</refname>
- <refpurpose>The YAZ toolkit's transparent Z39.50/SRW/SRU proxy</refpurpose>
+ <refpurpose>The YAZ toolkit's transparent Z39.50/SRU proxy</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<refsect1><title>DESCRIPTION</title>
<para>
<command>yazproxy</command> is a proxy that accepts connections
- from Z39.50/SRW/SRU clients and contacts a Z39.50 backend.
+ from Z39.50/SRU clients and contacts a Z39.50 backend.
The listening port must be specified on the command-line.
<command>inetd</command> operation is not supported.
The <replaceable>host</replaceable>:<replaceable>port</replaceable>
<!ENTITY % common SYSTEM "common/common.ent">
%common;
]>
-<!-- $Id: yazproxy.xml,v 1.1 2006-06-02 08:53:23 adam Exp $ -->
+<!-- $Id: yazproxy.xml,v 1.2 2006-06-14 10:12:26 adam Exp $ -->
<book id="yazproxy">
<bookinfo>
<title>YAZ proxy User's Guide and Reference</title>
<abstract>
<simpara>
<ulink url="&url.yazproxy;">YAZ proxy</ulink>
- is a powerful general purpose Z39.50/SRW/SRU proxy.
+ is a powerful general purpose Z39.50/SRU proxy.
</simpara>
<simpara>
This manual covers version &version;.
</simpara>
<simpara>
- CVS ID: $Id: yazproxy.xml,v 1.1 2006-06-02 08:53:23 adam Exp $
+ CVS ID: $Id: yazproxy.xml,v 1.2 2006-06-14 10:12:26 adam Exp $
</simpara>
<simpara>
<inlinemediaobject>