Package burp.api.montoya.proxy

Enum InitialInterceptAction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InitialInterceptAction>
    public enum InitialInterceptAction
extends java.lang.Enum<InitialInterceptAction>
    This enum represents the initial action to be taken when intercepting HTTP and WebSocket messages in the Proxy.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DO_NOT_INTERCEPT
      Causes Burp Proxy to forward the message without presenting it to the user.
      DROP
      Causes Burp Proxy to drop the message.
      FOLLOW_USER_RULES
      Causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.
      INTERCEPT
      Causes Burp Proxy to present the message to the user for manual review or modification.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static InitialInterceptAction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InitialInterceptAction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • INTERCEPT

        public static final InitialInterceptAction INTERCEPT
        Causes Burp Proxy to present the message to the user for manual review or modification.

      • DO_NOT_INTERCEPT

        public static final InitialInterceptAction DO_NOT_INTERCEPT
        Causes Burp Proxy to forward the message without presenting it to the user.

      • FOLLOW_USER_RULES

        public static final InitialInterceptAction FOLLOW_USER_RULES
        Causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.

    • Method Detail

      • values

        public static InitialInterceptAction[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (InitialInterceptAction c : InitialInterceptAction.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static InitialInterceptAction valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null