com.WebService.registerInputRequestHandler

Registers the function to be executed on incoming SOAP requests.

Syntax

registerInputRequestHandler(
   function STRING )

function has the name of a program function.

Usage

The registerInputRequestHandler() method registers a function to be called when an incoming SOAP request is received and before the SOAP engine has processed it.

The callback function must be defined with a unique parameter of type xml.DomDocument, and must return the reference to this object, or NULL:

FUNCTION myRequestInputHandler( in )
    DEFINE in xml.DomDocument
    ...
    RETURN in
END FUNCTION

The input callback function typically modifies the content of the SOAP input request DOM document object passed as parameter.

When returning NULL from the input callback function, the output callback function will be called with the default SOAP fault node, which can then be modified.

In case of error, the method throws an exception and sets the STATUS variable. Depending on the error, a human-readable description of the problem is available in the SQLCA.SQLERRM register. See Error handling in GWS calls (STATUS).