Package burp.api.montoya.proxy

Interface ProxyHttpResponseHandler

public interface ProxyHttpResponseHandler

Extensions can implement this interface and then call Proxy.registerResponseHandler(ProxyHttpResponseHandler) 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
ResponseInitialInterceptResult	handleReceivedResponse(InterceptedHttpResponse interceptedResponse, HttpRequest initiatingRequest, Annotations annotations)	This method is invoked when an HTTP response is received in the Proxy.
ResponseFinalInterceptResult	handleResponseToReturn(InterceptedHttpResponse interceptedResponse, HttpRequest initiatingRequest, Annotations annotations)	This method is invoked when an HTTP response has been processed by the Proxy before it is returned to the client.

Method Detail

handleReceivedResponse

ResponseInitialInterceptResult handleReceivedResponse(InterceptedHttpResponse interceptedResponse,
                                                      HttpRequest initiatingRequest,
                                                      Annotations annotations)

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

Parameters:

interceptedResponse - An InterceptedHttpResponse 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.

initiatingRequest - The HttpRequest that was issued.

annotations - The Annotations for the intercepted request.

Returns:

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

handleResponseToReturn

ResponseFinalInterceptResult handleResponseToReturn(InterceptedHttpResponse interceptedResponse,
                                                    HttpRequest initiatingRequest,
                                                    Annotations annotations)

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

Parameters:

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

initiatingRequest - The HttpRequest that was issued.

annotations - The Annotations for the intercepted request.

Returns:

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