Package burp.api.montoya.proxy.http

Interface ProxyResponseToBeSentAction

public interface ProxyResponseToBeSentAction

Extensions can implement this interface when returning a result from ProxyResponseHandler.handleResponseToBeSent(InterceptedResponse).

Method Summary

Modifier and Type	Method	Description
MessageToBeSentAction	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 ProxyResponseToBeSentAction	continueWith(HttpResponse response)	This method can be used to create a result that causes Burp Proxy to forward the response. Annotations are not modified.
static ProxyResponseToBeSentAction	continueWith(HttpResponse response, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to forward the response.
static ProxyResponseToBeSentAction	drop()	This method can be used to create a result that causes Burp Proxy to drop the response.
static ProxyResponseToBeSentAction	proxyResponseToReturnAction(HttpResponse response, Annotations annotations, MessageToBeSentAction 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 Details

action

MessageToBeSentAction action()

This method retrieves the current final intercept action.

Returns:

The MessageToBeSentAction.

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.

continueWith

static ProxyResponseToBeSentAction continueWith(HttpResponse response)

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

Parameters:

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

Returns:

The ProxyResponseToBeSentAction that causes Burp Proxy to forward the response.

continueWith

static ProxyResponseToBeSentAction 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 ProxyResponseToBeSentAction that causes Burp Proxy to forward the response.

drop

static ProxyResponseToBeSentAction drop()

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

Returns:

The ProxyResponseToBeSentAction that causes Burp Proxy to drop the response.

proxyResponseToReturnAction

static ProxyResponseToBeSentAction proxyResponseToReturnAction(HttpResponse response,
 Annotations annotations,
 MessageToBeSentAction 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. null value will leave the annotations unmodified.

action - The MessageToBeSentAction for the HTTP response.

Returns:

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