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
|
<html><head><meta charset="ISO-8859-1"><title>Chapter1.Introduction</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="index.html" title="YAZ User's Guide and Reference"><link rel="prev" href="index.html" title="YAZ User's Guide and Reference"><link rel="next" href="introduction.api.html" title="2.The API"></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">Chapter1.Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a></td><th width="60%" align="center"></th><td width="20%" align="right"><a accesskey="n" href="introduction.api.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="introduction"></a>Chapter1.Introduction</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="introduction.html#introduction.reading">1. Reading this Manual</a></span></dt><dt><span class="sect1"><a href="introduction.api.html">2. The API</a></span></dt></dl></div><p>
YAZ is a C/C++ library for information retrieval applications
using the Z39.50/SRU/Solr protocols for information retrieval.
</p><p>
Properties of YAZ:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
Complete
<a class="ulink" href="https://www.loc.gov/z3950/agency/" target="_top">Z39.50</a> version 3 support.
Amendments and Z39.50-2002 revision is supported.
</p></li><li class="listitem"><p>
Supports
<a class="ulink" href="https://www.loc.gov/standards/sru/" target="_top">SRU GET/POST/SOAP</a>
version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
</p></li><li class="listitem"><p>
Includes BER encoders/decoders for the
<a class="ulink" href="https://iso.org/standard/66170.html" target="_top">ISO ILL</a>
protocol.
</p></li><li class="listitem"><p>
Supports
<a class="ulink" href="https://solr.apache.org" target="_top">Apache Solr</a> Web Service version 1.4.x
(client side only)
</p></li><li class="listitem"><p>
Supports the following transports: BER over TCP/IP
(<a class="ulink" href="https://rfc-editor.org/info/rfc1729" target="_top">RFC1729</a>),
BER over Unix local socket, and
<a class="ulink" href="https://www.w3.org/Protocols/rfc2616/rfc2616.html" target="_top">HTTP 1.1</a>.
</p></li><li class="listitem"><p>
Secure Socket Layer support using
<a class="ulink" href="https://www.gnu.org/software/gnutls/" target="_top">GnuTLS</a>.
If enabled, YAZ uses HTTPS transport (for SOAP) or
"Secure BER" (for Z39.50).
</p></li><li class="listitem"><p>
Offers
<a class="ulink" href="https://zoom.z3950.org" target="_top">ZOOM</a> C API implementing
Z39.50, SRU and Solr Web Service.
</p></li><li class="listitem"><p>
The YAZ library offers a set of useful utilities
related to the protocols, such as MARC (ISO2709) parser,
CCL (ISO8777) parser,
<a class="ulink" href="https://www.loc.gov/standards/sru/cql/" target="_top">CQL</a>
parser, memory management routines, character set conversion.
</p></li><li class="listitem"><p>
Portable code. YAZ compiles out-of-the box on most Unixes and
on Windows using Microsoft Visual C++.
</p></li><li class="listitem"><p>
Fast operation. The C based BER encoders/decoders as well
as the server component of YAZ is very fast.
</p></li><li class="listitem"><p>
Liberal license that allows for commercial use of YAZ.
</p></li></ul></div><p>
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="introduction.reading"></a>1.Reading this Manual</h2></div></div></div><p>
Most implementors only need to read a fraction of the
material in this manual, so a quick walk-through of the chapters
is in order.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<a class="xref" href="installation.html" title="Chapter2.Compilation and Installation">Chapter2, <i>Compilation and Installation</i></a> contains installation
instructions for YAZ. You don't need to read this
if you expect to download YAZ binaries.
However, the chapter contains information about how
to make <span class="emphasis"><em>your</em></span> application link
with YAZ.
</p></li><li class="listitem"><p>
<a class="xref" href="zoom.html" title="Chapter3.ZOOM">Chapter3, <i>ZOOM</i></a> describes the ZOOM API of YAZ.
This is definitely worth reading if you wish to develop a Z39.50/SRU
client.
</p></li><li class="listitem"><p>
<a class="xref" href="server.html" title="Chapter4.Generic server">Chapter4, <i>Generic server</i></a> describes the generic front-end server
and explains how to develop server Z39.50/SRU applications for YAZ.
Obviously worth reading if you're to develop a server.
</p></li><li class="listitem"><p>
<a class="xref" href="yaz-client.html" title="yaz-client"><span class="refentrytitle">yaz-client</span>(1)</a> describes how to use the YAZ Z39.50
client. If you're a developer and wish to test your server
or a server from another party, you might find this chapter
useful.
</p></li><li class="listitem"><p>
<a class="xref" href="asn.html" title="Chapter5.The Z39.50 ASN.1 Module">Chapter5, <i>The Z39.50 ASN.1 Module</i></a> documents the most commonly used Z39.50
C data structures offered by the YAZ API. Client
developers using ZOOM and non-Z39.50 implementors may skip this.
</p></li><li class="listitem"><p>
<a class="xref" href="soap.html" title="Chapter6.SOAP and SRU">Chapter6, <i>SOAP and SRU</i></a> describes how SRU and SOAP is used
in YAZ. Only if you're developing SRU applications
this section is a must.
</p></li><li class="listitem"><p>
<a class="xref" href="tools.html" title="Chapter7.Supporting Tools">Chapter7, <i>Supporting Tools</i></a> contains sections for the various
tools offered by YAZ. Scan through the material quickly
and see what's relevant to you! SRU implementors
might find the <a class="link" href="tools.html#cql" title="1.3.CQL">CQL</a> section
particularly useful.
</p></li><li class="listitem"><p>
<a class="xref" href="odr.html" title="Chapter8.The ODR Module">Chapter8, <i>The ODR Module</i></a> goes through the details of the
ODR module which is the work horse that encodes and decodes
BER packages. Implementors using ZOOM only, do <span class="emphasis"><em>not</em></span>
need to read this.
Most other Z39.50 implementors only need to read the first two
sections (<a class="xref" href="odr.html#odr.introduction" title="1.Introduction">Section1, “Introduction”</a> and
<a class="xref" href="odr.use.html" title="2.Using ODR">Section2, “Using ODR”</a>).
</p></li><li class="listitem"><p>
<a class="xref" href="comstack.html" title="Chapter9.The COMSTACK Module">Chapter9, <i>The COMSTACK Module</i></a> describes the network layer module
COMSTACK. Implementors using ZOOM or the generic front-end server
may skip this. Others, presumably, handling client/server
communication on their own should read this.
</p></li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a></td><td width="20%" align="center"></td><td width="40%" align="right"><a accesskey="n" href="introduction.api.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">YAZ User's Guide and Reference</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">2.The API</td></tr></table></div></body></html>
|
