Class oclc.z39.Z39api
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class oclc.z39.Z39api

java.lang.Object
   |
   +----oclc.z39.Z39api

public class Z39api
extends Object

The Z39 Client API Software presented here is a translation of the C version of the API written by Ralph Levan at OCLC. The documentation presented here is pretty much taken from his documentation.

A description of our fourth version of the Z39.50 Client API is below. It will, of course, undergo some refinement with use and get extended to support new Z39.50 functionality as required. The changes from the fourth version include support for type-101 queries (including proximity operators in the Client APIs query grammer) and the removal of some unneeded parameters in the request calls. Scan was brought into compliance with the final version of the 95 standard. In addition, a number of changes were made to simplify things and to bring the Client API into compliance with the article that was written about it. (See the section on availability at the end of this document.)

The change from the third version is the addition of support for piggybacked Presents with the SearchRequest. This means that there is now an optional PRESENT_RESPONSE object in the SEARCH_RESPONSE object.

The changes from the second version are the addition of support for a simple userid and password on the InitRequest; support for full boolean queries in the SearchRequest; support for both MARC and SUTRS record syntaxes in the PresentRequest. A class to support Scan has been added. It is in an early stage of development and will definitely be enhanced with experience. Finally, a new method, logging(), provides support for run-time diagnostic logging.


High-level description
The classes process IRP messages, they do not send or receive these messages; that is up to the calling routines. (IRP stands for Information Retrieval Protocol, which is the name of the protocol described by Z39.50.) An IRP Request method is called and it produces a BER (Basic Encoding Rules, the chosen transfer syntax for ASN.1) record that can be sent to a Z39.50 target. Conversely, a BER record containing an IRP response is processed and instance variables in an object are filled in with values from the response. The BER records are encoded and decoded using OCLC's BER utilities. These utilities are available via anonymous ftp to ftp.rsch.oclc.org and are in the pub/BER_utilities directory. They are available in either a C version (as source) or a Java version (as class files).

There are two layers to the IRP response methods. The layer you choose to use will depend on coding style and application complexity. The lower layer, consisting of Response() methods in the Z39init, Z39present, Z39search and Z39scan classes, are invoked directly with the Z39.50 target's response to an Init, Search, Present or Scan request. These methods fill in instance variables with the various parameters in the response. They are appropriate when the application (the Z39.50 origin) is relatively simple and "knows" what kind of response it is receiving. This is usually a single user application.

In more complex applications, it is difficult to know what kind of response has arrived. The next layer addresses this problem. The class Z39response will determine the type of response and invoke the appropriate class to process the response. The type is stored in an instance variable in the Z39response object. An object of the appropriate type is also availabe in the Z39response object.

In the descriptions of the methods, I will not discuss the meaning of the various parameters to the request methods. They are fully described in the Z39.50 standard.

In all the request methods, a long referenceId is provided. The value in the referenceId is in an instance variable filled in by the response routines. In complex applications, we have found that it is a useful place to put a reference to an object containing information about the request that has just been processed. Doing this has allowed us to build relatively stateless applications.

The BER record that is created by the request methods is put into a BerString object. The BER record can totally fill the buffer in the BerString object (the default action) or it can leave space for a header and trailer. The caller can then move communications headers and/or trailers into the extra space.


Availability

An article about building Z39.50 clients, which includes a detailed description of the Client API, was written for the Z39.50 Implementors Group. It is available via anonymous ftp at the Z39.50 Maintenance Agencys ftp site at ftp.loc.gov. You're on your own for finding it there.

The article will also be published by the National Institute for Standards and Technology (NIST) as part of a Z39.50 monograph. Good luck finding that too.

Finally, the article is available via anonymous ftp at ftp.rsch.oclc.org in the pub/SiteSearch/z39.50_client_api directory. It is available in several formats, the names of which all begin with zclient.

The OCLC ftp site also provides the .class files for the Z39.50 Client API and a simple client application (zclient.java), which are in the pub/SiteSearch/java directory, as well as the BER utilities which are in the pub/BER_utilities/java directory.


Examples

Java source for 2 examples is provided. The example.java is a Java application that does an Init, Scan, Search and Present. The zapplet.java is a Java applet that does an Init, Scan, Search and Present. The html file for zapplet.java is zapplet.html.

