Package org.microproxy

Enum Class HttpFiltersBuilder.Body

java.lang.Object

java.lang.Enum<HttpFiltersBuilder.Body>

org.microproxy.HttpFiltersBuilder.Body

All Implemented Interfaces:

Serializable, Comparable<HttpFiltersBuilder.Body>, Constable

Enclosing class:

HttpFiltersBuilder

public static enum HttpFiltersBuilder.Body
extends Enum<HttpFiltersBuilder.Body>

The streams a built filter inspects piece by piece.

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
OBSERVED_WEBSOCKET_FRAMES	WebSocket frames, only watched (HttpFilters.webSocketFrameReceived(WebSocketFrame, boolean)), such as an HttpLogger logging frames; the upgrade is left alone.
REQUEST	Request body pieces (HttpFiltersBuilder.onRequestBody).
RESPONSE	Response body pieces (HttpFiltersBuilder.onResponseBody).
WEBSOCKET_FRAMES	WebSocket frames, rewritten (HttpFiltersBuilder.onWebSocketFrame).
WEBSOCKET_MESSAGES	Whole WebSocket messages, joined from their frames and rewritten (HttpFiltersBuilder.onWebSocketMessage).

Method Summary

Modifier and Type	Method	Description
static HttpFiltersBuilder.Body	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpFiltersBuilder.Body[]	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

REQUEST

public static final HttpFiltersBuilder.Body REQUEST

Request body pieces (HttpFiltersBuilder.onRequestBody).

RESPONSE

public static final HttpFiltersBuilder.Body RESPONSE

Response body pieces (HttpFiltersBuilder.onResponseBody).

WEBSOCKET_FRAMES

public static final HttpFiltersBuilder.Body WEBSOCKET_FRAMES

WebSocket frames, rewritten (HttpFiltersBuilder.onWebSocketFrame).

WEBSOCKET_MESSAGES

public static final HttpFiltersBuilder.Body WEBSOCKET_MESSAGES

Whole WebSocket messages, joined from their frames and rewritten (HttpFiltersBuilder.onWebSocketMessage).

OBSERVED_WEBSOCKET_FRAMES

public static final HttpFiltersBuilder.Body OBSERVED_WEBSOCKET_FRAMES

WebSocket frames, only watched (HttpFilters.webSocketFrameReceived(WebSocketFrame, boolean)), such as an HttpLogger logging frames; the upgrade is left alone.

Method Details

values

public static HttpFiltersBuilder.Body[] 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 HttpFiltersBuilder.Body 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