Package burp.api.montoya.http.message

Interface MarkedHttpRequestResponse

All Superinterfaces:

HttpRequestResponse

public interface MarkedHttpRequestResponse
extends HttpRequestResponse

This interface is used to extend HttpRequestResponse interface to hold message markers data.

Method Summary

Modifier and Type	Method	Description
static MarkedHttpRequestResponse	markedRequestResponse(HttpRequest httpRequest, HttpResponse httpResponse)	This is a helper method to create a new instance of MarkedHttpRequestResponse.
static MarkedHttpRequestResponse	markedRequestResponse(HttpRequest httpRequest, HttpResponse httpResponse, Annotations annotations)	This is a helper method to create a new instance of MarkedHttpRequestResponse.
java.util.List<Range>	requestMarkers()
java.util.List<Range>	responseMarkers()
MarkedHttpRequestResponse	withMessageAnnotations(Annotations annotations)	This is a helper method used to add annotations to the MarkedHttpRequestResponse instance.

Methods inherited from interface burp.api.montoya.http.message.HttpRequestResponse

httpRequest, httpResponse, messageAnnotations, withMarkers, withNoMarkers, withRequestMarkers, withRequestMarkers, withResponseMarkers, withResponseMarkers

Method Detail

markedRequestResponse

static MarkedHttpRequestResponse markedRequestResponse(HttpRequest httpRequest,
                                                       HttpResponse httpResponse)

This is a helper method to create a new instance of MarkedHttpRequestResponse.

Parameters:

httpRequest - The HTTP request.

httpResponse - The HTTP response.

Returns:

A new MarkedHttpRequestResponse instance.

markedRequestResponse

static MarkedHttpRequestResponse markedRequestResponse(HttpRequest httpRequest,
                                                       HttpResponse httpResponse,
                                                       Annotations annotations)

This is a helper method to create a new instance of MarkedHttpRequestResponse.

Parameters:

httpRequest - The HTTP request.

httpResponse - The HTTP response.

annotations - annotations.

Returns:

A new MarkedHttpRequestResponse instance.

requestMarkers

java.util.List<Range> requestMarkers()

Returns:

List of request markers

responseMarkers

java.util.List<Range> responseMarkers()

Returns:

List of response markers

withMessageAnnotations

MarkedHttpRequestResponse withMessageAnnotations(Annotations annotations)

This is a helper method used to add annotations to the MarkedHttpRequestResponse instance.

Specified by:

withMessageAnnotations in interface HttpRequestResponse

Parameters:

annotations - annotations to add.

Returns:

A new MarkedHttpRequestResponse instance.