Version:
@(#)Z39api.java 1.7 06/27/96
Author:
Jenny Colvard
See Also:
zclient, example, zapplet, Z39init, Z39present, Z39search, Z39scan, Z39response

Variable Index

 o logfile
File for logging output.
 o logit
Flag for logging.
 o MARC_SYNTAX
A record syntax; see the Z39.50 specification.
 o notAllRequestedResultSetsDeleted
deleteResultSet status; see Z39.50 specification.
 o notAllRsltSetsDeletedOnBulkDlte
deleteResultSet status; see Z39.50 specification.
 o nSearches
Number of searches this object has done.
 o OCLC_BER_SYNTAX
A record syntax; see the Z39.50 specification.
 o OCLC_USERINFORMATION_1
ObjectIdentifier of OCLC's UserInformationField.
 o OPAC_SYNTAX
A record syntax; see the Z39.50 specification.
 o operator
Known operators for searching.
 o resultSetDidNotExist
deleteResultSet status; see Z39.50 specification.
 o ResultSetNames
Names of results sets for each search done by this class.
 o SIMPLETEXT_SYNTAX
A record syntax; see the Z39.50 specification.
 o z3950_accessControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_accessControlResponse
A PDU name; see the Z39.50 specification.
 o z3950_and
Query parameter for Search request; see Z39.50 specification.
 o z3950_and_not
Query parameter for Search request; see Z39.50 specification.
 o z3950_AttributeList
Search/Present paramter; see Z39.50 specification.
 o z3950_attributes
Scan parameter; see Z39.50 specification.
 o z3950_AttributesPlusTerm
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributeType
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributeValue
Search/Present paramter; see Z39.50 specification.
 o z3950_BadAuthoPassword
Return code for authorization on Init.
 o z3950_BillingGroup
An Init parameter; see the Z39.50 specification.
 o z3950_BlockedIPAddress
Return code for authorization on Init.
 o z3950_byAttributes
Scan parameter; see Z39.50 specification.
 o z3950_byte
Proximity unit code; see Z39.50 specification.
 o z3950_chapter
Proximity unit code; see Z39.50 specification.
 o z3950_character
Proximity unit code; see Z39.50 specification.
 o z3950_databaseId
Scan parameter; see Z39.50 specification.
 o z3950_DatabaseName
Search/Present paramter; see Z39.50 specification.
 o z3950_databaseNames
Search/Present paramter; see Z39.50 specification.
 o z3950_dataBaseOrSurDiagnostics
Search/Present paramter; see Z39.50 specification.
 o z3950_databaseRecord
Search/Present paramter; see Z39.50 specification.
 o z3950_deleteFunction
deleteResultSet parameter; see Z39.50 specification.
 o z3950_deleteOperationStatus
deleteResultSet parameter; see Z39.50 specification.
 o z3950_deleteResultSetRequest
A PDU name; see the Z39.50 specification.
 o z3950_deleteResultSetResponse
A PDU name; see the Z39.50 specification.
 o z3950_DiagBib1Databaseunavailable
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1ESExecutionFailed
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1EStypeNotSupported
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1Malformedquery
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1Malformedscan
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1NoResultSet
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1UnsupportedTruncationAttribute
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagnosticFormataddMsg
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatcondition
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatspecified
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatunspecified
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_displayTerm
Scan parameter; see Z39.50 specification.
 o z3950_distance
prox parameter; see Z39.50 specification.
 o z3950_document
Proximity unit code; see Z39.50 specification.
 o z3950_element
Proximity unit code; see Z39.50 specification.
 o z3950_ElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_elementType
Proximity unit code; see Z39.50 specification.
 o z3950_entries
Scan parameter; see Z39.50 specification.
 o z3950_equal
prox relationship parameter; see Z39.50 specification.
 o z3950_exclusion
prox parameter; see Z39.50 specification.
 o z3950_extendedservicesRequest
A PDU name; see the Z39.50 specification.
 o z3950_extendedservicesResponse
A PDU name; see the Z39.50 specification.
 o z3950_failure
Present status; see Z39.50 specification.
 o z3950_globalOccurrences
Scan parameter; see Z39.50 specification.
 o z3950_greaterThan
prox relationship parameter; see Z39.50 specification.
 o z3950_greaterThanOrEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_groupId
An Init parameter; see the Z39.50 specification.
 o z3950_idAuthentication
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationId
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationName
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationVersion
An Init parameter; see the Z39.50 specification.
 o z3950_IncorrectInterfaceType
Return code for authorization on Init.
 o z3950_InitFailureCode
An Init parameter; see the Z39.50 specification.
 o z3950_InitFailureMsg
An Init parameter; see the Z39.50 specification.
 o z3950_InitFailureReason
An Init parameter; see the Z39.50 specification.
 o z3950_initRequest
A PDU name; see the Z39.50 specification.
 o z3950_initResponse
A PDU name; see the Z39.50 specification.
 o z3950_interim
Search status; see Z39.50 specification.
 o z3950_InvalidAutho
Return code for authorization on Init.
 o z3950_known
prox relationship parameter; see Z39.50 specification.
 o z3950_largeSetLowerBound
Search/Present paramter; see Z39.50 specification.
 o z3950_lessThan
prox relationship parameter; see Z39.50 specification.
 o z3950_lessThanOrEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_Listentries
Scan parameter; see Z39.50 specification.
 o z3950_MasterAuthorization
An Init parameter; see the Z39.50 specification.
 o z3950_MaximumRecordSize
An Init parameter; see the Z39.50 specification.
 o z3950_MaxNumberSimultaneousUsers
Return code for authorization on Init.
 o z3950_mediumSetElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_mediumSetPresentNumber
Search/Present paramter; see Z39.50 specification.
 o z3950_MultipleNonSurrogates
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_newPassword
An Init parameter; see the Z39.50 specification.
 o z3950_NextResultSetPosition
Search/Present paramter; see Z39.50 specification.
 o z3950_none
Search status; see Z39.50 specification.
 o z3950_nonSurrogateDiagnostic
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_nonsurrogateDiagnostics
Scan parameter; see Z39.50 specification.
 o z3950_NoSearchesRemaining
Return code for authorization on Init.
 o z3950_notEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_numberOfEntriesReturned
Scan parameter; see Z39.50 specification.
 o z3950_numberOfRecordsRequested
Search/Present paramter; see Z39.50 specification.
 o z3950_NumberOfRecordsReturned
Search/Present paramter; see Z39.50 specification.
 o z3950_numberOfTermsRequested
Scan parameter; see Z39.50 specification.
 o z3950_Operand
Query parameter for Search request; see Z39.50 specification.
 o z3950_Operator
Search/Present paramter; see Z39.50 specification.
 o z3950_Options
An Init parameter; see the Z39.50 specification.
 o z3950_or
Query parameter for Search request; see Z39.50 specification.
 o z3950_ordered
prox parameter; see Z39.50 specification.
 o z3950_paragraph
Proximity unit code; see Z39.50 specification.
 o z3950_partial_1
Present status; see Z39.50 specification.
 o z3950_partial_2
Present status; see Z39.50 specification.
 o z3950_partial_3
Present status; see Z39.50 specification.
 o z3950_partial_4
Present status; see Z39.50 specification.
 o z3950_password
An Init parameter; see the Z39.50 specification.
 o z3950_positionOfTerm
Scan parameter; see Z39.50 specification.
 o z3950_PreAuthorized
An Init parameter; see the Z39.50 specification.
 o z3950_PreferredMessageSize
An Init parameter; see the Z39.50 specification.
 o z3950_preferredPositionInResponse
Scan parameter; see Z39.50 specification.
 o z3950_PreferredRecordSyntax
Search/Present paramter; see Z39.50 specification.
 o z3950_presentRequest
A PDU name; see the Z39.50 specification.
 o z3950_presentResponse
A PDU name; see the Z39.50 specification.
 o z3950_PresentStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_private
prox relationship parameter; see Z39.50 specification.
 o z3950_ProtocolVersion
An Init parameter; see the Z39.50 specification.
 o z3950_prox
Query parameter for Search request; see Z39.50 specification.
 o z3950_proximityUnitCode
prox parameter; see Z39.50 specification.
 o z3950_Query
Query parameter for Search request; see Z39.50 specification.
 o z3950_query
Search/Present paramter; see Z39.50 specification.
 o z3950_ReferenceId
An Init parameter; see the Z39.50 specification.
 o z3950_relationType
prox parameter; see Z39.50 specification.
 o z3950_replaceIndicator
Search/Present paramter; see Z39.50 specification.
 o z3950_resourceControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_resourceControlResponse
A PDU name; see the Z39.50 specification.
 o z3950_resourceReportRequest
A PDU name; see the Z39.50 specification.
 o z3950_resourceReportResponse
A PDU name; see the Z39.50 specification.
 o z3950_result
An Init parameter; see the Z39.50 specification.
 o z3950_resultCount
Search/Present paramter; see Z39.50 specification.
 o z3950_ResultSetId
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetName
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetStartPoint
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_scan_status_failure
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_1
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_2
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_3
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_4
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_5
Scan status; see Z39.50 specification.
 o z3950_scan_status_success
Scan status; see Z39.50 specification.
 o z3950_scanRequest
A PDU name; see the Z39.50 specification.
 o z3950_scanResponse
A PDU name; see the Z39.50 specification.
 o z3950_scanStatus
Scan parameter; see Z39.50 specification.
 o z3950_searchRequest
A PDU name; see the Z39.50 specification.
 o z3950_searchResponse
A PDU name; see the Z39.50 specification.
 o z3950_searchStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_section
Proximity unit code; see Z39.50 specification.
 o z3950_sentence
Proximity unit code; see Z39.50 specification.
 o z3950_smallSetElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_smallSetUpperBound
Search/Present paramter; see Z39.50 specification.
 o z3950_stepSize
Scan parameter; see Z39.50 specification.
 o z3950_subelement
Proximity unit code; see Z39.50 specification.
 o z3950_subset
Search status; see Z39.50 specification.
 o z3950_success
Present status; see Z39.50 specification.
 o z3950_surrogateDiagnostic
Search/Present paramter; see Z39.50 specification.
 o z3950_Term
Search/Present paramter; see Z39.50 specification.
 o z3950_term
Scan parameter; see Z39.50 specification.
 o z3950_termInfo
Scan parameter; see Z39.50 specification.
 o z3950_termListAndStartPoint
Scan parameter; see Z39.50 specification.
 o z3950_triggerResourceControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_type_0
Query type for Search request; see Z39.50 specification.
 o z3950_type_1
Query type for Search request; see Z39.50 specification.
 o z3950_type_100
Query type for Search request; see Z39.50 specification.
 o z3950_type_101
Query type for Search request; see Z39.50 specification.
 o z3950_type_2
Query type for Search request; see Z39.50 specification.
 o z3950_UniversalID
An Init parameter; see the Z39.50 specification.
 o z3950_userId
An Init parameter; see the Z39.50 specification.
 o z3950_UserInformationField
An Init parameter; see the Z39.50 specification.
 o z3950_word
Proximity unit code; see Z39.50 specification.

Constructor Index

 o Z39api()

Method Index

 o logging(int)
Enable and disable run-time diagnostics.

Variables

 o OPAC_SYNTAX
  public final static String OPAC_SYNTAX
A record syntax; see the Z39.50 specification.
 o OCLC_BER_SYNTAX
  public final static String OCLC_BER_SYNTAX
A record syntax; see the Z39.50 specification.
 o MARC_SYNTAX
  public final static String MARC_SYNTAX
A record syntax; see the Z39.50 specification.
 o SIMPLETEXT_SYNTAX
  public final static String SIMPLETEXT_SYNTAX
A record syntax; see the Z39.50 specification.
 o OCLC_USERINFORMATION_1
  public final static String OCLC_USERINFORMATION_1
ObjectIdentifier of OCLC's UserInformationField.
 o z3950_initRequest
  public final static int z3950_initRequest
A PDU name; see the Z39.50 specification.
 o z3950_initResponse
  public final static int z3950_initResponse
A PDU name; see the Z39.50 specification.
 o z3950_searchRequest
  public final static int z3950_searchRequest
A PDU name; see the Z39.50 specification.
 o z3950_searchResponse
  public final static int z3950_searchResponse
A PDU name; see the Z39.50 specification.
 o z3950_presentRequest
  public final static int z3950_presentRequest
A PDU name; see the Z39.50 specification.
 o z3950_presentResponse
  public final static int z3950_presentResponse
A PDU name; see the Z39.50 specification.
 o z3950_deleteResultSetRequest
  public final static int z3950_deleteResultSetRequest
A PDU name; see the Z39.50 specification.
 o z3950_deleteResultSetResponse
  public final static int z3950_deleteResultSetResponse
A PDU name; see the Z39.50 specification.
 o z3950_accessControlRequest
  public final static int z3950_accessControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_accessControlResponse
  public final static int z3950_accessControlResponse
A PDU name; see the Z39.50 specification.
 o z3950_resourceControlRequest
  public final static int z3950_resourceControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_resourceControlResponse
  public final static int z3950_resourceControlResponse
A PDU name; see the Z39.50 specification.
 o z3950_triggerResourceControlRequest
  public final static int z3950_triggerResourceControlRequest
A PDU name; see the Z39.50 specification.
 o z3950_resourceReportRequest
  public final static int z3950_resourceReportRequest
A PDU name; see the Z39.50 specification.
 o z3950_resourceReportResponse
  public final static int z3950_resourceReportResponse
A PDU name; see the Z39.50 specification.
 o z3950_scanRequest
  public final static int z3950_scanRequest
A PDU name; see the Z39.50 specification.
 o z3950_scanResponse
  public final static int z3950_scanResponse
A PDU name; see the Z39.50 specification.
 o z3950_extendedservicesRequest
  public final static int z3950_extendedservicesRequest
A PDU name; see the Z39.50 specification.
 o z3950_extendedservicesResponse
  public final static int z3950_extendedservicesResponse
A PDU name; see the Z39.50 specification.
 o z3950_groupId
  public final static int z3950_groupId
An Init parameter; see the Z39.50 specification.
 o z3950_userId
  public final static int z3950_userId
An Init parameter; see the Z39.50 specification.
 o z3950_password
  public final static int z3950_password
An Init parameter; see the Z39.50 specification.
 o z3950_ReferenceId
  public final static int z3950_ReferenceId
An Init parameter; see the Z39.50 specification.
 o z3950_newPassword
  public final static int z3950_newPassword
An Init parameter; see the Z39.50 specification.
 o z3950_ProtocolVersion
  public final static int z3950_ProtocolVersion
An Init parameter; see the Z39.50 specification.
 o z3950_Options
  public final static int z3950_Options
An Init parameter; see the Z39.50 specification.
 o z3950_PreferredMessageSize
  public final static int z3950_PreferredMessageSize
An Init parameter; see the Z39.50 specification.
 o z3950_MaximumRecordSize
  public final static int z3950_MaximumRecordSize
An Init parameter; see the Z39.50 specification.
 o z3950_idAuthentication
  public final static int z3950_idAuthentication
An Init parameter; see the Z39.50 specification.
 o z3950_UserInformationField
  public final static int z3950_UserInformationField
An Init parameter; see the Z39.50 specification.
 o z3950_result
  public final static int z3950_result
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationId
  public final static int z3950_ImplementationId
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationName
  public final static int z3950_ImplementationName
An Init parameter; see the Z39.50 specification.
 o z3950_ImplementationVersion
  public final static int z3950_ImplementationVersion
An Init parameter; see the Z39.50 specification.
 o z3950_InitFailureReason
  public final static int z3950_InitFailureReason
An Init parameter; see the Z39.50 specification.
 o z3950_InitFailureCode
  public final static int z3950_InitFailureCode
An Init parameter; see the Z39.50 specification.
 o z3950_InitFailureMsg
  public final static int z3950_InitFailureMsg
An Init parameter; see the Z39.50 specification.
 o z3950_PreAuthorized
  public final static int z3950_PreAuthorized
An Init parameter; see the Z39.50 specification. OCLC only tag for user information field.
 o z3950_MasterAuthorization
  public final static int z3950_MasterAuthorization
An Init parameter; see the Z39.50 specification. OCLC only tag for user information field.
 o z3950_BillingGroup
  public final static int z3950_BillingGroup
An Init parameter; see the Z39.50 specification. OCLC only tag for user information field.
 o z3950_UniversalID
  public final static int z3950_UniversalID
An Init parameter; see the Z39.50 specification. OCLC only tag for user information field.
 o z3950_InvalidAutho
  public final static int z3950_InvalidAutho
Return code for authorization on Init.
 o z3950_BadAuthoPassword
  public final static int z3950_BadAuthoPassword
Return code for authorization on Init.
 o z3950_NoSearchesRemaining
  public final static int z3950_NoSearchesRemaining
Return code for authorization on Init.
 o z3950_IncorrectInterfaceType
  public final static int z3950_IncorrectInterfaceType
Return code for authorization on Init.
 o z3950_MaxNumberSimultaneousUsers
  public final static int z3950_MaxNumberSimultaneousUsers
Return code for authorization on Init.
 o z3950_BlockedIPAddress
  public final static int z3950_BlockedIPAddress
Return code for authorization on Init.
 o z3950_databaseRecord
  public final static int z3950_databaseRecord
Search/Present paramter; see Z39.50 specification.
 o z3950_surrogateDiagnostic
  public final static int z3950_surrogateDiagnostic
Search/Present paramter; see Z39.50 specification.
 o z3950_smallSetUpperBound
  public final static int z3950_smallSetUpperBound
Search/Present paramter; see Z39.50 specification.
 o z3950_largeSetLowerBound
  public final static int z3950_largeSetLowerBound
Search/Present paramter; see Z39.50 specification.
 o z3950_mediumSetPresentNumber
  public final static int z3950_mediumSetPresentNumber
Search/Present paramter; see Z39.50 specification.
 o z3950_replaceIndicator
  public final static int z3950_replaceIndicator
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetName
  public final static int z3950_resultSetName
Search/Present paramter; see Z39.50 specification.
 o z3950_databaseNames
  public final static int z3950_databaseNames
Search/Present paramter; see Z39.50 specification.
 o z3950_ElementSetNames
  public final static int z3950_ElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_query
  public final static int z3950_query
Search/Present paramter; see Z39.50 specification.
 o z3950_searchStatus
  public final static int z3950_searchStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_resultCount
  public final static int z3950_resultCount
Search/Present paramter; see Z39.50 specification.
 o z3950_NumberOfRecordsReturned
  public final static int z3950_NumberOfRecordsReturned
Search/Present paramter; see Z39.50 specification.
 o z3950_NextResultSetPosition
  public final static int z3950_NextResultSetPosition
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetStatus
  public final static int z3950_resultSetStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_PresentStatus
  public final static int z3950_PresentStatus
Search/Present paramter; see Z39.50 specification.
 o z3950_dataBaseOrSurDiagnostics
  public final static int z3950_dataBaseOrSurDiagnostics
Search/Present paramter; see Z39.50 specification.
 o z3950_numberOfRecordsRequested
  public final static int z3950_numberOfRecordsRequested
Search/Present paramter; see Z39.50 specification.
 o z3950_resultSetStartPoint
  public final static int z3950_resultSetStartPoint
Search/Present paramter; see Z39.50 specification.
 o z3950_ResultSetId
  public final static int z3950_ResultSetId
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributeList
  public final static int z3950_AttributeList
Search/Present paramter; see Z39.50 specification.
 o z3950_Term
  public final static int z3950_Term
Search/Present paramter; see Z39.50 specification.
 o z3950_Operator
  public final static int z3950_Operator
Search/Present paramter; see Z39.50 specification.
 o z3950_smallSetElementSetNames
  public final static int z3950_smallSetElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_mediumSetElementSetNames
  public final static int z3950_mediumSetElementSetNames
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributesPlusTerm
  public final static int z3950_AttributesPlusTerm
Search/Present paramter; see Z39.50 specification.
 o z3950_PreferredRecordSyntax
  public final static int z3950_PreferredRecordSyntax
Search/Present paramter; see Z39.50 specification.
 o z3950_DatabaseName
  public final static int z3950_DatabaseName
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributeType
  public final static int z3950_AttributeType
Search/Present paramter; see Z39.50 specification.
 o z3950_AttributeValue
  public final static int z3950_AttributeValue
Search/Present paramter; see Z39.50 specification.
 o z3950_type_0
  public final static int z3950_type_0
Query type for Search request; see Z39.50 specification.
 o z3950_type_1
  public final static int z3950_type_1
Query type for Search request; see Z39.50 specification.
 o z3950_type_2
  public final static int z3950_type_2
Query type for Search request; see Z39.50 specification.
 o z3950_type_100
  public final static int z3950_type_100
Query type for Search request; see Z39.50 specification.
 o z3950_type_101
  public final static int z3950_type_101
Query type for Search request; see Z39.50 specification.
 o z3950_Operand
  public final static int z3950_Operand
Query parameter for Search request; see Z39.50 specification.
 o z3950_Query
  public final static int z3950_Query
Query parameter for Search request; see Z39.50 specification.
 o z3950_and
  public final static int z3950_and
Query parameter for Search request; see Z39.50 specification.
 o z3950_or
  public final static int z3950_or
Query parameter for Search request; see Z39.50 specification.
 o z3950_and_not
  public final static int z3950_and_not
Query parameter for Search request; see Z39.50 specification.
 o z3950_prox
  public final static int z3950_prox
Query parameter for Search request; see Z39.50 specification.
 o z3950_deleteOperationStatus
  public final static int z3950_deleteOperationStatus
deleteResultSet parameter; see Z39.50 specification.
 o z3950_deleteFunction
  public final static int z3950_deleteFunction
deleteResultSet parameter; see Z39.50 specification.
 o z3950_exclusion
  public final static int z3950_exclusion
prox parameter; see Z39.50 specification.
 o z3950_distance
  public final static int z3950_distance
prox parameter; see Z39.50 specification.
 o z3950_ordered
  public final static int z3950_ordered
prox parameter; see Z39.50 specification.
 o z3950_relationType
  public final static int z3950_relationType
prox parameter; see Z39.50 specification.
 o z3950_proximityUnitCode
  public final static int z3950_proximityUnitCode
prox parameter; see Z39.50 specification.
 o z3950_lessThan
  public final static int z3950_lessThan
prox relationship parameter; see Z39.50 specification.
 o z3950_lessThanOrEqual
  public final static int z3950_lessThanOrEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_equal
  public final static int z3950_equal
prox relationship parameter; see Z39.50 specification.
 o z3950_greaterThanOrEqual
  public final static int z3950_greaterThanOrEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_greaterThan
  public final static int z3950_greaterThan
prox relationship parameter; see Z39.50 specification.
 o z3950_notEqual
  public final static int z3950_notEqual
prox relationship parameter; see Z39.50 specification.
 o z3950_known
  public final static int z3950_known
prox relationship parameter; see Z39.50 specification.
 o z3950_private
  public final static int z3950_private
prox relationship parameter; see Z39.50 specification.
 o z3950_character
  public final static int z3950_character
Proximity unit code; see Z39.50 specification.
 o z3950_word
  public final static int z3950_word
Proximity unit code; see Z39.50 specification.
 o z3950_sentence
  public final static int z3950_sentence
Proximity unit code; see Z39.50 specification.
 o z3950_paragraph
  public final static int z3950_paragraph
Proximity unit code; see Z39.50 specification.
 o z3950_section
  public final static int z3950_section
Proximity unit code; see Z39.50 specification.
 o z3950_chapter
  public final static int z3950_chapter
Proximity unit code; see Z39.50 specification.
 o z3950_document
  public final static int z3950_document
Proximity unit code; see Z39.50 specification.
 o z3950_element
  public final static int z3950_element
Proximity unit code; see Z39.50 specification.
 o z3950_subelement
  public final static int z3950_subelement
Proximity unit code; see Z39.50 specification.
 o z3950_elementType
  public final static int z3950_elementType
Proximity unit code; see Z39.50 specification.
 o z3950_byte
  public final static int z3950_byte
Proximity unit code; see Z39.50 specification.
 o z3950_displayTerm
  public final static int z3950_displayTerm
Scan parameter; see Z39.50 specification.
 o z3950_attributes
  public final static int z3950_attributes
Scan parameter; see Z39.50 specification.
 o z3950_termInfo
  public final static int z3950_termInfo
Scan parameter; see Z39.50 specification.
 o z3950_term
  public final static int z3950_term
Scan parameter; see Z39.50 specification.
 o z3950_globalOccurrences
  public final static int z3950_globalOccurrences
Scan parameter; see Z39.50 specification.
 o z3950_nonsurrogateDiagnostics
  public final static int z3950_nonsurrogateDiagnostics
Scan parameter; see Z39.50 specification.
 o z3950_byAttributes
  public final static int z3950_byAttributes
Scan parameter; see Z39.50 specification.
 o z3950_databaseId
  public final static int z3950_databaseId
Scan parameter; see Z39.50 specification.
 o z3950_termListAndStartPoint
  public final static int z3950_termListAndStartPoint
Scan parameter; see Z39.50 specification.
 o z3950_scanStatus
  public final static int z3950_scanStatus
Scan parameter; see Z39.50 specification.
 o z3950_stepSize
  public final static int z3950_stepSize
Scan parameter; see Z39.50 specification.
 o z3950_numberOfEntriesReturned
  public final static int z3950_numberOfEntriesReturned
Scan parameter; see Z39.50 specification.
 o z3950_numberOfTermsRequested
  public final static int z3950_numberOfTermsRequested
Scan parameter; see Z39.50 specification.
 o z3950_preferredPositionInResponse
  public final static int z3950_preferredPositionInResponse
Scan parameter; see Z39.50 specification.
 o z3950_entries
  public final static int z3950_entries
Scan parameter; see Z39.50 specification.
 o z3950_positionOfTerm
  public final static int z3950_positionOfTerm
Scan parameter; see Z39.50 specification.
 o z3950_Listentries
  public final static int z3950_Listentries
Scan parameter; see Z39.50 specification.
 o z3950_subset
  public final static int z3950_subset
Search status; see Z39.50 specification.
 o z3950_interim
  public final static int z3950_interim
Search status; see Z39.50 specification.
 o z3950_none
  public final static int z3950_none
Search status; see Z39.50 specification.
 o z3950_success
  public final static int z3950_success
Present status; see Z39.50 specification.
 o z3950_partial_1
  public final static int z3950_partial_1
Present status; see Z39.50 specification.
 o z3950_partial_2
  public final static int z3950_partial_2
Present status; see Z39.50 specification.
 o z3950_partial_3
  public final static int z3950_partial_3
Present status; see Z39.50 specification.
 o z3950_partial_4
  public final static int z3950_partial_4
Present status; see Z39.50 specification.
 o z3950_failure
  public final static int z3950_failure
Present status; see Z39.50 specification.
 o resultSetDidNotExist
  public final static int resultSetDidNotExist
deleteResultSet status; see Z39.50 specification.
 o notAllRsltSetsDeletedOnBulkDlte
  public final static int notAllRsltSetsDeletedOnBulkDlte
deleteResultSet status; see Z39.50 specification.
 o notAllRequestedResultSetsDeleted
  public final static int notAllRequestedResultSetsDeleted
deleteResultSet status; see Z39.50 specification.
 o z3950_scan_status_success
  public final static int z3950_scan_status_success
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_1
  public final static int z3950_scan_status_partial_1
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_2
  public final static int z3950_scan_status_partial_2
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_3
  public final static int z3950_scan_status_partial_3
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_4
  public final static int z3950_scan_status_partial_4
Scan status; see Z39.50 specification.
 o z3950_scan_status_partial_5
  public final static int z3950_scan_status_partial_5
Scan status; see Z39.50 specification.
 o z3950_scan_status_failure
  public final static int z3950_scan_status_failure
Scan status; see Z39.50 specification.
 o z3950_DiagBib1Malformedquery
  public final static int z3950_DiagBib1Malformedquery
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1Databaseunavailable
  public final static int z3950_DiagBib1Databaseunavailable
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1UnsupportedTruncationAttribute
  public final static int z3950_DiagBib1UnsupportedTruncationAttribute
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1Malformedscan
  public final static int z3950_DiagBib1Malformedscan
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1NoResultSet
  public final static int z3950_DiagBib1NoResultSet
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1EStypeNotSupported
  public final static int z3950_DiagBib1EStypeNotSupported
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_DiagBib1ESExecutionFailed
  public final static int z3950_DiagBib1ESExecutionFailed
DIAG.1 Diagnostic Set Bib-1; see Z39.50 specification.
 o z3950_nonSurrogateDiagnostic
  public final static int z3950_nonSurrogateDiagnostic
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_MultipleNonSurrogates
  public final static int z3950_MultipleNonSurrogates
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatcondition
  public final static int z3950_DiagnosticFormatcondition
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatunspecified
  public final static int z3950_DiagnosticFormatunspecified
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormatspecified
  public final static int z3950_DiagnosticFormatspecified
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o z3950_DiagnosticFormataddMsg
  public final static int z3950_DiagnosticFormataddMsg
DIAG.2 Diagnostic Format Diag-1; see Z39.50 specification.
 o nSearches
  protected static int nSearches
Number of searches this object has done.
 o ResultSetNames
  protected static String ResultSetNames[]
Names of results sets for each search done by this class.
 o logit
  protected static int logit
Flag for logging. Non-zero means logging is ON. '2' turns on extra logging for all requests and responses.
 o logfile
  protected static PrintStream logfile
File for logging output.
 o operator
  protected final static String operator[]
Known operators for searching.

Constructors

 o Z39api
  public Z39api()

Methods

 o logging
  public static void logging(int flag)
Enable and disable run-time diagnostics. Enabling this routine opens a file named z3950.log in the current directory. Logging can be repeatably enabled and disabled.
flag=1
enable logging
flag=2
enable logging and turn on hex_dir() style dumps of all requests and responses.
flag=666
disable logging and close log file. You should call this before exiting if you have enabled logging.

All Packages  Class Hierarchy  This Package  Previous  Next  Index