Object - http : Response

Represents an HTTP response.

Methods

getEntity

Gets the Entity associated with the response.

setEntity

Sets the provided Entity to the response.

hasHeader

Checks whether the requested header key exists in the header map.

getHeader

Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.

addHeader

Adds the specified header to the response. Existing header values are not replaced.

getHeaders

Gets all the header values to which the specified header key maps to.

setHeader

Sets the specified header to the response. If a mapping already exists for the specified header key, the existing header value is replaced with the specified header value.

removeHeader

Removes the specified header from the response.

removeAllHeaders

Removes all the headers from the response.

getHeaderNames

Gets all the names of the headers of the response.

setContentType

Sets the content-type header to the response.

getContentType

Gets the type of the payload of the response (i.e: the content-type header value).

getJsonPayload

Extract json payload from the response. If the content type is not JSON, an http:ClientError is returned.

getXmlPayload

Extracts xml payload from the response.

getTextPayload

Extracts text payload from the response.

getByteChannel

Gets the response payload as a ByteChannel, except in the case of multiparts. To retrieve multiparts, use getBodyParts().

getBinaryPayload

Gets the response payload as a byte[].

getBodyParts

Extracts body parts from the response. If the content type is not a composite media type, an error is returned.

setETag

Sets the etag header for the given payload. The ETag is generated using a CRC32 hash function.

setLastModified

Sets the current time as the last-modified header.

setJsonPayload

Sets a json as the payload.

setXmlPayload

Sets an xml as the payload

setTextPayload

Sets a string as the payload.

setBinaryPayload

Sets a byte[] as the payload.

setBodyParts

Set multiparts as the payload.

setFileAsPayload

Sets the content of the specified file as the entity body of the response.

setByteChannel

Sets a ByteChannel as the payload.

setPayload

Sets the response payload.

Fields

  • statusCode int 200
  • The response status code

  • reasonPhrase string
  • The status code reason phrase

  • server string
  • The server header

  • resolvedRequestedURI string
  • The ultimate request URI that was made to receive the response when redirect is on

  • cacheControl ResponseCacheControl? ()
  • The cache-control directives for the response. This needs to be explicitly initialized if intending on utilizing HTTP caching. For incoming responses, this will already be populated if the response was sent with cache-control directives

getEntity

()

returns Entity | ClientError

Gets the Entity associated with the response.

  • Return Type

    (Entity | ClientError)
  • The Entity of the response. An http:ClientError is returned, if entity construction fails

setEntity

Sets the provided Entity to the response.

Parameters

  • e Entity
  • The Entity to be set to the response

hasHeader

(string headerName)

returns boolean

Checks whether the requested header key exists in the header map.

Parameters

  • headerName string
  • The header name

  • Return Type

    (boolean)
  • Returns true if the specified header key exists

getHeader

(string headerName)

returns string

Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.

Parameters

  • headerName string
  • The header name

  • Return Type

    (string)
  • The first header value for the specified header name. An exception is thrown if no header is found. Use hasHeader() beforehand to check the existence of header.

addHeader

Adds the specified header to the response. Existing header values are not replaced.

Parameters

  • headerName string
  • The header name

  • headerValue string
  • The header value

getHeaders

(string headerName)

returns string

Gets all the header values to which the specified header key maps to.

Parameters

  • headerName string
  • The header name

  • Return Type

    (string)
  • The header values the specified header key maps to. An exception is thrown if no header is found. Use hasHeader() beforehand to check the existence of header.

setHeader

Sets the specified header to the response. If a mapping already exists for the specified header key, the existing header value is replaced with the specified header value.

Parameters

  • headerName string
  • The header name

  • headerValue string
  • The header value

removeHeader

Removes the specified header from the response.

Parameters

  • key string
  • The header name

removeAllHeaders

Removes all the headers from the response.

getHeaderNames

()

returns string

Gets all the names of the headers of the response.

  • Return Type

    (string)
  • An array of all the header names

setContentType

Sets the content-type header to the response.

Parameters

  • contentType string
  • Content type value to be set as the content-type header

getContentType

()

returns string

Gets the type of the payload of the response (i.e: the content-type header value).

  • Return Type

    (string)
  • Returns the content-type header value as a string

getJsonPayload

()

returns json | ClientError

Extract json payload from the response. If the content type is not JSON, an http:ClientError is returned.

  • Return Type

    (json | ClientError)
  • The json payload or http:ClientError in case of errors

getXmlPayload

()

returns xml | ClientError

Extracts xml payload from the response.

  • Return Type

    (xml | ClientError)
  • The xml payload or http:ClientError in case of errors

getTextPayload

()

returns string | ClientError

Extracts text payload from the response.

  • Return Type

    (string | ClientError)
  • The string representation of the message payload or http:ClientError in case of errors

getByteChannel

()

returns ReadableByteChannel | ClientError

Gets the response payload as a ByteChannel, except in the case of multiparts. To retrieve multiparts, use getBodyParts().

getBinaryPayload

()

returns byte | ClientError

Gets the response payload as a byte[].

  • Return Type

    (byte | ClientError)
  • The byte[] representation of the message payload or http:ClientError in case of errors

getBodyParts

()

returns Entity[] | ClientError

Extracts body parts from the response. If the content type is not a composite media type, an error is returned.

  • Return Type

    (Entity[] | ClientError)
  • Returns the body parts as an array of entities or an http:ClientError if there were any errors in constructing the body parts from the response

setETag

Sets the etag header for the given payload. The ETag is generated using a CRC32 hash function.

Parameters

  • payload json | xml | string | byte
  • The payload for which the ETag should be set

setLastModified

Sets the current time as the last-modified header.

setJsonPayload

Sets a json as the payload.

Parameters

  • payload json
  • The json payload

  • contentType string (default application/json)
  • The content type of the payload. Set this to override the default content-type header value for json

setXmlPayload

Sets an xml as the payload

Parameters

  • payload xml
  • The xml payload

  • contentType string (default application/xml)
  • The content type of the payload. Set this to override the default content-type header value for xml

setTextPayload

Sets a string as the payload.

Parameters

  • payload string
  • The string payload

  • contentType string (default text/plain)
  • The content type of the payload. Set this to override the default content-type header value for string

setBinaryPayload

Sets a byte[] as the payload.

Parameters

  • payload byte
  • The byte[] payload

  • contentType string (default application/octet-stream)
  • The content type of the payload. Set this to override the default content-type header value for byte[]

setBodyParts

Set multiparts as the payload.

Parameters

  • bodyParts Entity[]
  • The entities which make up the message body

  • contentType string (default multipart/form-data)
  • The content type of the top level message. Set this to override the default content-type header value

setFileAsPayload

Sets the content of the specified file as the entity body of the response.

Parameters

  • filePath string
  • Path to the file to be set as the payload

  • contentType string (default application/octet-stream)
  • The content type of the specified file. Set this to override the default content-type header value

setByteChannel

Sets a ByteChannel as the payload.

Parameters

  • contentType string (default application/octet-stream)
  • The content type of the payload. Set this to override the default content-type header value

setPayload

Sets the response payload.

Parameters

  • payload string | xml | json | byte | ReadableByteChannel | Entity[]
  • Payload can be of type string, xml, json, byte[], ByteChannel or Entity[] (i.e: a set of body parts)