Interface RequestToBeSentAction

public interface RequestToBeSentAction
An instance of this interface should be returned by HttpHandler.handleHttpRequestToBeSent(burp.api.montoya.http.handler.HttpRequestToBeSent) if a custom HttpHandler has been registered with Burp.

  • Method Details

    • action

      default RequestAction action()
      Returns:
      the action.

    • request

      HttpRequest request()
      Returns:
      The HTTP request.

    • annotations

      Annotations annotations()
      Returns:
      The annotations.

    • continueWith

      static RequestToBeSentAction continueWith(HttpRequest request)
      Create a new instance of RequestToBeSentAction. Annotations will not be modified.
      Parameters:
      request - An HTTP request.
      Returns:
      A new RequestToBeSentAction instance.

    • continueWith

      static RequestToBeSentAction continueWith(HttpRequest request, Annotations annotations)
      Create a new instance of RequestToBeSentAction.
      Parameters:
      request - An HTTP request.
      annotations - modified annotations.
      Returns:
      A new RequestToBeSentAction instance.

    • drop

      static RequestToBeSentAction drop()
      Create a new instance of RequestToBeSentAction which will cause the HTTP request to be dropped. Annotations will not be modified.
      Returns:
      A new RequestToBeSentAction instance.

    • drop

      static RequestToBeSentAction drop(Annotations annotations)
      Create a new instance of RequestToBeSentAction which will cause the HTTP request to be dropped.
      Parameters:
      annotations - modified annotations.
      Returns:
      A new RequestToBeSentAction instance.

    • spoof

      static RequestToBeSentAction spoof(HttpResponse httpResponse)
      Create a new instance of RequestToBeSentAction which will suppress the HTTP request and returned the spoofed HTTP response. Annotations will not be modified.
      Parameters:
      httpResponse - spoof response.
      Returns:
      A new RequestToBeSentAction instance.

    • spoof

      static RequestToBeSentAction spoof(HttpResponse httpResponse, Annotations annotations)
      Create a new instance of RequestToBeSentAction which will suppress the HTTP request and returned the spoofed HTTP response.
      Parameters:
      httpResponse - spoof response.
      annotations - modified annotations.
      Returns:
      A new RequestToBeSentAction instance.