All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ORG.oclc.z39.client.Z39close

java.lang.Object
   |
   +----ORG.oclc.z39.client.Z39close

public class Z39close
extends Object
Z39close creates Close requests.

Version:
%W% %G%

Variable Index

 o closeReason
Why the origin or target is closing the z-association
 o referenceId
Value passed to Request and returned by a target Z39.50 server
 o sessionId
 o zsession
Z39session

Constructor Index

 o Z39close()
 o Z39close(Z39session)

Method Index

 o doClose(int, int)
Creates, sends, and processes a Z39.50 Close Request
 o Request(int, int)
Creates a Z39.50 Close Request
 o Request(int, int, int, int)
Creates a Z39.50 Close Request
 o Response(BerString)
Processes a Z39.50 Close
 o Response(DataDir)
Processes a Z39.50 Close.
 o toString()

Variables

 o referenceId
 public int referenceId
Value passed to Request and returned by a target Z39.50 server

 o closeReason
 public int closeReason
Why the origin or target is closing the z-association

 o sessionId
 public int sessionId
 o zsession
 public Z39session zsession
Z39session

Constructors

 o Z39close
 public Z39close()
 o Z39close
 public Z39close(Z39session z)

Methods

 o doClose
 public boolean doClose(int referenceId,
                        int closeReason) throws Exception
Creates, sends, and processes a Z39.50 Close Request

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
closeReason - See Z39.50 Specification.
Returns:
boolean. Failure would be inability to create request or parse response
Throws: Exception
when the request fails
 o Request
 public BerString Request(int referenceId,
                          int closeReason)
Creates a Z39.50 Close Request

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
closeReason - See Z39.50 Specification.
Returns:
BerString containing Request or null if space was unavailable
 o Request
 public BerString Request(int referenceId,
                          int closeReason,
                          int extraLen,
                          int offset)
Creates a Z39.50 Close Request

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
closeReason - See Z39.50 Specification.
extraLen - Allow this much extra room in the built BER record.
offset - Build the Request at this offset in the BerString
Returns:
BerString containing Request or null if space was unavailable
 o Response
 public void Response(BerString response)
Processes a Z39.50 Close

Parameters:
response - BerString containing response.
 o Response
 public void Response(DataDir response)
Processes a Z39.50 Close.

Parameters:
response - DataDir containing response
 o toString
 public String toString()
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index