Package org.springframework.boot.actuate.web.exchanges

Enum Class Include

java.lang.Object

java.lang.Enum<Include>

org.springframework.boot.actuate.web.exchanges.Include

All Implemented Interfaces:

Serializable, Comparable<Include>, Constable

public enum Include
extends Enum<Include>

Include options for HTTP exchanges.

Since:

3.0.0

Author:

Wallace Wadge, Emily Tsanova, Joseph Beeton

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
AUTHORIZATION_HEADER	Include authorization header (if any).
COOKIE_HEADERS	Include "Cookie" header (if any) in request headers and "Set-Cookie" (if any) in response headers.
PRINCIPAL	Include the principal.
REMOTE_ADDRESS	Include the remote address from the request.
REQUEST_HEADERS	Include request headers.
RESPONSE_HEADERS	Include response headers.
SESSION_ID	Include the session ID.
TIME_TAKEN	Include the time taken to service the request.

Method Summary

Modifier and Type	Method	Description
static Set<Include>	defaultIncludes()	Return the default Include.
static Include	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Include[]	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_HEADERS

public static final Include REQUEST_HEADERS

Include request headers.

REMOTE_ADDRESS

public static final Include REMOTE_ADDRESS

Include the remote address from the request.

COOKIE_HEADERS

public static final Include COOKIE_HEADERS

Include "Cookie" header (if any) in request headers and "Set-Cookie" (if any) in response headers.

AUTHORIZATION_HEADER

public static final Include AUTHORIZATION_HEADER

Include authorization header (if any).

RESPONSE_HEADERS

public static final Include RESPONSE_HEADERS

Include response headers.

PRINCIPAL

public static final Include PRINCIPAL

Include the principal.

SESSION_ID

public static final Include SESSION_ID

Include the session ID.

TIME_TAKEN

public static final Include TIME_TAKEN

Include the time taken to service the request.

Method Details

values

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

defaultIncludes

public static Set<Include> defaultIncludes()

Return the default Include.

Returns:

the default include.