Object -
http
:
Response
Represents an HTTP response.
Methods
Gets the Entity associated with the response.
Sets the provided Entity to the response.
Checks whether the requested header key exists in the header map.
Returns the value of the specified header.
Adds the specified header to the response.
Gets all the header values to which the specified header key maps to.
Sets the specified header to the response.
Removes the specified header from the response.
Removes all the headers from the response.
Gets all the names of the headers of the response.
Sets the content-type header to the response.
Gets the type of the payload of the response (i.
Extract json payload from the response.
Extracts xml payload from the response.
Extracts text payload from the response.
Gets the response payload as a ByteChannel, except in the case of multiparts.
Gets the response payload as a byte[].
Extracts body parts from the response.
Sets the etag header for the given payload.
Sets the current time as the last-modified header.
Sets a json as the payload.
Sets an xml as the payload
Sets a string as the payload.
Sets a byte[] as the payload.
Set multiparts as the payload.
Sets the content of the specified file as the entity body of the response.
Sets a ByteChannel as the payload.
Sets the response payload.
Adds the cookie to response.
Deletes the cookies in the client's cookie store.
Gets cookies from the response.
Fields
- statusCode int (default 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? (default ())
-
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
Gets the Entity associated with the response.
-
Return Type
(Entity | ClientError) The
Entityof the response. Anhttp:ClientErroris returned, if entity construction fails
Sets the provided Entity to the response.
Parameters
- e Entity
-
The
Entityto be set to the response
Checks whether the requested header key exists in the header map.
Parameters
- headerName string
-
The header name
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter
-
Return Type
(boolean) trueif the specified header key exists
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
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
-
Return Type
(string) The first header value for the specified header name. Panic if the header is not found. Use the
Response.hasHeader()beforehand to check the existence of a header.
Adds the specified header to the response. Existing header values are not replaced. Panic if an illegal header is passed.
Parameters
- headerName string
-
The header name
- headerValue string
-
The header value
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
Gets all the header values to which the specified header key maps to.
Parameters
- headerName string
-
The header name
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
-
Return Type
(string[]) The header values the specified header key maps to. Panic if the header is not found. Use the
Response.hasHeader()beforehand to check the existence of a header.
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. Panic if an illegal header is passed.
Parameters
- headerName string
-
The header name
- headerValue string
-
The header value
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
Removes the specified header from the response.
Parameters
- key string
-
The header name
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
Removes all the headers from the response.
Parameters
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
Gets all the names of the headers of the response.
Parameters
- position HeaderPosition (default mime:LEADING)
-
Represents the position of the header as an optional parameter. If the position is
mime:TRAILING, the entity-body of theResponsemust be accessed initially.
-
Return Type
(string[]) An array of all the header names
Sets the content-type header to the response.
Parameters
- contentType string
-
Content type value to be set as the
content-typeheader
Gets the type of the payload of the response (i.e: the content-type header value).
-
Return Type
(string) Returns the
content-typeheader value as a string
Extract json payload from the response. If the content type is not JSON, an http:ClientError is returned.
-
Return Type
(json | ClientError) The
jsonpayload orhttp:ClientErrorin case of errors
Extracts xml payload from the response.
-
Return Type
(xml | ClientError) The
xmlpayload orhttp:ClientErrorin case of errors
Extracts text payload from the response.
-
Return Type
(string | ClientError) The string representation of the message payload or
http:ClientErrorin case of errors
Gets the response payload as a ByteChannel, except in the case of multiparts. To retrieve multiparts, use
Response.getBodyParts().
-
Return Type
(ReadableByteChannel | ClientError) A byte channel from which the message payload can be read or
http:ClientErrorin case of errors
Gets the response payload as a byte[].
-
Return Type
(byte[] | ClientError) The byte[] representation of the message payload or
http:ClientErrorin case of errors
Extracts body parts from the response. If the content type is not a composite media type, an error is returned.
-
Return Type
(Entity[] | ClientError) The body parts as an array of entities or else an
http:ClientErrorif there were any errors in constructing the body parts from the response
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
Sets a json as the payload.
Parameters
- payload json
-
The
jsonpayload
- contentType string (default application/json)
-
The content type of the payload. Set this to override the default
content-typeheader value forjson
Sets an xml as the payload
Parameters
- payload xml
-
The
xmlpayload
- contentType string (default application/xml)
-
The content type of the payload. Set this to override the default
content-typeheader value forxml
Sets a string as the payload.
Parameters
- payload string
-
The
stringpayload
- contentType string (default text/plain)
-
The content type of the payload. Set this to override the default
content-typeheader value forstring
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-typeheader value forbyte[]
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-typeheader value
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-typeheader value
Sets a ByteChannel as the payload.
Parameters
- payload ReadableByteChannel
-
A
ByteChannelthrough which the message payload can be read
- contentType string (default application/octet-stream)
-
The content type of the payload. Set this to override the default
content-typeheader value
Sets the response payload.
Parameters
- payload string | xml | json | byte[] | ReadableByteChannel | Entity[]
-
Payload can be of type
string,xml,json,byte[],ByteChannelorEntity[](i.e: a set of body parts)
Adds the cookie to response.
Parameters
- cookie Cookie
-
The cookie, which is added to response
Deletes the cookies in the client's cookie store.
Parameters
- cookiesToRemove Cookie...
-
Cookies to be deleted