Package com.browserup.bup.proxy

Enum CaptureType

java.lang.Object

java.lang.Enum<CaptureType>

com.browserup.bup.proxy.CaptureType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CaptureType>

public enum CaptureType
extends java.lang.Enum<CaptureType>

Data types that the proxy can capture. Data types are organized into two broad categories, REQUEST_* and RESPONSE_*, corresponding to client requests and server responses.

Enum Constant Summary

Enum Constants

Enum Constant	Description
REQUEST_BINARY_CONTENT	Binary HTTP request content, such as file uploads, or any unrecognized request payload.
REQUEST_CONTENT	Non-binary HTTP request content, such as post data or other text-based request payload.
REQUEST_COOKIES	HTTP Cookies sent with the request.
REQUEST_HEADERS	HTTP request headers, including trailing headers.
RESPONSE_BINARY_CONTENT	Binary HTTP response content, such as image files, or any unrecognized response payload.
RESPONSE_CONTENT	Non-binary HTTP response content (typically, HTTP body content).
RESPONSE_COOKIES	Set-Cookie headers sent with the response.
RESPONSE_HEADERS	HTTP response headers, including trailing headers.

Method Summary

Modifier and Type	Method	Description
static java.util.EnumSet<CaptureType>	getAllContentCaptureTypes()
static java.util.EnumSet<CaptureType>	getBinaryContentCaptureTypes()
static java.util.EnumSet<CaptureType>	getCookieCaptureTypes()
static java.util.EnumSet<CaptureType>	getHeaderCaptureTypes()
static java.util.EnumSet<CaptureType>	getNonBinaryContentCaptureTypes()
static java.util.EnumSet<CaptureType>	getRequestCaptureTypes()
static java.util.EnumSet<CaptureType>	getResponseCaptureTypes()
static CaptureType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CaptureType[]	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

REQUEST_HEADERS

public static final CaptureType REQUEST_HEADERS

HTTP request headers, including trailing headers.

REQUEST_COOKIES

public static final CaptureType REQUEST_COOKIES

HTTP Cookies sent with the request.

REQUEST_CONTENT

public static final CaptureType REQUEST_CONTENT

Non-binary HTTP request content, such as post data or other text-based request payload. See BrowserUpHttpUtil.hasTextualContent(String) for a list of Content-Types that are considered non-binary.

REQUEST_BINARY_CONTENT

public static final CaptureType REQUEST_BINARY_CONTENT

Binary HTTP request content, such as file uploads, or any unrecognized request payload.

RESPONSE_HEADERS

public static final CaptureType RESPONSE_HEADERS

HTTP response headers, including trailing headers.

RESPONSE_COOKIES

public static final CaptureType RESPONSE_COOKIES

Set-Cookie headers sent with the response.

RESPONSE_CONTENT

public static final CaptureType RESPONSE_CONTENT

Non-binary HTTP response content (typically, HTTP body content). See BrowserUpHttpUtil.hasTextualContent(String) for a list of Content-Types that are considered non-binary.

RESPONSE_BINARY_CONTENT

public static final CaptureType RESPONSE_BINARY_CONTENT

Binary HTTP response content, such as image files, or any unrecognized response payload.

Method Detail

values

public static CaptureType[] 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 (CaptureType c : CaptureType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CaptureType 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

getRequestCaptureTypes

public static java.util.EnumSet<CaptureType> getRequestCaptureTypes()

Returns:

Set of CaptureTypes for requests.

getResponseCaptureTypes

public static java.util.EnumSet<CaptureType> getResponseCaptureTypes()

Returns:

Set of CaptureTypes for responses.

getHeaderCaptureTypes

public static java.util.EnumSet<CaptureType> getHeaderCaptureTypes()

Returns:

Set of CaptureTypes for headers.

getNonBinaryContentCaptureTypes

public static java.util.EnumSet<CaptureType> getNonBinaryContentCaptureTypes()

Returns:

Set of CaptureTypes for non-binary content.

getBinaryContentCaptureTypes

public static java.util.EnumSet<CaptureType> getBinaryContentCaptureTypes()

Returns:

Set of CaptureTypes for binary content.

getAllContentCaptureTypes

public static java.util.EnumSet<CaptureType> getAllContentCaptureTypes()

Returns:

Set of CaptureTypes for both binary and non-binary content.

getCookieCaptureTypes

public static java.util.EnumSet<CaptureType> getCookieCaptureTypes()

Returns:

Set of CaptureTypes for cookies.