Package burp.api.montoya.proxy.http

Interface ProxyRequestToBeSentAction

public interface ProxyRequestToBeSentAction
Extensions can implement this interface when returning a result from ProxyRequestHandler.handleRequestToBeSent(InterceptedRequest).

  • Method Details

    • action

      MessageToBeSentAction action()
      This method retrieves the current final intercept action.
      Returns:
      The MessageToBeSentAction.

    • 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.

    • continueWith

      static ProxyRequestToBeSentAction continueWith(HttpRequest request)
      This method can be used to create a result that causes Burp Proxy to forward the request.
      Annotations are not modified.
      Parameters:
      request - The HttpRequest to forward after any modifications by the extension.
      Returns:
      The ProxyRequestToBeSentAction that causes Burp Proxy to forward the request.

    • continueWith

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

    • drop

      static ProxyRequestToBeSentAction drop()
      This method can be used to create a result that causes Burp Proxy to drop the request.
      Returns:
      The ProxyRequestToBeSentAction that causes Burp Proxy to drop the request.

    • proxyRequestToBeSentAction

      static ProxyRequestToBeSentAction proxyRequestToBeSentAction(HttpRequest request, Annotations annotations, MessageToBeSentAction 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. null value will leave the annotations unmodified.
      action - The MessageToBeSentAction for the HTTP request.
      Returns:
      The ProxyRequestToBeSentAction including the HTTP request, annotations and final intercept action.