X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Freference.xml;h=644fe5877843eebf060155f2f24e465a294326c8;hb=b65837a1f4aadf842d112f5e37382d93f26da83d;hp=15274ea7b372d7d630412f5e7cd589b1da887b43;hpb=101d9c2ca072f3cd7fb6cb89c67573318b14b8c1;p=yazproxy-moved-to-github.git diff --git a/doc/reference.xml b/doc/reference.xml index 15274ea..644fe58 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -12,12 +12,12 @@ see . - As an option the proxy may change user identity to a less priviledged + As an option the proxy may change user identity to a less privileged user.
- Specifying the Backend Server + Choosing the Backend Server When the proxy receives a Z39.50 Initialize Request from a Z39.50 client, it determines the backend server by the following rules: @@ -57,6 +57,30 @@ + + If the proxy receives an SRW/SRU request, the following rules are used. + + + If default target has Explain information with a + database that matches the path of the + HTTP request of SRW/SRU that backend server is used for + SRW/SRU operation. + + + + + Otherwise the service will return HTTP 404 (Not found). + + + + + + + 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. + +
Keep-alive Facility @@ -104,6 +128,10 @@ libXSLT support in order for the config file facility to be enabled. + + See for an XML schema + for the configuration. + To check for a config file to be well-formed, the yazproxy may be invoked without specifying a listening port, i.e. @@ -117,14 +145,16 @@ Proxy Configuration Header The proxy config file must have a root element called - proxy. All information except an optional XML - header must be stored within the proxy element. + proxy and scoped within namespace + xmlns="http://indexdata.dk/yazproxy/schema/0.8/. + All information except an optional XML header must be stored + within the proxy element. <?xml version="1.0"?> - <proxy> - <!-- content here .. --> - </proxy> + <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/"> + <!-- content here .. --> + </proxy>
@@ -142,7 +172,7 @@ <?xml version="1.0"?> - <proxy> + <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/"> <target name="server1" default="1"> <!-- description of server1 .. --> </target> @@ -213,7 +243,7 @@ The following sets maximum number of bytes transferred in a - target session to 1 MB and maxinum of requests to 400. + target session to 1 MB and maximum of requests to 400. <keepalive> <bandwidth>1048576</bandwidth> @@ -306,19 +336,6 @@
- - -
syntax @@ -344,18 +361,55 @@ type should be XML. The proxy will use preferred record syntax USMARC/MARC21 against the backend target. - To accept USMARC and offer MARCXML XML records but reject - all other requests the following configuration could be used: - - <proxy> + + If attribute stylesheet is given, the proxy + will convert XML record from server via XSLT. It is important + that the content from server is XML. If used in conjunction with + attribute marcxml the MARC to MARCXML conversion + takes place before the XSLT conversion takes place. + + + If attribute identifier is given that is the + SRW/SRU record schema identifier for the resulting output record (after + MARCXML and/or XSLT conversion). + + + If sub element title is given (as child element + of syntax, then that is the official SRW/SRU + name of the resulting record schema. + + + If sub element name is given that is an alias + for the record schema identifier. Multiple names + may be specified. + + + MARCXML conversion + To accept USMARC and offer MARCXML XML plus Dublin Core (via + XSLT conversion) but the following configuration could be used: + + <proxy> <target name="mytarget"> + .. <syntax type="usmarc"/> - <syntax type="xml" marcxml="1"/> - <syntax type="*" error="238"/> + <syntax type="xml" marcxml="1" + identifier="info:srw/schema/1/marcxml-v1.1" + <title>MARCXML<title> + <name>marcxml<name> + <syntax> + <syntax type="xml" marcxml="1" stylesheet="MARC21slim2SRWDC.xsl" + identifier="info:srw/schema/1/dc-v1.1"> + <title>Dublin Core<title> + <name>dc<name> + <syntax> + <syntax type="*" error="238"/> + .. </target> - </proxy> - + </proxy> + + +
@@ -623,7 +677,114 @@ characterInfo of the information choice. -
+ +
+ YAZ Proxy Configuration Schema + + Here an XML Schema for the YAZ proxy configuration file. + The schema, yazproxy.xsd is located in sub + directory etc of the distribution. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + +