File: yaz-ztest.html

package info (click to toggle)
yaz 3.0.34-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 13,404 kB
  • ctags: 12,108
  • sloc: xml: 116,075; ansic: 52,205; sh: 9,746; tcl: 2,043; makefile: 1,141; yacc: 347
file content (279 lines) | stat: -rw-r--r-- 20,158 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<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.73.2"><link rel="start" 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" lang="en"><a name="yaz-ztest"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>yaz-ztest &#8212; Z39.50 Test Server</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">application</code>  [<code class="option">-install</code>] [<code class="option">-installa</code>] [<code class="option">-remove</code>] [<code class="option">-a <em class="replaceable"><code>file</code></em></code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">-l <em class="replaceable"><code>file</code></em></code>] [<code class="option">-u <em class="replaceable"><code>uid</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config</code></em></code>] [<code class="option">-f <em class="replaceable"><code>vconfig</code></em></code>] [<code class="option">-C <em class="replaceable"><code>fname</code></em></code>] [<code class="option">-t <em class="replaceable"><code>minutes</code></em></code>] [<code class="option">-k <em class="replaceable"><code>kilobytes</code></em></code>] [<code class="option">-d <em class="replaceable"><code>daemon</code></em></code>] [<code class="option">-w <em class="replaceable"><code>dir</code></em></code>] [<code class="option">-p <em class="replaceable"><code>pidfile</code></em></code>] [<code class="option">-r <em class="replaceable"><code>kilobytes</code></em></code>] [<code class="option">-ziDST1</code>] [listener-spec...]</p></div></div><div class="refsect1" lang="en"><a name="id2601767"></a><h2>DESCRIPTION</h2><p>
   <span class="command"><strong>yaz-ztest</strong></span> is a Z39.50 test server that uses
   the YAZ generic frontend server API.
   The server acts as a real Z39.50 server but does not use a database.
   It returns a random hit count and returns a subset of a few built-in
   records.
  </p><p>
   The <em class="replaceable"><code>listener-spec</code></em> 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>.
  </p><p>
   For TCP and SSL, an address has the form:
   </p><pre class="screen">
    hostname | IP-number [ : portnumber ]
   </pre><p>
  </p><p>
   For UNIX local socket the address is the filename of the local socket.
  </p></div><div class="refsect1" lang="en"><a name="id2601834"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term"><code class="literal">-a </code>
   <em class="replaceable"><code>file</code></em></span></dt><dd><p>
    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>.
   </p></dd><dt><span class="term"><code class="literal">-S</code></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-1</code></span></dt><dd><p>
    Like <code class="literal">-S</code> but after one session the server
    exits. This mode is for debugging <span class="emphasis"><em>only</em></span>.
   </p></dd><dt><span class="term"><code class="literal">-T</code></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-s</code></span></dt><dd><p>
    Use the SR protocol (obsolete).
   </p></dd><dt><span class="term"><code class="literal">-z</code></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-l </code>
   <em class="replaceable"><code>file</code></em></span></dt><dd><p>The logfile.
   </p></dd><dt><span class="term"><code class="literal">-c </code>
   <em class="replaceable"><code>config</code></em></span></dt><dd><p>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>.
   </p></dd><dt><span class="term"><code class="literal">-f </code>
   <em class="replaceable"><code>vconfig</code></em></span></dt><dd><p>This specifies an XML file that describes
    one or more YAZ frontend virtual servers.
   </p></dd><dt><span class="term"><code class="literal">-C </code>
   <em class="replaceable"><code>fname</code></em></span></dt><dd><p>Sets SSL certificate file name for server (PEM).
   </p></dd><dt><span class="term"><code class="literal">-v </code>
   <em class="replaceable"><code>level</code></em></span></dt><dd><p>
    The log level. Use a comma-separated list of members of the set
    {fatal,debug,warn,log,malloc,all,none}.
   </p></dd><dt><span class="term"><code class="literal">-u </code>
   <em class="replaceable"><code>uid</code></em></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-w </code>
   <em class="replaceable"><code>dir</code></em></span></dt><dd><p>
    The server changes to this directory during before listening 
    on incoming connections. This option is useful
    when the server is operating from the <span class="application">inetd</span>
    daemon (see <code class="literal">-i</code>).
   </p></dd><dt><span class="term"><code class="literal">-p </code>
   <em class="replaceable"><code>pidfile</code></em></span></dt><dd><p>
    Specifies that the server should write its Process ID to
    file given by <em class="replaceable"><code>pidfile</code></em>. 
    A typical location would be <code class="filename">/var/run/yaz-ztest.pid</code>.
   </p></dd><dt><span class="term"><code class="literal">-i</code></span></dt><dd><p>
    Use this to make the the server run from the
    <span class="application">inetd</span> server (UNIX only).
   </p></dd><dt><span class="term"><code class="literal">-D</code></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-install</code></span></dt><dd><p>
    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.
   </p></dd><dt><span class="term"><code class="literal">-installa</code></span></dt><dd><p>
    Use this to install and activate the server as an NT service
    (Windows NT/2000/XP only). 
    Control the server by going to the Services in the Control Panel.
   </p></dd><dt><span class="term"><code class="literal">-remove</code></span></dt><dd><p>
    Use this to remove the server from the NT services
    (Windows NT/2000/XP only). 
   </p></dd><dt><span class="term"><code class="literal">-t </code>
   <em class="replaceable"><code>minutes</code></em></span></dt><dd><p>
    Idle session timeout, in minutes.
   </p></dd><dt><span class="term"><code class="literal">-k </code>
   <em class="replaceable"><code>size</code></em></span></dt><dd><p>
    Maximum record size/message size, in kilobytes.
   </p></dd><dt><span class="term"><code class="literal">-r </code>
   <em class="replaceable"><code>size</code></em></span></dt><dd><p>
    Maximum size of log file before rotation occurs, in kilobytes.
    Default size is 1048576 k (=1 GB).
   </p></dd><dt><span class="term"><code class="literal">-d </code>
   <em class="replaceable"><code>daemon</code></em></span></dt><dd><p>
    Set name of daemon to be used in hosts access file.
    See
    <span class="citerefentry"><span class="refentrytitle">hosts_access</span>(5)</span>
    and 
    <span class="citerefentry"><span class="refentrytitle">tcpd</span>(8)</span>.
   </p></dd><dt><span class="term"><code class="literal">-m </code>
   <em class="replaceable"><code>time-format</code></em></span></dt><dd><p>
   Sets the format of time-stamps in the log-file. Specify a string in
   the input format to <code class="literal">strftime()</code>.
   </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2602481"></a><h2>GFS CONFIGURATION AND VIRTUAL HOSTS</h2><p>
 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.
</p><p>
 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.
</p><p>
 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.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
  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).
 </p></div><p>
 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.
</p><p>
 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.
</p><p>
 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:
 </p><div class="variablelist"><dl><dt><span class="term">CDATA (required)</span></dt><dd><p>
     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.
    </p></dd><dt><span class="term">attribute <code class="literal">id</code> (optional)</span></dt><dd><p>
      identifier for this listener. This may be referred to from
      server sections.
     </p></dd></dl></div><p>
 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
   We expect more information to be added for the listen section in
   a future version, such as CERT file for SSL servers.
  </p></div><p>
</p><p>
 The <code class="literal">server</code> describes a server and the parameters
 for this server type. Content for a server:
 </p><div class="variablelist"><dl><dt><span class="term">attribute <code class="literal">id</code> (optional)</span></dt><dd><p>
     Identifier for this server. Currently not used for anything,
     but it might be for logging purposes.
   </p></dd><dt><span class="term">attribute <code class="literal">listenref</code> (optional)</span></dt><dd><p>
     Specifies listener for this server. If this attribute is not
     given, the server is accessible from all listener. In order
     for the server to be used for real, howeever, the virtual host
     must match (if specified in the configuration).
    </p></dd><dt><span class="term">element <code class="literal">config</code> (optional)</span></dt><dd><p>
     Specifies the server configuration. This is equivalent
     to the config specified using command line option
     <code class="literal">-c</code>.
    </p></dd><dt><span class="term">element <code class="literal">directory</code> (optional)</span></dt><dd><p>
     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).
    </p></dd><dt><span class="term">element <code class="literal">host</code> (optional)</span></dt><dd><p>
     Specifies the virtual host for this server. If this is specified
     a client <span class="emphasis"><em>must</em></span> specify this host string in
     order to use this backend.
    </p></dd><dt><span class="term">element <code class="literal">cql2rpn</code> (optional)</span></dt><dd><p>
     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, &#8220;Specification of CQL to RPN mappings&#8221;</a>
     If given, the backend server will only "see" a Type-1/RPN query. 
    </p></dd><dt><span class="term">element <code class="literal">ccl2rpn</code> (optional)</span></dt><dd><p>
     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, &#8220;CCL Qualifiers&#8221;</a>
     If given, the backend server will only "see" a Type-1/RPN query. 
    </p></dd><dt><span class="term">element <code class="literal">stylesheet</code> (optional)</span></dt><dd><p>
     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.
    </p></dd><dt><span class="term">element <code class="literal">docpath</code> (optional)</span></dt><dd><p>
     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.
    </p></dd><dt><span class="term">element <code class="literal">explain</code> (optional)</span></dt><dd><p>
     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.
    </p></dd><dt><span class="term">element <code class="literal">maximumrecordsize</code> (optional)</span></dt><dd><p>
     Specifies maximum record size/message size, in bytes. This
     value also servers as maximum size of <span class="emphasis"><em>incoming</em></span>
     packages (for Record Updates etc). It's the same value as that
     given by the <code class="literal">-k</code> option.
    </p></dd><dt><span class="term">element <code class="literal">retrievalinfo</code> (optional)</span></dt><dd><p>
     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, &#8220;Retrieval Facility&#8221;</a> for
     more information.
    </p></dd></dl></div><p>
</p><p>
 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>.
 </p><pre class="screen">
  
 &lt;yazgfs&gt;
  &lt;listen id="public"&gt;tcp:@:9900&lt;/listen&gt;
  &lt;listen id="internal"&gt;unix:/var/tmp/socket&lt;/listen&gt;
  &lt;server id="server1"&gt;
    &lt;host&gt;server1.mydomain&lt;/host&gt;
    &lt;directory&gt;/var/www/s1&lt;/directory&gt;
    &lt;config&gt;config.cfg&lt;/config&gt;
  &lt;/server&gt;
  &lt;server id="server2"&gt;
    &lt;host&gt;server2.mydomain&lt;/host&gt;
    &lt;directory&gt;/var/www/s2&lt;/directory&gt;
    &lt;config&gt;config.cfg&lt;/config&gt;
    &lt;cql2rpn&gt;../etc/pqf.properties&lt;/cql2rpn&gt;
    &lt;explain xmlns="http://explain.z3950.org/dtd/2.0/"&gt;
      &lt;serverInfo&gt;
        &lt;host&gt;server2.mydomain&lt;/host&gt;
        &lt;port&gt;9900&lt;/port&gt;
        &lt;database&gt;a&lt;/database&gt;
      &lt;/serverInfo&gt;
    &lt;/explain&gt;
  &lt;/server&gt;
  &lt;server id="server3" listenref="internal"&gt;
    &lt;directory&gt;/var/www/s3&lt;/directory&gt;
    &lt;config&gt;config.cfg&lt;/config&gt;
  &lt;/server&gt;
 &lt;/yazgfs&gt;

 </pre><p>
 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 - since
 no <code class="literal">listenref</code> attribute is 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.
</p><p>
 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).
</p><p>
 The third server, <code class="literal">"server3"</code> can only be reached
 via listener <code class="literal">"internal"</code>.
</p></div><div class="refsect1" lang="en"><a name="id2603065"></a><h2>FILES</h2><p>
   <code class="filename">yaz-&lt;version&gt;/ztest/yaz-ztest.c</code>
  </p><p>
   <code class="filename">yaz-&lt;version&gt;/include/yaz/backend.h</code>
  </p></div><div class="refsect1" lang="en"><a name="id2603095"></a><h2>SEE ALSO</h2><p>
   <span class="citerefentry"><span class="refentrytitle">yaz</span>(7)</span>
   <span class="citerefentry"><span class="refentrytitle">yaz-log</span>(7)</span>
  </p></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>