Enum Class RequestStatus

java.lang.Object
java.lang.Enum<RequestStatus>
burp.api.montoya.http.execution.RequestStatus
All Implemented Interfaces:
Serializable, Comparable<RequestStatus>, Constable
public enum RequestStatus extends Enum<RequestStatus>
The status of a single request sent by a RequestExecutionEngine - what happened when the engine tried to send it.

ExecutionStats.completed() counts RESPONDED results; ExecutionStats.failed() counts all of TIMED_OUT, CONNECTION_FAILED and DROPPED. Every request in a terminated run has exactly one status, so requested() == completed() + failed().

  • Enum Constant Details

    • RESPONDED

      public static final RequestStatus RESPONDED
      A response was received - any HTTP status code, including 4xx and 5xx. A status code means an answer came back, so it is always RESPONDED; only transport-level failures are TIMED_OUT or CONNECTION_FAILED.

    • TIMED_OUT

      public static final RequestStatus TIMED_OUT
      No response arrived within the timeout given to sendAll.

    • CONNECTION_FAILED

      public static final RequestStatus CONNECTION_FAILED
      The request could not complete at the transport level - connection refused or reset, unknown host, TLS failure, or no usable response data.

    • DROPPED

      public static final RequestStatus DROPPED
      The request was never sent - it was abandoned because the run was cancelled before it left the queue. Dropped requests appear in RequestExecutionResult.results() but are not delivered to a ResponseHandler.

  • Method Details

    • values

      public static RequestStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RequestStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null