Response

com.softwareag.connectivity.httpclient
Event Response

An event representing the HTTP responses.

The payload of the response is held inside an AnyExtractor event for easy retrieval.

See Also:: com.apama.util.AnyExtractor - Use helper actions on the AnyExtractor event for extracting data.

Field summary
`string`	`method` The HTTP method used for the request.
`string`	`path` The HTTP path URI used for the request.
`com.apama.util.AnyExtractor`	`payload` The response payload wrapped inside an `AnyExtractor` event for easy retrieval of the data.
`integer`	`statusCode` The HTTP response status code.
`string`	`statusMessage` The HTTP response status message.
`com.softwareag.connectivity.httpclient.HttpOptions`	`options` Optional HTTP options to set headers, cookies and query parameters.

Action summary
`string`	`getCookie(string name)` Return the value of the HTTP cookie with the specified name. This is equivalent to calling `options.cookies[name]`.
`string`	`getHeader(string name)` Return the value of the HTTP header with the specified name. This is equivalent to calling `options.headers[name]`.
`boolean`	`isSuccess()` Indicate whether the HTTP request was successful by checking for a 2xx status code.

Field detail

string method

The HTTP method used for the request.

com.softwareag.connectivity.httpclient.HttpOptions options

Optional HTTP options to set headers, cookies and query parameters.

string path

The HTTP path URI used for the request.

com.apama.util.AnyExtractor payload

The response payload wrapped inside an AnyExtractor event for easy retrieval of the data.

integer statusCode

The HTTP response status code.

string statusMessage

The HTTP response status message.

Action detail

string getCookie(string name)

Return the value of the HTTP cookie with the specified name. This is equivalent to calling options.cookies[name].

string getHeader(string name)

Return the value of the HTTP header with the specified name. This is equivalent to calling options.headers[name].

boolean isSuccess()

Indicate whether the HTTP request was successful by checking for a 2xx status code.