com.HTTPResponse methods

Methods for the com.HTTPResponse class.

Table 1. Object methods
Name Description
getStatusCode()
  RETURNING result INTEGER
Returns the HTTP status code.
getStatusDescription()
  RETURNING result STRING
Returns the HTTP status description.
beginXmlResponse()
  RETURNING writer xml.StaxWriter
Starts a streaming HTTP response.
endXmlResponse(
   writer xml.StaxWriter )
Performs the HTTP request.
getHeader(
   name STRING )
  RETURNING result STRING
Returns the value of the HTTP header name, or NULL if there is none.
getHeaderCount()
  RETURNING result INTEGER
Returns the number of headers.
getHeaderName(
   index INTEGER )
  RETURNING result STRING
Returns the name of a header by position.
getHeaderValue(
   index INTEGER )
  RETURNING result STRING
Returns the value of a header by position.
getDataResponse(
   data BYTE )
Performs the HTTP request.
getTextResponse()
  RETURNING data STRING
Returns an entire HTTP string as response from the server.
getXmlResponse()
  RETURNING data xml.DomDocument
Returns an entire DOM document as HTTP response from the server.
Table 2. Object methods: Multipart methods
Name Description
getMultipartType()
  RETURNING result STRING
Returns whether a response is multipart or not, and the kind of multipart if any.
getPartCount()
  RETURNING count INTEGER
Returns the number of additional parts in the HTTP response.
getPart(
   index INTEGER )
  RETURNING part-object com.HTTPPart
Returns the HTTP part object at the specified index of the current HTTP response.
getPartFromContentID(
   id STRING )
  RETURNING part-object com.HTTPPart
Returns the HTTP part object marked with the given Content-ID value as identifier, or NULL if none.