com.HTTPServiceRequest.sendXmlResponse

Sends and HTTP response with data from a XML document object.

Syntax

sendXmlResponse(
   code INTEGER,
   desc STRING,
   doc xml.DomDocument )
  1. code specifies the status code of the response.
  2. description specifies the description of the response.
  3. doc specifies the XML document containing the data to be sent.

Usage

The sendXmlResponse() method performs the HTTP response by sending the a status (code) and description (description), followed by the headers previously set, and the XML data contained in the passed xml.DomDocument object as body.

It is important for the server to return a correct status code, following the HTTP standards, otherwise the client may fail to interpret the response. For instance, if the request is malformed, the server is expected to send an HTTP response with the code of 400 (Bad Request). See HTTP status codes (wikipedia) for more details about common HTTP response codes.

The default Content-Type header is text/xml, but it can be changed if of the form */xml or */*+xml. For example: application/xhtml+xml.

In HTTP 1.1, if the body size is greater than 32k, the response will be sent in several chunks of the same size.

If the description is NULL, a default description based on the status code is sent.

New incoming requests can be retrieved again with the com.WebServiceEngine.GetHTTPServiceRequest() method.

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).

The INT_FLAG variable is checked during GWS API call to handle program interruptions, for more details, see Interruption handling in GWS calls (INT_FLAG)