Package burp.api.montoya.proxy.http

Interface ProxyResponseHandler

public interface ProxyResponseHandler

Extensions can implement this interface and then call Proxy.registerResponseHandler(ProxyResponseHandler) to register a Proxy response handler. The handler will be notified of responses being processed by the Proxy tool. Extensions can perform custom analysis or modification of these responses, and control in-UI message interception.

Method Summary

Modifier and Type	Method	Description
ProxyResponseReceivedAction	handleResponseReceived(InterceptedResponse interceptedResponse)	This method is invoked when an HTTP response is received in the Proxy.
ProxyResponseToBeSentAction	handleResponseToBeSent(InterceptedResponse interceptedResponse)	This method is invoked when an HTTP response has been processed by the Proxy before it is returned to the client.

Method Details

handleResponseReceived

ProxyResponseReceivedAction handleResponseReceived(InterceptedResponse interceptedResponse)

This method is invoked when an HTTP response is received in the Proxy.

Parameters:

interceptedResponse - An InterceptedResponse object that extensions can use to query and update details of the response, and control whether the response should be intercepted and displayed to the user for manual review or modification.

Returns:

The ProxyResponseReceivedAction containing the required action, HTTP response and annotations to be passed through.

handleResponseToBeSent

ProxyResponseToBeSentAction handleResponseToBeSent(InterceptedResponse interceptedResponse)

This method is invoked when an HTTP response has been processed by the Proxy before it is returned to the client.

Parameters:

interceptedResponse - An InterceptedResponse object that extensions can use to query and update details of the response.

Returns:

The ProxyResponseToBeSentAction containing the required action, HTTP response and annotations to be passed through.