Interface RequestResult

public interface RequestResult

The record of a single request sent by a RequestExecutionEngine: its correlation label, what happened to it, and the request/response exchange.

One RequestResult exists per queued request. Instances are passed to a ResponseHandler as each request completes and collected into RequestExecutionResult.results(). They are an immutable record created by Burp; there is no caller-facing factory. Whether a result is kept is decided by the ResponseHandler's Retention verdict, not on the result itself.

Method Summary

Modifier and Type	Method	Description
String	label()
HttpRequestResponse	requestResponse()	The request/response exchange.
RequestStatus	status()

Method Details

label

String label()

Returns:

The correlation label supplied to RequestExecutionEngine.queue(burp.api.montoya.http.message.requests.HttpRequest, String) (or RequestExecution.queue(burp.api.montoya.http.message.requests.HttpRequest, String)), echoed back unchanged. "" when none was given; never null.

status

RequestStatus status()

Returns:

What happened to this request.

requestResponse

HttpRequestResponse requestResponse()

The request/response exchange. The response is present whenever status() is RequestStatus.RESPONDED; for other outcomes only the request is present.

Returns:

The exchange for this request.