node-zoom

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>yaz-ztest</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="reference.html" title="Reference"><link rel="prev" href="yaz-client.html" title="yaz-client"><link rel="next" href="yaz-config.html" title="yaz-config"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">yaz-ztest</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="yaz-client.html">Prev</a>�</td><th width="60%" align="center">Reference</th><td width="20%" align="right">�<a accesskey="n" href="yaz-config.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="yaz-ztest"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2>yaz-ztest — Z39.50/SRU Test Server</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">application</code> [<code class="option">-install</code>] [<code class="option">-installa</code>] [<code class="option">-remove</code>] [<code class="option">-a <code>file</code></code>] [<code class="option">-v <code>level</code></code>] [<code class="option">-l <code>file</code></code>] [<code class="option">-u <code>uid</code></code>] [<code class="option">-c <code>config</code></code>] [<code class="option">-f <code>vconfig</code></code>] [<code class="option">-C <code>fname</code></code>] [<code class="option">-t <code>minutes</code></code>] [<code class="option">-k <code>kilobytes</code></code>] [<code class="option">-K</code>] [<code class="option">-d <code>daemon</code></code>] [<code class="option">-w <code>dir</code></code>] [<code class="option">-p <code>pidfile</code></code>] [<code class="option">-r <code>kilobytes</code></code>] [<code class="option">-ziDSTV1</code>] [listener-spec...]</div></div><div class="refsect1"><a name="idp51858976"></a><h2>DESCRIPTION</h2> yaz-ztest is a Z39.50/SRU test server that uses the YAZ generic frontend server (GFS) API. The server acts as a real Z39.50/SRU server but does not use a database. It returns a random hit count and returns a subset of a few built-in records. The <code>listener-spec</code> consists of a transport mode followed by a colon, followed by a listener address. The transport mode is either <code class="literal">tcp</code>, <code class="literal">unix</code>, or <code class="literal">ssl</code>. For TCP and SSL, an address has the form: <pre class="screen"> hostname | IP-number [ : portnumber ] </pre> For UNIX local socket the address is the filename of the local socket. </div><div class="refsect1"><a name="idp51865584"></a><h2>OPTIONS</h2><div class="variablelist"><dl class="variablelist"><dt><code class="literal">-a </code> <code>file</code></dt><dd> Specify a file for dumping PDUs (for diagnostic purposes). The special name <code class="literal">-</code> (dash) sends output to <code class="literal">stderr</code>. </dd><dt><code class="literal">-S</code></dt><dd> Don't fork or make threads on connection requests. This is good for debugging, but not recommended for real operation: Although the server is asynchronous and non-blocking, it can be nice to keep a software malfunction (okay then, a crash) from affecting all current users. </dd><dt><code class="literal">-1</code></dt><dd> Like <code class="literal">-S</code> but after one session the server exits. This mode is for debugging only. </dd><dt><code class="literal">-T</code></dt><dd> Operate the server in threaded mode. The server creates a thread for each connection rather than a fork a process. Only available on UNIX systems that offers POSIX threads. </dd><dt><code class="literal">-s</code></dt><dd> Use the SR protocol (obsolete). </dd><dt><code class="literal">-z</code></dt><dd> Use the Z39.50 protocol (default). This option and <code class="literal">-s</code> complement each other. You can use both multiple times on the same command line, between listener-specifications (see below). This way, you can set up the server to listen for connections in both protocols concurrently, on different local ports. </dd><dt><code class="literal">-l </code><code>file</code></dt><dd>The logfile. </dd><dt><code class="literal">-c </code><code>config</code></dt><dd>A user option that serves as a specifier for some sort of configuration, usually a filename. The argument to this option is transferred to member <code class="literal">configname</code> of the <code class="literal">statserv_options_block</code>. </dd><dt><code class="literal">-f </code><code>vconfig</code></dt><dd>This specifies an XML file that describes one or more YAZ frontend virtual servers. </dd><dt><code class="literal">-C </code><code>fname</code></dt><dd>Sets SSL certificate file name for server (PEM). </dd><dt><code class="literal">-v </code><code>level</code></dt><dd> The log level. Use a comma-separated list of members of the set {fatal,debug,warn,log,malloc,all,none}. </dd><dt><code class="literal">-u </code><code>uid</code></dt><dd> Set user ID. Sets the real UID of the server process to that of the given user. It's useful if you aren't comfortable with having the server run as root, but you need to start it as such to bind a privileged port. </dd><dt><code class="literal">-w </code><code>dir</code></dt><dd> The server changes to this directory during before listening on incoming connections. This option is useful when the server is operating from the inetd daemon (see <code class="literal">-i</code>). </dd><dt> <code class="literal">-p </code><code>pidfile</code> </dt><dd> Specifies that the server should write its Process ID to file given by <code>pidfile</code>. A typical location would be <code class="filename">/var/run/yaz-ztest.pid</code>. </dd><dt><code class="literal">-i</code></dt><dd> Use this to make the the server run from the inetd server (UNIX only). </dd><dt><code class="literal">-D</code></dt><dd> Use this to make the server put itself in the background and run as a daemon. If neither <code class="literal">-i</code> nor <code class="literal">-D</code> is given, the server starts in the foreground. </dd><dt><code class="literal">-install</code></dt><dd> Use this to install the server as an NT service (Windows NT/2000/XP only). Control the server by going to the Services in the Control Panel. </dd><dt><code class="literal">-installa</code></dt><dd> Use this to install the server as an NT service and mark it as "auto-start. Control the server by going to the Services in the Control Panel. </dd><dt><code class="literal">-remove</code></dt><dd> Use this to remove the server from the NT services (Windows NT/2000/XP only). </dd><dt><code class="literal">-t </code><code>minutes</code></dt><dd> Idle session timeout, in minutes. </dd><dt><code class="literal">-k </code><code>size</code></dt><dd> Maximum record size/message size, in kilobytes. </dd><dt><code class="literal">-K</code></dt><dd> Forces no-keepalive for HTTP sessions. By default GFS will keep sessions alive for HTTP 1.1 sessions (as defined by the standard). Using this option will force GFS to close the connection for each operation. </dd><dt><code class="literal">-r </code><code>size</code></dt><dd> Maximum size of log file before rotation occurs, in kilobytes. Default size is 1048576 k (=1 GB). </dd><dt> <code class="literal">-d </code><code>daemon</code> </dt><dd> Set name of daemon to be used in hosts access file. See hosts_access(5) and tcpd(8). </dd><dt><code class="literal">-m </code><code>time-format</code></dt><dd> Sets the format of time-stamps in the log-file. Specify a string in the input format to <code class="literal">strftime()</code>. </dd><dt><code class="literal">-V </code></dt><dd> Display YAZ version and exit. </dd></dl></div></div><div class="refsect1"><a name="idp51931808"></a><h2>TESTING</h2> yaz-ztest normally returns a random hit count between 0 and 24. However, if a query term includes leading digits, then the integer value of that term is used as hit count. This allows testers to return any number of hits. yaz-ztest includes 24 MARC records for testing. Hit counts exceeding 24 will make yaz-ztest return the same record batch over and over.. So record at position 1, 25, 49, etc .. are equivalent. For XML if no element set is given or element has value "marcxml", MARCXML is returned (each of the 24 dummy records converted from ISO2709 to XML). For element set OP, OPAC XML is returned. yaz-ztest may also return predefined XML records (for testing). This is enabled if <code class="literal">YAZ_ZTEST_XML_FETCH</code> environment variable is defined. A record is fetched form a file (one record per file). The path for the filename is <code>F</code><code>E</code><code class="literal">.</code><code>d</code><code class="literal">.xml</code> where <code>F</code> is the YAZ_ZTEST_XML_FETCH value (possibly empty), <code>E</code> is element-set, <code>d</code> is record position (starting from 1). The following databases are honored by yaz-ztest: <code class="literal">Default</code>, <code class="literal">slow</code> and <code class="literal">db.*</code> (all databases with prefix "db"). Any other database will make yaz-ztest return diagnostic 109: "Database unavailable". Options for search may be included in the form or URL get arguments included as part of the Z39.50 database name. The following database options are present: <code class="literal">search-delay</code>, <code class="literal">present-delay</code>, <code class="literal">fetch-delay</code> and <code class="literal">seed</code>. The former, delay type options, specify a fake delay (sleep) that yaz-ztest will perform when searching, presenting, fetching records respectively. The value of the delay may either be a fixed floating point value which specifies the delay in seconds. Alternatively the value may be given as two floating point numbers separated by colon, which wil make yaz-ztest perform a random sleep between the first and second number. The database parameter <code class="literal">seed</code> takes an integer as value. This will call <code class="literal">srand</code> with this integer to ensure that the random behavior can be re-played. Suppose we want searches to take between 0.1 and 0.5 seconds and a fetch to take 0.2 second. To access test database Default we'd use: <code class="literal">Default?search-delay=0.1:0.5&fetch-delay=0.2</code>. </div><div class="refsect1"><a name="idp51953856"></a><h2>GFS CONFIGURATION AND VIRTUAL HOSTS</h2> The Virtual hosts mechanism allows a YAZ frontend server to support multiple backends. A backend is selected on the basis of the TCP/IP binding (port+listening adddress) and/or the virtual host. A backend can be configured to execute in a particular working directory. Or the YAZ frontend may perform CQL to RPN conversion, thus allowing traditional Z39.50 backends to be offered as a SRW/SRU service. SRW/SRU Explain information for a particular backend may also be specified. For the HTTP protocol, the virtual host is specified in the Host header. For the Z39.50 protocol, the virtual host is specified as in the Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1. <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> Not all Z39.50 clients allows the VHOST information to be set. For those the selection of the backend must rely on the TCP/IP information alone (port and address). </div> The YAZ frontend server uses XML to describe the backend configurations. Command-line option <code class="literal">-f</code> specifies filename of the XML configuration. The configuration uses the root element <code class="literal">yazgfs</code>. This element includes a list of <code class="literal">listen</code> elements, followed by one or more <code class="literal">server</code> elements. The <code class="literal">listen</code> describes listener (transport end point), such as TCP/IP, Unix file socket or SSL server. Content for a listener: <div class="variablelist"><dl class="variablelist"><dt>CDATA (required)</dt><dd> The CDATA for the <code class="literal">listen</code> element holds the listener string, such as <code class="literal">tcp:@:210</code>, <code class="literal">tcp:server1:2100</code>, etc. </dd><dt>attribute <code class="literal">id</code> (optional)</dt><dd> identifier for this listener. This may be referred to from server sections. </dd></dl></div> <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3> We expect more information to be added for the listen section in a future version, such as CERT file for SSL servers. </div> The <code class="literal">server</code> describes a server and the parameters for this server type. Content for a server: <div class="variablelist"><dl class="variablelist"><dt>attribute <code class="literal">id</code> (optional)</dt><dd> Identifier for this server. Currently not used for anything, but it might be for logging purposes. </dd><dt>attribute <code class="literal">listenref</code> (optional)</dt><dd> Specifies one or more listeners for this server. Each server ID is separated by a comma. If this attribute is not given, the server is accessible from all listeners. In order for the server to be used for real, however, the virtual host must match if specified in the configuration. </dd><dt>element <code class="literal">config</code> (optional)</dt><dd> Specifies the server configuration. This is equivalent to the config specified using command line option <code class="literal">-c</code>. </dd><dt>element <code class="literal">directory</code> (optional)</dt><dd> Specifies a working directory for this backend server. If specifid, the YAZ fronend changes current working directory to this directory whenever a backend of this type is started (backend handler bend_start), stopped (backend handler hand_stop) and initialized (bend_init). </dd><dt>element <code class="literal">host</code> (optional)</dt><dd> Specifies the virtual host for this server. If this is specified a client must specify this host string in order to use this backend. </dd><dt>element <code class="literal">cql2rpn</code> (optional)</dt><dd> Specifies a filename that includes CQL to RPN conversion for this backend server. See <a class="xref" href="tools.html#cql.to.rpn" title="1.3.4.�Specification of CQL to RPN mappings">Section�1.3.4, “Specification of CQL to RPN mappings”</a> If given, the backend server will only "see" a Type-1/RPN query. </dd><dt>element <code class="literal">ccl2rpn</code> (optional)</dt><dd> Specifies a filename that includes CCL to RPN conversion for this backend server. See <a class="xref" href="tools.html#ccl.qualifiers" title="1.2.2.�CCL Qualifiers">Section�1.2.2, “CCL Qualifiers”</a> If given, the backend server will only "see" a Type-1/RPN query. </dd><dt>element <code class="literal">stylesheet</code> (optional)</dt><dd> Specifies the stylesheet reference to be part of SRU HTTP responses when the client does not specify one. If neither this is given, nor the client specifies one, no stylesheet reference is part of the SRU HTTP response. </dd><dt>element <code class="literal">client_query_charset</code> (optional)</dt><dd> If specified, a conversion from the character set given to UTF-8 is performed by the generic frontend server. It is only executed for Z39.50 search requests (SRU/Solr are assumed to be UTF-8 encoded already). </dd><dt>element <code class="literal">docpath</code> (optional)</dt><dd> Specifies a path for local file access using HTTP. All URLs with a leading prefix (/ exluded) that matches the value of docpath are used for file access. For example, if the server is to offer access in directory <code class="literal">xsl</code>, the docpath would be <code class="literal">xsl</code> and all URLs of the form <code class="literal">http://host/exl</code> will result in a local file access. </dd><dt>element <code class="literal">explain</code> (optional)</dt><dd> Specifies SRW/SRU ZeeRex content for this server. Copied verbatim to the client. As things are now, some of the Explain content seeem redundant because host information, etc. is also stored elsewhere. </dd><dt>element <code class="literal">maximumrecordsize</code> (optional)</dt><dd> Specifies maximum record size/message size, in bytes. This value also servers as maximum size of incoming packages (for Record Updates etc). It's the same value as that given by the <code class="literal">-k</code> option. </dd><dt>element <code class="literal">retrievalinfo</code> (optional)</dt><dd> Enables the retrieval facility supporting conversions and specifications of record formats/types. See <a class="xref" href="tools.retrieval.html" title="6.�Retrieval Facility">Section�6, “Retrieval Facility”</a> for more information. </dd></dl></div> The XML below configures a server that accepts connections from two ports, TCP/IP port 9900 and a local UNIX file socket. We name the TCP/IP server <code class="literal">public</code> and the other server <code class="literal">internal</code>. <pre class="screen"> <yazgfs> <listen id="public">tcp:@:9900</listen> <listen id="internal">unix:/var/tmp/socket</listen> <server id="server1"> <host>server1.mydomain</host> <directory>/var/www/s1</directory> <config>config.cfg</config> </server> <server id="server2" listenref="public,internal"> <host>server2.mydomain</host> <directory>/var/www/s2</directory> <config>config.cfg</config> <cql2rpn>../etc/pqf.properties</cql2rpn> <explain xmlns="http://explain.z3950.org/dtd/2.0/"> <serverInfo> <host>server2.mydomain</host> <port>9900</port> <database>a</database> </serverInfo> </explain> </server> <server id="server3" listenref="internal"> <directory>/var/www/s3</directory> <config>config.cfg</config> </server> </yazgfs> </pre> There are three configured backend servers. The first two servers, <code class="literal">"server1"</code> and <code class="literal">"server2"</code>, can be reached by both listener addresses. <code class="literal">"server1"</code> is reached by all (two) since no <code class="literal">listenref</code> attribute is specified. <code class="literal">"server2"</code> is reached by the two listeners specified. In order to distinguish between the two, a virtual host has been specified for each of server in the <code class="literal">host</code> elements. For <code class="literal">"server2"</code> elements for CQL to RPN conversion is supported and explain information has been added (a short one here to keep the example small). The third server, <code class="literal">"server3"</code> can only be reached via listener <code class="literal">"internal"</code>. </div><div class="refsect1"><a name="idp52021280"></a><h2>FILES</h2> <code class="filename">yaz-<version>/ztest/yaz-ztest.c</code> <code class="filename">yaz-<version>/include/yaz/backend.h</code> </div><div class="refsect1"><a name="idp52024064"></a><h2>SEE ALSO</h2> yaz(7) yaz-log(7) </div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="yaz-client.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="yaz-config.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">yaz-client�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�yaz-config</td></tr></table></div></body></html>