Package burp.api.montoya.proxy

Interface ResponseFinalInterceptResult

public interface ResponseFinalInterceptResult

Extensions can implement this interface when returning a result from ProxyHttpResponseHandler.handleResponseToReturn(InterceptedHttpResponse, HttpRequest, Annotations).

Method Summary

Modifier and Type	Method	Description
FinalInterceptAction	action()	This method retrieves the current final intercept action.
Annotations	annotations()	This method retrieves the annotations for the current response after any modifications by the extension.
static ResponseFinalInterceptResult	continueWith(HttpResponse response)	This method can be used to create a result that causes Burp Proxy to forward the response.
static ResponseFinalInterceptResult	continueWith(HttpResponse response, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to forward the response.
static ResponseFinalInterceptResult	drop()	This method can be used to create a result that causes Burp Proxy to drop the response.
static ResponseFinalInterceptResult	finalInterceptResult(HttpResponse response, Annotations annotations, FinalInterceptAction action)	This method can be used to create a default implementation of a final intercept result for an HTTP response.
HttpResponse	response()	This method retrieves the current HTTP response to forward after any modifications by the extension.

Method Detail

continueWith

static ResponseFinalInterceptResult continueWith(HttpResponse response)

This method can be used to create a result that causes Burp Proxy to forward the response.

Parameters:

response - The HttpResponse to forward after any modifications by the extension.

Returns:

The ResponseFinalInterceptResult that causes Burp Proxy to forward the response.

continueWith

static ResponseFinalInterceptResult continueWith(HttpResponse response,
                                                 Annotations annotations)

This method can be used to create a result that causes Burp Proxy to forward the response.

Parameters:

response - The HttpResponse to forward after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

Returns:

The ResponseFinalInterceptResult that causes Burp Proxy to forward the response.

drop

static ResponseFinalInterceptResult drop()

This method can be used to create a result that causes Burp Proxy to drop the response.

Returns:

The ResponseFinalInterceptResult that causes Burp Proxy to drop the response.

finalInterceptResult

static ResponseFinalInterceptResult finalInterceptResult(HttpResponse response,
                                                         Annotations annotations,
                                                         FinalInterceptAction action)

This method can be used to create a default implementation of a final intercept result for an HTTP response.

Parameters:

response - The HttpResponse to forward after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP response.

action - The FinalInterceptAction for the HTTP response.

Returns:

The ResponseFinalInterceptResult including the HTTP response, annotations and final intercept action.

action

FinalInterceptAction action()

This method retrieves the current final intercept action.

Returns:

The FinalInterceptAction.

response

HttpResponse response()

This method retrieves the current HTTP response to forward after any modifications by the extension.

Returns:

The HttpResponse to forward after any modifications by the extension.

annotations

Annotations annotations()

This method retrieves the annotations for the current response after any modifications by the extension.

Returns:

The Annotations for the intercepted HTTP response.