Enum Include
- java.lang.Object
- java.lang.Enum<Include>
- org.springframework.boot.actuate.trace.http.Include
- All Implemented Interfaces:
Serializable
,Comparable<Include>
public enum Include extends Enum<Include>
Include options for HTTP tracing.- Since:
- 2.0.0
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.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 in milliseconds.
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Set<Include>
defaultIncludes()
Return the defaultInclude
.static Include
valueOf(String name)
Returns the enum constant of this type with the specified name.static Include[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
Enum Constant Detail
REQUEST_HEADERS
public static final Include REQUEST_HEADERS
Include request headers.
RESPONSE_HEADERS
public static final Include RESPONSE_HEADERS
Include response headers.
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).
REMOTE_ADDRESS
public static final Include REMOTE_ADDRESS
Include the remote address.
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 in milliseconds.
Method Detail
values
public static Include[] 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 (Include c : Include.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
valueOf
public static Include valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
defaultIncludes
public static Set<Include> defaultIncludes()
Return the defaultInclude
.- Returns:
- the default include.