Package burp.api.montoya.proxy

Interface Proxy

public interface Proxy

This interface provides access to the functionality of the Proxy tool.

Method Summary

Modifier and Type	Method	Description
void	disableIntercept()	This method disables the master interception for Burp Proxy.
void	enableIntercept()	This method enables the master interception for Burp Proxy.
default java.util.List<ProxyRequestResponse>	history()	This method returns details of all items in the Proxy history.
java.util.List<ProxyRequestResponse>	history(ProxyHistoryFilter filter)	This method returns details of items in the Proxy history based on the filter.
Registration	registerRequestHandler(ProxyHttpRequestHandler handler)	This method is used to register a handler which will be notified of requests being processed by the Proxy tool.
Registration	registerResponseHandler(ProxyHttpResponseHandler handler)	This method is used to register a handler which will be notified of responses being processed by the Proxy tool.
Registration	registerWebSocketCreationHandler(ProxyWebSocketCreationHandler handler)	This method is used to register a handler which will be invoked whenever a WebSocket is created by the Proxy tool.

Method Detail

enableIntercept

void enableIntercept()

This method enables the master interception for Burp Proxy.

disableIntercept

void disableIntercept()

This method disables the master interception for Burp Proxy.

history

default java.util.List<ProxyRequestResponse> history()

This method returns details of all items in the Proxy history.

Returns:

The list of all the ProxyRequestResponse items in the Proxy history.

history

java.util.List<ProxyRequestResponse> history(ProxyHistoryFilter filter)

This method returns details of items in the Proxy history based on the filter.

Parameters:

filter - An instance of ProxyHistoryFilter that can be used to filter the items in the Proxy history.

Returns:

The list of ProxyRequestResponse items in the Proxy history that matched the filter.

registerRequestHandler

Registration registerRequestHandler(ProxyHttpRequestHandler handler)

This method is used to register a handler which will be notified of requests being processed by the Proxy tool. Extensions can perform custom analysis or modification of these messages, and control in-UI message interception.

Parameters:

handler - An object created by the extension that implements the ProxyHttpRequestHandler interface.

Returns:

The Registration for the handler.

registerResponseHandler

Registration registerResponseHandler(ProxyHttpResponseHandler handler)

This method is used to register a handler which will be notified of responses being processed by the Proxy tool. Extensions can perform custom analysis or modification of these messages, and control in-UI message interception.

Parameters:

handler - An object created by the extension that implements the ProxyHttpResponseHandler interface.

Returns:

The Registration for the handler.

registerWebSocketCreationHandler

Registration registerWebSocketCreationHandler(ProxyWebSocketCreationHandler handler)

This method is used to register a handler which will be invoked whenever a WebSocket is created by the Proxy tool.

Parameters:

handler - An object created by the extension that implements ProxyWebSocketCreationHandler interface.

Returns:

The Registration for the handler.