X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fproxy.xml;h=3f0c27ce1c1c9ed569fb2d71fb98109da6bf76d5;hb=1b6019ff065a98af709be905adc6c08094471d57;hp=dfac254b5959d421b1edc5ac2fefed9f1d6fae52;hpb=50fbcf20ab48480e819ec5aef312a72c684bf213;p=yazpp-moved-to-github.git diff --git a/doc/proxy.xml b/doc/proxy.xml index dfac254..3f0c27c 100644 --- a/doc/proxy.xml +++ b/doc/proxy.xml @@ -1,13 +1,19 @@ The YAZ Proxy - The YAZ proxy is a transparent Z39.50-to-Z39.50 gateway. That is, - it is a Z39.50 server which has as its back-end a Z39.50 client - that forwards requests on to another server (known as the - backend target.) + The YAZ proxy is a transparent SRW/SRU/Z39.50-to-Z39.50 gateway. + That is, it is a SRW/SRU/Z39.50 server which has as its back-end a + Z39.50 client that forwards requests on to another server (known as + the backend target.) - The YAZ Proxy is useful for debugging Z39.50 software, logging + -- All config directives -- + -- SRW/SRU .. + -- Example config + -- Mention XSLT conversion + + + The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging APDUs, redirecting Z39.50 packages through firewalls, etc. Furthermore, it offers facilities that often boost performance for connectionless Z39.50 clients such @@ -126,11 +132,11 @@
Specifying the Backend Target - When the proxy accepts a Z39.50 client session, it - determines the backend target by the following rules: + When the proxy receives a Z39.50 Initialize Request from a Z39.50 + client, it determines the backend target by the following rules: - If the InitializeRequest PDU from the + If the InitializeRequest PDU from the client includes an otherInfo element with OID @@ -139,19 +145,19 @@ usual YAZ address format (typically tcp:hostname:port) as described in - the Addresses section of the YAZ manual. - Otherwise, the Proxy uses the default target, if one was + Otherwise, the Proxy uses the default target, if one was specified on the command-line with the -t option. A default target can also be specified in the XML Config file. - Otherwise, the proxy closes the connection with + Otherwise, the proxy closes the connection with the client. @@ -173,7 +179,7 @@ When a client reconnects, query and record caching works better, if the proxy assigns it to the same backend as before. And the result set - (if any) is re-used. To achive this, Index Data defined a session + (if any) is re-used. To achieve this, Index Data defined a session cookie which identifies the backend session. @@ -247,9 +253,10 @@ client. Finally, the proxy may convert records. - In the current version the only supported conversion is - MARC21/USMARC in MARC-8 charset to MARCXML in UTF-8. Future version of - the proxy may do other record/charset conversions. + The proxy can convert from MARC to MARCXML and thereby offer an + XML version of any MARC record as long as it is ISO2709 encoded. + If the proxy is compiled with libXSLT support it can also + perform XSLT on XML.
@@ -264,12 +271,13 @@
Proxy Configuration File - The Proxy as an option may read a configuration file using option + The Proxy may read a configuration file using option -c followed by the filename of a config file. - The config file is in XML format. The YAZ proxy must be compiled - with libxml2 support in + The config file is XML based. The YAZ proxy must be compiled + with libxml2 and + libXSLT support in order for the config file facility to be enabled. @@ -299,7 +307,7 @@ Configuration: target The element target which may be repeated zero - or more times with parent elemtn proxy contains + or more times with parent element proxy contains information about each backend target. The target element have two attributes: name which holds the logical name of the backend @@ -375,7 +383,7 @@ measures the number of bytes transferred within the last minute. The pdu is the number of requests in the last minute. The retrieve holds the maximum records to - be retrived in one Present Request. + be retrieved in one Present Request. If a bandwidth/pdu limit is reached the proxy will postpone the @@ -455,7 +463,7 @@ or a particular record syntax request from the client. - The syntax has one equired attribute: + The syntax has one required attribute: type which is the Preferred Record Syntax. @@ -473,8 +481,8 @@ type should be XML. The proxy will use preferred record syntax USMARC/MARC21 against the backend target. - To accept USMARC and offer MARCXML XML recors but reject - all other requests the following configuaration could be used: + To accept USMARC and offer MARCXML XML records but reject + all other requests the following configuration could be used: <proxy> <target name="mytarget"> @@ -495,7 +503,7 @@ a target session is shut down. - This can also be specified on the command line bt using option + This can also be specified on the command line by using option -T. Refer to .
@@ -581,7 +589,11 @@ client-apdu Log APDUs as reported by YAZ for the - communication between the client and the proxy + communication between the client and the proxy. + This facility is equivalent to the APDU logging that + happens when using option -a, however + this tells the proxy to log in the same file as given + by -l. @@ -675,4 +687,4 @@ sgml-namecase-general:t End: --> - \ No newline at end of file +