com.linecorp.armeria.common.logging

Enum RequestLogAvailability

java.lang.Object

java.lang.Enum<RequestLogAvailability>

com.linecorp.armeria.common.logging.RequestLogAvailability

All Implemented Interfaces:

Serializable, Comparable<RequestLogAvailability>

public enum RequestLogAvailability
extends Enum<RequestLogAvailability>

Tells which properties are available in a RequestLog.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE All the properties mentioned in REQUEST_END and RESPONSE_END are available.
REQUEST_CONTENT RequestLog.requestContent() is available, as well as all the properties mentioned in REQUEST_START.
REQUEST_END RequestLog.requestLength(), RequestLog.requestCause() and RequestLog.requestDurationNanos() are available, as well as all the properties mentioned in REQUEST_START, SCHEME, REQUEST_HEADERS and REQUEST_CONTENT.
REQUEST_FIRST_BYTES_TRANSFERRED RequestLog.requestFirstBytesTransferredTimeNanos() is available, as well as all the properties mentioned in REQUEST_START.
REQUEST_HEADERS RequestLog.requestHeaders() is available, as well as all the properties mentioned in REQUEST_START.
REQUEST_START Request processing started.
RESPONSE_CONTENT RequestLog.responseContent() is available, as well as all the properties mentioned in RESPONSE_START.
RESPONSE_END RequestLog.responseLength(), RequestLog.responseCause(), RequestLog.responseDurationNanos() and RequestLog.totalDurationNanos() are available, as well as all the properties mentioned in RESPONSE_START, RESPONSE_HEADERS and RESPONSE_CONTENT.
RESPONSE_FIRST_BYTES_TRANSFERRED RequestLog.responseFirstBytesTransferredTimeNanos() is available, as well as all the properties mentioned in RESPONSE_START.
RESPONSE_HEADERS RequestLog.responseHeaders() is available, as well as all the properties mentioned in RESPONSE_START.
RESPONSE_START RequestLog.responseStartTimeMillis() is available.
SCHEME RequestLog.scheme() and RequestLog.serializationFormat() are available, as well as all the properties mentioned in REQUEST_START.

Method Summary

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

public static final RequestLogAvailability REQUEST_START

Request processing started. The following properties become available:

• RequestLog.requestStartTimeMillis()
• RequestLog.channel()
• RequestLog.sessionProtocol()
• RequestLog.authority()

SCHEME

public static final RequestLogAvailability SCHEME

RequestLog.scheme() and RequestLog.serializationFormat() are available, as well as all the properties mentioned in REQUEST_START.

REQUEST_FIRST_BYTES_TRANSFERRED

public static final RequestLogAvailability REQUEST_FIRST_BYTES_TRANSFERRED

RequestLog.requestFirstBytesTransferredTimeNanos() is available, as well as all the properties mentioned in REQUEST_START.

REQUEST_HEADERS

public static final RequestLogAvailability REQUEST_HEADERS

RequestLog.requestHeaders() is available, as well as all the properties mentioned in REQUEST_START.

REQUEST_CONTENT

public static final RequestLogAvailability REQUEST_CONTENT

RequestLog.requestContent() is available, as well as all the properties mentioned in REQUEST_START.

REQUEST_END

public static final RequestLogAvailability REQUEST_END

RequestLog.requestLength(), RequestLog.requestCause() and RequestLog.requestDurationNanos() are available, as well as all the properties mentioned in REQUEST_START, SCHEME, REQUEST_HEADERS and REQUEST_CONTENT.

RESPONSE_START

public static final RequestLogAvailability RESPONSE_START

RequestLog.responseStartTimeMillis() is available.

RESPONSE_FIRST_BYTES_TRANSFERRED

public static final RequestLogAvailability RESPONSE_FIRST_BYTES_TRANSFERRED

RequestLog.responseFirstBytesTransferredTimeNanos() is available, as well as all the properties mentioned in RESPONSE_START.

RESPONSE_HEADERS

public static final RequestLogAvailability RESPONSE_HEADERS

RequestLog.responseHeaders() is available, as well as all the properties mentioned in RESPONSE_START.

RESPONSE_CONTENT

public static final RequestLogAvailability RESPONSE_CONTENT

RequestLog.responseContent() is available, as well as all the properties mentioned in RESPONSE_START.

RESPONSE_END

public static final RequestLogAvailability RESPONSE_END

RequestLog.responseLength(), RequestLog.responseCause(), RequestLog.responseDurationNanos() and RequestLog.totalDurationNanos() are available, as well as all the properties mentioned in RESPONSE_START, RESPONSE_HEADERS and RESPONSE_CONTENT.

COMPLETE

public static final RequestLogAvailability COMPLETE

All the properties mentioned in REQUEST_END and RESPONSE_END are available. Note that REQUEST_FIRST_BYTES_TRANSFERRED and RESPONSE_FIRST_BYTES_TRANSFERRED may not be fulfilled if network transfer did not occur.

Method Detail

values

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

Returns:

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

valueOf

public static RequestLogAvailability 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 name

NullPointerException - if the argument is null