RM README

v0.09 Added installation instructions, improved error handling (all exceptions
generated after socket is established now produce
diagnostic messages), changed remote search so default when RM searched
is to search bibliographic DB
v0.08 (RDM 1.24, 24/05/03) Z39.50 client (supported record schemas usmarc;
supported record formats usmarc, xml); added database for single bibliographic
items populated by Z39.50 client search results; added requests to add and
search for bibliographic records; split method in util class made static (bug
6); included relevant jar files in lib directory; fixed field resolution in
openURL resolver (bug 7); fixed problem with client configuration where there is
no version number (bug 8)  
v0.07 (RDM 1.24, 14/05/03) Changed RDM url fields to text rather than 
varchar(300) types for MySQL compatibility (bug 4); fixed sample resource 
creation script (bug 5); changes required for jdom beta 9 compatibility; 
addition of schemas for XML validity checking; changes throughout to use 
namespaces in XML messages
v0.06 (RDM 1.23, 14/03/03) Renamed source files more consistently; fixed 
compatability problem with jdom beta 8 (bug 1); allow search queries containing both 
"/@" and "@" in paths; threaded remote search; set up diagnostic handler to use 
XML file for list of diagnostics; fixed problem with availability determination; 
added openURL client/server modules (latter not fully working); checked 
compatibility with current JDOM/xalan releases; initial DTDs for queries and 
responses
v0.05 (23/07/02) Improved XQuery parsing (queries now recursively dismantled;
adding handling of AND/OR queries) (note that this involves slight changes to
interface); get list of available resources request; get list of resource types
request
v0.041 (24/06/02) Fix bug so that adminstrative data correctly created when
there is no data in database entry for resource. (Not a full release.)
v0.04 (22/06/02) Allow retrieval of single resource by resource_id, search
resources by create/modify date, fix bug to return administrative data with
resource listing in search response. 
v0.03 (18/06/02) Searching/sorting by any resource text field, searching by
keyword, limiting maximum number of search results returned, starting return at
specified result, resource editing functionality (create/edit/delete resource),
permitting requests according to IP address of service, multiple line requests
understood; re-organised files to create uk.ac.angel/uk.ac.angel.rm packages
v0.02 (21/05/02) Optional filtering by group list/IP address to show resources
available to current user
v0.01 (15/05/02) First release, allows retrieval of subject listing, searching
by subject ID & term, initial letter of resource name and string in name,
results sorted by name

KNOWN BUGS

Format: Bug number (reporter, date; affected versions) - description

8 (SM, 20/05/03; v0.06-0.07) - inconsistency between saved keys and retrieval
keys for configuration for client protocols where there is no version number
7 (SM, 16/05/03; v0.07) - incorrect resolution of openURL field names by
resolver (fails to recognise appropriate parts of config file)
6 (SM, 14/05/03; v0.07) - split method gives error since non-static
5 (Boon Low, 10/04/03; v0.06) - Sample database creation script has errors in
resource table inserts - update to match newer RDM version
4 (Boon Low, 10/04/03; v0.01-0.06) - MySQL has a limit on the maximum length of
varchar fields below 300 characters - make all URL fields text type for
compatibility
3 (JP, 24/09/02; v0.05) - subjects which are not being used are expected to
disappear from the database; this doesn't seem to happen. Solution is to define
a new attribute in request - get RM to return either those which are being used
or all the ones in the database
2 (JP, 25/08/02; v0.02-0.05) - incorrect calculation of availability; location
available tag dependent on case used in database (if available is "y" not
available is returned).
1 (SG, 08/02; v0.01-0.05) - localhost not added to list of permitted hosts
when installed with JDOM beta 8; causes socket crash on access.

FEATURES FOR FUTURE RELEASES

Support for explain request
Improved logging

REQUIRED LIBRARIES

The Angel RM requires that the following .jar files are in the classpath of the
user running the socket service or in the command line used to call it:

a2j (if using Z39.50 client/server - distributed with jzkit)
JDOM - tested with beta 7 (0.01-0.06), beta 8 (0.06-0.07); beta 9 RC2 (0.07);
beta 8 required for 0.07; beta 9 required for 0.08 for schema compatibility
jzkit (if using Z39.50 client/server)
log4j.jar (if using Z39.50 server)
xalan - must be version 2.3 or later; tested with 2.3.1, 2.4.1
xerces.jar - required for version 0.06 onwards. Use the jar file in the appropriate JDOM
release

If using the openURL library, then the HTML tidy executable is required. (jtidy is too
buggy to use).