Open SiteSearch 4.1.1
Final

ORG.oclc.z39.client
Class Z39close

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

public class Z39close
extends Object

Z39close creates Close requests.


Field Summary
 int closeReason
          Why the origin or target is closing the z-association
 int referenceId
          Value passed to Request and returned by a target Z39.50 server
 int requestLength
          integer data type containing the number of bytes in the request.
 int responseLength
          integer data type containing the number of bytes in the response.
 String sessionId
           
 String txnId
           
 Z39session zsession
          Z39session
 
Constructor Summary
Z39close()
           
Z39close(Z39session z)
           
 
Method Summary
 void doClose(int referenceId, int closeReason)
          Creates, sends, and processes a Z39.50 Close Request
 BerString Request(int referenceId, int closeReason)
          Creates a Z39.50 Close Request
 BerString Request(int referenceId, int closeReason, int extraLen, int offset)
          Creates a Z39.50 Close Request
 void Response(BerString response)
          Processes a Z39.50 Close
 void Response(DataDir response)
          Processes a Z39.50 Close.
 String sessionId()
           
 String toString()
           
 String txnId()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

referenceId

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

closeReason

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

requestLength

public int requestLength
integer data type containing the number of bytes in the request.

responseLength

public int responseLength
integer data type containing the number of bytes in the response.

sessionId

public String sessionId

txnId

public String txnId

zsession

public Z39session zsession
Z39session
Constructor Detail

Z39close

public Z39close()

Z39close

public Z39close(Z39session z)
Method Detail

sessionId

public String sessionId()

txnId

public String txnId()

doClose

public void doClose(int referenceId,
                    int closeReason)
             throws Exception,
                    Diagnostic1
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.
Throws:
Exception - when the request fails

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

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

Response

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

Response

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

toString

public String toString()
Overrides:
toString in class Object

Open SiteSearch 4.1.1
Final