Package burp.api.montoya.proxy

Interface RequestFinalInterceptResult

public interface RequestFinalInterceptResult

Extensions can implement this interface when returning a result from ProxyHttpRequestHandler.handleRequestToIssue(InterceptedHttpRequest, 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 request after any modifications by the extension.
static RequestFinalInterceptResult	continueWith(HttpRequest request)	This method can be used to create a result that causes Burp Proxy to forward the request.
static RequestFinalInterceptResult	continueWith(HttpRequest request, Annotations annotations)	This method can be used to create a result that causes Burp Proxy to forward the request.
static RequestFinalInterceptResult	drop()	This method can be used to create a result that causes Burp Proxy to drop the request.
static RequestFinalInterceptResult	finalInterceptResult(HttpRequest request, Annotations annotations, FinalInterceptAction action)	This method can be used to create a default implementation of a final intercept result for an HTTP request.
HttpRequest	request()	This method retrieves the current HTTP request to forward after any modifications by the extension.

Method Detail

continueWith

static RequestFinalInterceptResult continueWith(HttpRequest request)

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

Parameters:

request - The HttpRequest to forward after any modifications by the extension.

Returns:

The RequestFinalInterceptResult that causes Burp Proxy to forward the request.

continueWith

static RequestFinalInterceptResult continueWith(HttpRequest request,
                                                Annotations annotations)

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

Parameters:

request - The HttpRequest to forward after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request.

Returns:

The RequestFinalInterceptResult that causes Burp Proxy to forward the request.

drop

static RequestFinalInterceptResult drop()

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

Returns:

The RequestFinalInterceptResult that causes Burp Proxy to drop the request.

finalInterceptResult

static RequestFinalInterceptResult finalInterceptResult(HttpRequest request,
                                                        Annotations annotations,
                                                        FinalInterceptAction action)

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

Parameters:

request - The HttpRequest to forward after any modifications by the extension.

annotations - The Annotations for the intercepted HTTP request.

action - The FinalInterceptAction for the HTTP request.

Returns:

The RequestFinalInterceptResult including the HTTP request, annotations and final intercept action.

action

FinalInterceptAction action()

This method retrieves the current final intercept action.

Returns:

The FinalInterceptAction.

request

HttpRequest request()

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

Returns:

The HttpRequest to forward after any modifications by the extension.

annotations

Annotations annotations()

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

Returns:

The Annotations for the intercepted HTTP request.