Package com.linecorp.armeria.common.logging

Enum Class RequestLogProperty

java.lang.Object

java.lang.Enum<RequestLogProperty>

com.linecorp.armeria.common.logging.RequestLogProperty

All Implemented Interfaces:

Serializable, Comparable<RequestLogProperty>, java.lang.constant.Constable

public enum RequestLogProperty
extends Enum<RequestLogProperty>

A property of RequestLog, used for identifying properties that have been populated during request processing.

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
AUTHENTICATED_USER	RequestOnlyLog.authenticatedUser().
NAME	RequestOnlyLog.name(), RequestOnlyLog.serviceName(), RequestOnlyLog.fullName().
REQUEST_CAUSE	RequestOnlyLog.requestCause().
REQUEST_CONTENT	RequestOnlyLog.requestContent(), RequestOnlyLog.rawRequestContent().
REQUEST_CONTENT_PREVIEW	RequestOnlyLog.requestContentPreview().
REQUEST_END_TIME	RequestOnlyLog.requestEndTimeNanos(), RequestOnlyLog.requestDurationNanos().
REQUEST_FIRST_BYTES_TRANSFERRED_TIME	RequestOnlyLog.requestFirstBytesTransferredTimeNanos().
REQUEST_HEADERS	RequestOnlyLog.requestHeaders().
REQUEST_LENGTH	RequestOnlyLog.requestLength().
REQUEST_START_TIME	RequestOnlyLog.requestStartTimeMicros(), RequestOnlyLog.requestStartTimeMillis(), RequestOnlyLog.requestStartTimeNanos().
REQUEST_TRAILERS	RequestOnlyLog.requestTrailers().
RESPONSE_CAUSE	RequestLog.responseCause().
RESPONSE_CONTENT	RequestLog.responseContent().
RESPONSE_CONTENT_PREVIEW	RequestLog.responseContentPreview().
RESPONSE_END_TIME	RequestLog.responseEndTimeNanos(), RequestLog.responseDurationNanos(), RequestLog.totalDurationNanos().
RESPONSE_FIRST_BYTES_TRANSFERRED_TIME	RequestLog.responseFirstBytesTransferredTimeNanos().
RESPONSE_HEADERS	RequestLog.responseHeaders().
RESPONSE_LENGTH	RequestLog.responseLength().
RESPONSE_START_TIME	RequestLog.responseStartTimeMicros(), RequestLog.responseStartTimeMillis(), RequestLog.responseStartTimeNanos().
RESPONSE_TRAILERS	RequestLog.responseTrailers().
SCHEME	RequestOnlyLog.scheme().
SESSION	RequestOnlyLog.channel(), RequestOnlyLog.sessionProtocol(), RequestOnlyLog.sslSession(), RequestOnlyLog.connectionTimings().

Method Summary

Modifier and Type	Method	Description
static Set<RequestLogProperty>	allProperties()	Returns all of the RequestLogPropertys.
boolean	isAvailable(int flags)	Check if this property is available by using the specified flags which represents the currently available properties.
static Set<RequestLogProperty>	requestProperties()	Returns the RequestLogPropertys for requests.
static Set<RequestLogProperty>	responseProperties()	Returns the RequestLogPropertys for responses.
static RequestLogProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RequestLogProperty[]	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_START_TIME

public static final RequestLogProperty REQUEST_START_TIME

RequestOnlyLog.requestStartTimeMicros(), RequestOnlyLog.requestStartTimeMillis(), RequestOnlyLog.requestStartTimeNanos().

REQUEST_END_TIME

public static final RequestLogProperty REQUEST_END_TIME

RequestOnlyLog.requestEndTimeNanos(), RequestOnlyLog.requestDurationNanos().

REQUEST_FIRST_BYTES_TRANSFERRED_TIME

public static final RequestLogProperty REQUEST_FIRST_BYTES_TRANSFERRED_TIME

RequestOnlyLog.requestFirstBytesTransferredTimeNanos().

SESSION

public static final RequestLogProperty SESSION

RequestOnlyLog.channel(), RequestOnlyLog.sessionProtocol(), RequestOnlyLog.sslSession(), RequestOnlyLog.connectionTimings().

SCHEME

public static final RequestLogProperty SCHEME

RequestOnlyLog.scheme().

NAME

public static final RequestLogProperty NAME

RequestOnlyLog.name(), RequestOnlyLog.serviceName(), RequestOnlyLog.fullName().

AUTHENTICATED_USER

public static final RequestLogProperty AUTHENTICATED_USER

RequestOnlyLog.authenticatedUser().

REQUEST_HEADERS

public static final RequestLogProperty REQUEST_HEADERS

RequestOnlyLog.requestHeaders().

REQUEST_CONTENT

public static final RequestLogProperty REQUEST_CONTENT

RequestOnlyLog.requestContent(), RequestOnlyLog.rawRequestContent().

REQUEST_CONTENT_PREVIEW

public static final RequestLogProperty REQUEST_CONTENT_PREVIEW

RequestOnlyLog.requestContentPreview().

REQUEST_TRAILERS

public static final RequestLogProperty REQUEST_TRAILERS

RequestOnlyLog.requestTrailers().

REQUEST_LENGTH

public static final RequestLogProperty REQUEST_LENGTH

RequestOnlyLog.requestLength().

REQUEST_CAUSE

public static final RequestLogProperty REQUEST_CAUSE

RequestOnlyLog.requestCause().

RESPONSE_START_TIME

public static final RequestLogProperty RESPONSE_START_TIME

RequestLog.responseStartTimeMicros(), RequestLog.responseStartTimeMillis(), RequestLog.responseStartTimeNanos().

RESPONSE_END_TIME

public static final RequestLogProperty RESPONSE_END_TIME

RequestLog.responseEndTimeNanos(), RequestLog.responseDurationNanos(), RequestLog.totalDurationNanos().

RESPONSE_FIRST_BYTES_TRANSFERRED_TIME

public static final RequestLogProperty RESPONSE_FIRST_BYTES_TRANSFERRED_TIME

RequestLog.responseFirstBytesTransferredTimeNanos().

RESPONSE_HEADERS

public static final RequestLogProperty RESPONSE_HEADERS

RequestLog.responseHeaders().

RESPONSE_CONTENT

public static final RequestLogProperty RESPONSE_CONTENT

RequestLog.responseContent().

RESPONSE_CONTENT_PREVIEW

public static final RequestLogProperty RESPONSE_CONTENT_PREVIEW

RequestLog.responseContentPreview().

RESPONSE_TRAILERS

public static final RequestLogProperty RESPONSE_TRAILERS

RequestLog.responseTrailers().

RESPONSE_LENGTH

public static final RequestLogProperty RESPONSE_LENGTH

RequestLog.responseLength().

RESPONSE_CAUSE

public static final RequestLogProperty RESPONSE_CAUSE

RequestLog.responseCause().

Method Details

values

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

requestProperties

public static Set<RequestLogProperty> requestProperties()

Returns the RequestLogPropertys for requests.

responseProperties

public static Set<RequestLogProperty> responseProperties()

Returns the RequestLogPropertys for responses.

allProperties

public static Set<RequestLogProperty> allProperties()

Returns all of the RequestLogPropertys.

isAvailable

public boolean isAvailable(int flags)

Check if this property is available by using the specified flags which represents the currently available properties.