README

   1 YAZ proxy - A Z39.50/SRU proxy.
   2
   3 $Id: README,v 1.6 2006-06-14 10:12:23 adam Exp $
   4
   5 Introduction
   6 ------------
   7
   8 YAZ proxy is a powerful general purpose Z39.50/SRU proxy.
   9 The proxy application and development library is covered by the
  10 GPL - see LICENSE for details.
  11
  12 Documentation
  13 -------------
  14
  15 The "doc" directory contains documentation in HTML and PDF.
  16 You can also read it online at http://www.indexdata.dk/yazproxy/
  17
  18 Overview
  19 --------
  20
  21 YAZ proxy builds a programmers' library libyazproxy.lib and a
  22 proxy application.
  23
  24 Directory structure of the YAZ++ package:
  25
  26   -- src (YAZ proxy library and application)
  27   -- include/yazproxy (C++ headers for proxy)
  28   -- win (Windows build files)
  29   -- doc (DocBook-format documentation)
  30   -- etc (Proxy config + XSLT files)
  31
  32 About the proxy
  33 ---------------
  34
  35 For the proxy the actual target is determined in by the OtherInfo
  36 part of the InitRequest. We've defined an OID for this which we call
  37 PROXY. The OID is 1.2.840.10003.10.1000.81.1.
  38
  39   OtherInformation   ::= [201] IMPLICIT SEQUENCE OF SEQUENCE{
  40     category           [1]   IMPLICIT InfoCategory OPTIONAL,
  41     information        CHOICE{
  42       characterInfo            [2]  IMPLICIT InternationalString,
  43       binaryInfo               [3]  IMPLICIT OCTET STRING,
  44       externallyDefinedInfo    [4]  IMPLICIT EXTERNAL,
  45       oid                      [5]  IMPLICIT OBJECT IDENTIFIER}}
  46 --
  47   InfoCategory ::= SEQUENCE{
  48       categoryTypeId   [1]   IMPLICIT OBJECT IDENTIFIER OPTIONAL,
  49       categoryValue    [2]   IMPLICIT INTEGER}
  50
  51 The InfoCategory is present with categoryTypeId set to the PROXY OID
  52 and categoryValue set to 1. The information in OtherInformation uses
  53 characterInfo to represent the target using the form target[:port][/db].
  54
  55 For clients that don't set the PROXY OtherInformation, a default
  56 target can be specified using option -t for proxy.
  57
  58 Example:
  59   We start the proxy so that it listens on port 9000. The default
  60   target is Bell Labs Library unless it is overridden by a client in
  61   the InitRequest.
  62
  63      $ ./yaz-proxy -t z3950.bell-labs.com/books @:9000
  64
  65   The client is started and talks to the proxy without specifying
  66   a target. Hence this client will talk to the Bell Labs server.
  67
  68      $ ./yaz-client localhost:9000
  69
  70   The client is started and it specifies the actual target itself.
  71
  72      $ ./yaz-client -p localhost:9000 bagel.indexdata.dk/gils
  73
  74   For ZAP the equivalent would be
  75      proxy=localhost:9000
  76      target=bagel.indexdata.dk/gils
  77   Simple, huh!
  78