ORG.oclc.webz
Class EXTSVC

java.lang.Object
  |
  +--ORG.oclc.webz.Verb
        |
        +--ORG.oclc.webz.ZVerb
              |
              +--ORG.oclc.webz.EXTSVC

Direct Known Subclasses:

ESDbUpdate, ExampleExtSvc

public class EXTSVC

extends ZVerb

The EXTSVC class is the WebZ Verb that formulates and issues a Z39.50 Extended Services request to a Z39.50 server using parameters contained in a RequestManager object, or a RequestManager object and a string containing a URL. A successful execution of EXTSVC sets up the next page or command for execution in the RequestManager object and updates the response variables in the ExtSvcData object for the interface to use. If a failure occurs, the user variables code and msg are updated to contain the reason and the next page or command for execution is set up in the RequestManager.

This class SHOULD be extended by any custom Verbs creating extended services requests. This Verb DOES NOT create the Extended Services Task Package, rather it depends on the fact that another class prepares that data and invokes the setESParms() method in EXTSVC to save up the actual parameters to the request before invoking the runit() method to send the request.

The processing flow of the EXTSVC class is to initialize the user state for sending the request, create the Z39.50 extended services request using the data in the ExtSvcData Object saved in the setESParms() method, send and receive the response, set the response variables in the ExtSvcData Object, set the status of the response, and set up the next command to execute in the RequestManager object.

The user state entities that are set as a result EXTSVC class are:
code - the status of the request - see WebZErrors
msg - the error message for the request

See Also:

FailurePage, SuccessPage, RequestManager, UserStateObject, ExtSvcData

Field Summary

protected ExtSvcData

esParms

Fields inherited from class ORG.oclc.webz.ZVerb

bytesIn, bytesOut, dbGroupSearch, dbname, fmtClass, format, inputQueryInfo, numrecs, postings, ranked, recno, resultSetName, sorting, tempDb, traceMsgs, z39session, zDb, zQueryTerm, zServer, zUserData

Fields inherited from class ORG.oclc.webz.Verb

user, widgets

Constructor Summary

EXTSVC()
Constructs an EXTSVC object.

Method Summary

protected void	doExtSvc() Creates and Sends the Extended Services Request
ExtSvcData	getESParms() Returns the current ExtSvcData Object saved in the EXTSVC object.
protected void	resumeExtSvc()
void	runit(RequestManager rMngr) Executes the EXTSVC class using the parameters in the RequestManager object.
void	runit(RequestManager rMngr, String URLCmd) Executes the EXTSVC class using the RequestManager object and the input parameters contained in the URLCmd.
void	setESParms(ExtSvcData esRequestData) Saves the input ExtSvcData Object as the data to be used to create the Extended Services Request - This method MUST BE called before the runit() logic is invoked so that the input request information is available to create the request.

Methods inherited from class ORG.oclc.webz.ZVerb

doAccessControl, doSort, initZUser, restoreDbState, saveDbState, saveRecs, toString

Methods inherited from class ORG.oclc.webz.Verb

setUpPage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

esParms

protected ExtSvcData esParms

Constructor Detail

EXTSVC

public EXTSVC()

Constructs an EXTSVC object.

Method Detail

setESParms

public void setESParms(ExtSvcData esRequestData)

Saves the input ExtSvcData Object as the data to be used to create the Extended Services Request - This method MUST BE called before the runit() logic is invoked so that the input request information is available to create the request.

getESParms

public ExtSvcData getESParms()

Returns the current ExtSvcData Object saved in the EXTSVC object.

Returns:

ExtSvcData

runit

public void runit(RequestManager rMngr)

Executes the EXTSVC class using the parameters in the RequestManager object. Each method called from the runit() method can throw a FailurePage exception. If this occurs, the catch logic for the exceptions invokes setup of the next page or command to execute upon return. Successful execution of all steps sets up the next page for execution upon return.

Parameters:

rMngr - the RequestManager object.

Overrides:

runit in class Verb

runit

public void runit(RequestManager rMngr,
                  String URLCmd)

Executes the EXTSVC class using the RequestManager object and the input parameters contained in the URLCmd. This is used when creating a EXTSVC object from one of the application classes and sending in the query parameters in the URL String. Each method called from the runit() method can throw a FailurePage exception. If this occurs, the catch logic for the exceptions invokes setup of the next page or command to execute upon return. Successful execution of all steps sets up the next page for execution upon return.

Parameters:

rMngr - the RequestManager object

URLCmd - the command string with the widgets delimited by ":".

doExtSvc

protected void doExtSvc()
                 throws SuccessPage,
                        FailurePage

Creates and Sends the Extended Services Request

Throws:

FailurePage - the request failed.

SuccessPage - if an access control exception is needed, the success page may be thrown.

resumeExtSvc

protected void resumeExtSvc()
                     throws SuccessPage,
                            FailurePage