ORG.oclc.z39.client
Class Z39extsvc

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

public class Z39extsvc

extends Object

Z39extsvc creates extended services requests with an already formulated task package as input and translates responses.

Field Summary

AccessControl	accessControl AccessControl object created when an access control request is received.
DataDir	diagnostics The DataDir diagnostics received in the extended services response
int	errorCode Error code if Request failed.
String	errorMsg Error message if Request failed.
DataDir	otherInformation The DataDir object containing the response OtherInformation data.
String	packageType The ExtendedServices packageType oid.
int	referenceId Value passed to Request and returned by a target Z39.50 server and Response stores it here.
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.
int	status Status code for response.
DataDir	taskPackage The TaskPackage DataDir.
Z39session	zsession Z39session

Constructor Summary

Z39extsvc()

Z39extsvc(Z39session z)

Method Summary

void	doExtSvc(int referenceId, int function, String oid, DataDir taskPackage, String userName, String description, String packageName, int waitAction, int retentionTimeValue, String retentionUnitSystem, String retentionUnitType, String retentionUnit, int retentionScaleFactor, int allowableFunctionForPermissions, String elementSetName, DataDir otherInformation, String otherInformationOID) Creates and sends a Z39.50 ExtendedServices Request, gets and processes the Z39.50 response
BerString	Request(int referenceId, int function, String oid, DataDir taskPackage, String userName, String description, String packageName, int waitAction) Creates a Z39.50 ExtendedServices Request.
BerString	Request(int referenceId, int function, String oid, DataDir taskPackage, String userName, String description, String packageName, int waitAction, int extraLen, int offset) Creates a Z39.50 ExtendedServices Request.
BerString	Request(int referenceId, int function, String oid, DataDir taskPackage, String userName, String description, String packageName, int waitAction, int retentionTimeValue, String retentionUnitSystem, String retentionUnitType, String retentionUnit, int retentionScaleFactor, int allowableFunctionForPermissions, String elementSetName, DataDir otherInformation, String otherInformationOID, int extraLen, int offset) Creates a Z39.50 ExtendedServices Request.
void	Response(BerString response)
void	Response(DataDir response)
String	toString()

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 and Response stores it here.

status

public int status

Status code for response.

diagnostics

public DataDir diagnostics

The DataDir diagnostics received in the extended services response

errorCode

public int errorCode

Error code if Request failed.

errorMsg

public String errorMsg

Error message if Request failed.

taskPackage

public DataDir taskPackage

The TaskPackage DataDir.

otherInformation

public DataDir otherInformation

The DataDir object containing the response OtherInformation data.

packageType

public String packageType

The ExtendedServices packageType oid.

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.

accessControl

public AccessControl accessControl

AccessControl object created when an access control request is received.

zsession

public Z39session zsession

Z39session

Constructor Detail

Z39extsvc

public Z39extsvc(Z39session z)

Z39extsvc

public Z39extsvc()

Method Detail

doExtSvc

public void doExtSvc(int referenceId,
                     int function,
                     String oid,
                     DataDir taskPackage,
                     String userName,
                     String description,
                     String packageName,
                     int waitAction,
                     int retentionTimeValue,
                     String retentionUnitSystem,
                     String retentionUnitType,
                     String retentionUnit,
                     int retentionScaleFactor,
                     int allowableFunctionForPermissions,
                     String elementSetName,
                     DataDir otherInformation,
                     String otherInformationOID)
              throws Exception,
                     Diagnostic1,
                     AccessControl

Creates and sends a Z39.50 ExtendedServices Request, gets and processes the Z39.50 response

Parameters:

referenceId - Will be returned on Response.

function - the extended services function

oid - the Extended Services ObjectId

taskPackage - the DataDir with the pre-build taskPackage

userName - optional string to identify the user

description - optional string describing the action

packageName - optional string to identifying the package

waitAction - optional value for the Extended Services wait action

allowableFunctionForPermissions - one of the valid allowable function settings for the permission - optional

elementSetName - the optional ElementSetName for the request

otherInformation - the DataDir object containing the otherInformation field - optional

otherInformationOID - the OID for the otherInformation field - optional

Throws:

Exception - exceptions from BerConnect

Diagnostic1 - Z39.50 diagnostics

AccessControl - exception thrown when server issues AccessControl request.

Request

public BerString Request(int referenceId,
                         int function,
                         String oid,
                         DataDir taskPackage,
                         String userName,
                         String description,
                         String packageName,
                         int waitAction)

Creates a Z39.50 ExtendedServices Request.

Parameters:

referenceId - Will be returned on Response.

function - the extended services function

oid - the Extended Services ObjectId

taskPackage - the DataDir with the pre-build taskPackage

userName - optional string to identify the user

description - optional string describing the action

packageName - optional string to identifying the package

waitAction - optional value for the Extended Services wait action

Returns:

BerString containing Request or null if space was unavailable

Request

public BerString Request(int referenceId,
                         int function,
                         String oid,
                         DataDir taskPackage,
                         String userName,
                         String description,
                         String packageName,
                         int waitAction,
                         int extraLen,
                         int offset)

Creates a Z39.50 ExtendedServices Request.

Parameters:

referenceId - Will be returned on Response.

function - the extended services function

oid - the Extended Services ObjectId

taskPackage - the DataDir with the pre-build taskPackage

userName - optional string to identify the user

description - optional string describing the action

packageName - optional string to identifying the package

waitAction - optional value for the Extended Services wait action

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

Request

public BerString Request(int referenceId,
                         int function,
                         String oid,
                         DataDir taskPackage,
                         String userName,
                         String description,
                         String packageName,
                         int waitAction,
                         int retentionTimeValue,
                         String retentionUnitSystem,
                         String retentionUnitType,
                         String retentionUnit,
                         int retentionScaleFactor,
                         int allowableFunctionForPermissions,
                         String elementSetName,
                         DataDir otherInformation,
                         String otherInformationOID,
                         int extraLen,
                         int offset)

Creates a Z39.50 ExtendedServices Request.

Parameters:

referenceId - Will be returned on Response.

function - the extended services function

oid - the Extended Services ObjectId

taskPackage - the DataDir with the pre-build taskPackage

userName - optional string to identify the user

description - optional string describing the action

packageName - optional string to identifying the package

waitAction - optional value for the Extended Services wait action

allowableFunctionForPermissions - one of the valid allowable function settings for the permission - optional

elementSetName - the optional ElementSetName for the request

otherInformation - the DataDir object containing the otherInformation field - optional

otherInformationOID - the OID for the otherInformation field - optional

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)
              throws AccessControl

Response

public void Response(DataDir response)
              throws AccessControl

toString

public String toString()

Overrides:

toString in class Object