Package burp.api.montoya.proxy

Enum Class MessageReceivedAction

java.lang.Object

java.lang.Enum<MessageReceivedAction>

burp.api.montoya.proxy.MessageReceivedAction

All Implemented Interfaces:

Serializable, Comparable<MessageReceivedAction>, Constable

public enum MessageReceivedAction
extends Enum<MessageReceivedAction>

This enum represents the initial action to be taken when intercepting HTTP and WebSocket messages in the Proxy.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static MessageReceivedAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageReceivedAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTINUE

public static final MessageReceivedAction CONTINUE

Causes Burp Proxy to follow the current interception rules to determine the appropriate action to take for the message.

INTERCEPT

public static final MessageReceivedAction INTERCEPT

Causes Burp Proxy to present the message to the user for manual review or modification.

DO_NOT_INTERCEPT

public static final MessageReceivedAction DO_NOT_INTERCEPT

Causes Burp Proxy to forward the message without presenting it to the user.

DROP

public static final MessageReceivedAction DROP

Causes Burp Proxy to drop the message.

Method Details

values

public static MessageReceivedAction[] 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 MessageReceivedAction 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