com.HTTPRequest.beginXmlRequest

Starts a streaming HTTP request.

Syntax

beginXmlRequest()
  RETURNING writer xml.StaxWriter

writer is the xml.StaxWriter to be used to write the HTTP request.

Usage

The beginXmlRequest() starts a streaming HTTP request and returns an xml.StaxWriter object ready to send XML to the server.

Supported methods are PUT and POST.

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 32 KB, the request will be sent in several chunks of the same size.

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)