Package burp.api.montoya.http.message

Interface HttpRequestResponse

All Known Subinterfaces:

MarkedHttpRequestResponse

public interface HttpRequestResponse

This interface is used to define a coupling between HttpRequest and HttpResponse interfaces.

Method Summary

Modifier and Type	Method	Description
HttpRequest	httpRequest()
static HttpRequestResponse	httpRequestResponse(HttpRequest request, HttpResponse response)	This is a helper method to create a new instance of HttpRequestResponse.
static HttpRequestResponse	httpRequestResponse(HttpRequest httpRequest, HttpResponse httpResponse, Annotations annotations)	This is a helper method to create a new instance of HttpRequestResponse.
HttpResponse	httpResponse()
Annotations	messageAnnotations()
MarkedHttpRequestResponse	withMarkers(java.util.List<Range> requestMarkers, java.util.List<Range> responseMarkers)	This is a helper method used to add markers to the HttpRequestResponse instance.
HttpRequestResponse	withMessageAnnotations(Annotations annotations)	This is a helper method used to add annotations to the HttpRequestResponse instance.
MarkedHttpRequestResponse	withNoMarkers()	This is a helper method used to build a MarkedHttpRequestResponse instance with no markers.
MarkedHttpRequestResponse	withRequestMarkers(Range... requestMarkers)	This is a helper method used to add request markers to the HttpRequestResponse instance.
MarkedHttpRequestResponse	withRequestMarkers(java.util.List<Range> requestMarkers)	This is a helper method used to add request markers to the HttpRequestResponse instance.
MarkedHttpRequestResponse	withResponseMarkers(Range... responseMarkers)	This is a helper method used to add response markers to the HttpRequestResponse instance.
MarkedHttpRequestResponse	withResponseMarkers(java.util.List<Range> responseMarkers)	This is a helper method used to add response markers to the HttpRequestResponse instance.

Method Detail

httpRequestResponse

static HttpRequestResponse httpRequestResponse(HttpRequest request,
                                               HttpResponse response)

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

Parameters:

request - The HTTP request.

response - The HTTP response.

Returns:

A new HttpRequestResponse instance.

httpRequestResponse

static HttpRequestResponse httpRequestResponse(HttpRequest httpRequest,
                                               HttpResponse httpResponse,
                                               Annotations annotations)

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

Parameters:

httpRequest - The HTTP request.

httpResponse - The HTTP response.

annotations - annotations.

Returns:

A new HttpRequestResponse instance.

httpRequest

HttpRequest httpRequest()

Returns:

The HTTP request message.

httpResponse

HttpResponse httpResponse()

Returns:

The HTTP response message.

messageAnnotations

Annotations messageAnnotations()

Returns:

The annotations.

withMessageAnnotations

HttpRequestResponse withMessageAnnotations(Annotations annotations)

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

Parameters:

annotations - annotations to add.

Returns:

A new HttpRequestResponse instance.

withMarkers

MarkedHttpRequestResponse withMarkers(java.util.List<Range> requestMarkers,
                                      java.util.List<Range> responseMarkers)

This is a helper method used to add markers to the HttpRequestResponse instance.

Parameters:

requestMarkers - Request markers to add.

responseMarkers - Response markers to add.

Returns:

A new MarkedHttpRequestResponse instance.

withRequestMarkers

MarkedHttpRequestResponse withRequestMarkers(java.util.List<Range> requestMarkers)

This is a helper method used to add request markers to the HttpRequestResponse instance.

Parameters:

requestMarkers - Request markers to add.

Returns:

A new MarkedHttpRequestResponse instance.

withRequestMarkers

MarkedHttpRequestResponse withRequestMarkers(Range... requestMarkers)

This is a helper method used to add request markers to the HttpRequestResponse instance.

Parameters:

requestMarkers - Request markers to add.

Returns:

A new MarkedHttpRequestResponse instance.

withResponseMarkers

MarkedHttpRequestResponse withResponseMarkers(java.util.List<Range> responseMarkers)

This is a helper method used to add response markers to the HttpRequestResponse instance.

Parameters:

responseMarkers - Response markers to add.

Returns:

A new MarkedHttpRequestResponse instance.

withResponseMarkers

MarkedHttpRequestResponse withResponseMarkers(Range... responseMarkers)

This is a helper method used to add response markers to the HttpRequestResponse instance.

Parameters:

responseMarkers - Response markers to add.

Returns:

A new MarkedHttpRequestResponse instance.

withNoMarkers

MarkedHttpRequestResponse withNoMarkers()

This is a helper method used to build a MarkedHttpRequestResponse instance with no markers.

Returns:

A new MarkedHttpRequestResponse instance.