RequestCycle(3.0)

When the HTTP/2 Server agent receives a request it converts it to a RequestCycle UDR that is routed into the workflow. The UDR will then get the Response(3.0) field populated in the workflow before being routed back to the HTTP/2 Server agent.

The following fields are included in the RequestCycle UDR:

FieldDescription
authToken (HttpAuthTokenUDR)If Token Authentication has been selected in the agent configuration, the AuthToken UDR will contain the the required information for authentication.
body (bytearray)

This field contains the message body, i e the payload, of the request. For a request, the presence of a message body is indicated by the presence of a Content-Length or Transfer-Encoding field.

clientHost (string)

The IP address or hostname of the client that is connecting to the server.

clientPort (int)

The port of the client that is connecting to the server.

contentType (string)

The type of the content, e g "text/html", "image/gif", etc.

context (any)

This field can be used in the workflow configuration to keep track of, and use, internal workflow information related to a RequestCycle UDR.

For instance, before you route a RequestCycle UDR to the HTTP/2 agent, store the TCPIPUDR from a TCP/IP collection agent in the Context field. You can then read the TCPIPUDR from the Context field in the RequestCycle UDR that contains the answer, and use it to send back a response to the TCP/IP collection agent.

cookies (list<string>)

Information about any cookies attached to the request.

headers (map<string,list<string>>)

This field is populated by all the headers present in the request, e g Date, Connection,. The map keys contain header field names and the content is stored in the corresponding map values.

host (string)

The hostname or IP address where the HTTP server is running.

httpVersion (string)

This field contains the HTTP version. Possible string values are "http1", "1.0", "http2", or "2.0".

method (string)

The request method, for example GET or POST.

HTTP/2 supports the following methods; GET, POST, PUT, DELETE, and PATCH.

HEAD, CONNECT, OPTIONS, and TRACE are not supported.

multipartSegments (list<MultipartSegment (http)>)

If the request is of a multipart type, this field contains MultipartSegment UDRs.

openAPIUDR (DRUDR)

This field is used if an OpenAPI profile has been associated with the HTTP/2 Server agent.

parameters (map<string,string>)

This field contains any request parameters included, e.g. Header Table Size, Default connection concurrent streams etc.

password (string)

The password associated with the username for the account on the HTTP server.

path (string)

The path of the target URI.

port (string)

The port number to contact the HTTP server on.

pushSupported (boolean)

Indicates whether push is supported. Push can be used with HTTP/2 but not with HTTP/1.

requestTimeout (int)

The number of milliseconds to wait for a response.

response (Response (http))

This field is populated by the contents of Response UDR.

secure (boolean)

Indicates whether the data is sent in secure mode or not.

username (string)

The username for the account on the HTTP server.

isError (boolean)

This field is set to true upon encountering any errors when the HTTP/2 Server agent is processing a request.

The field will only be set when Route Error to APL is enabled on the HTTP/2 Server agent.

errorStatusCode (int)

The HTTP error code will be set to this field base on the type of errors encountered by the HTTP/2 Server agent when processing a request.

The field will only be set when Route Error to APL is enabled on the HTTP/2 Server agent.

errorMessages (list<string>)

This list contains all the error messages from the errors encountered by the HTTP/2 Server agent when processing a request.

The field will only be set when Route Error to APL is enabled on the HTTP/2 Server agent.