Package com.linecorp.armeria.server

Enum Class TransientServiceOption

java.lang.Object

java.lang.Enum<TransientServiceOption>

com.linecorp.armeria.server.TransientServiceOption

All Implemented Interfaces:

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

public enum TransientServiceOption
extends Enum<TransientServiceOption>

Specifies which features should be enabled for a TransientService. For example, if you do:

 ServerBuilder sb = Server.builder();
 sb.service("/health", HealthCheckService.builder() // A TransientService
                                         .transientServiceOptions(
                                                 TransientServiceOption.WITH_METRIC_COLLECTION,
                                                 TransientServiceOption.WITH_ACCESS_LOGGING)
                                         .build());
 

then, the metric is collected by MetricCollectingService and access logs are produced by AccessLogWriter for the HealthCheckService.

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
WITH_ACCESS_LOGGING	Enables AccessLogWriter to produce the access logs of the requests to the TransientService.
WITH_METRIC_COLLECTION	Enables MetricCollectingService to collect the metrics of the requests to the TransientService.
WITH_SERVICE_LOGGING	Enables LoggingService to log the requests to the TransientService.
WITH_TRACING	Enables to trace the requests to the TransientService.

Method Summary

Modifier and Type	Method	Description
static Set<TransientServiceOption>	allOf()	Returns all TransientServiceOptions.
static TransientServiceOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransientServiceOption[]	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

WITH_METRIC_COLLECTION

public static final TransientServiceOption WITH_METRIC_COLLECTION

Enables MetricCollectingService to collect the metrics of the requests to the TransientService.

WITH_SERVICE_LOGGING

public static final TransientServiceOption WITH_SERVICE_LOGGING

Enables LoggingService to log the requests to the TransientService.

WITH_ACCESS_LOGGING

public static final TransientServiceOption WITH_ACCESS_LOGGING

Enables AccessLogWriter to produce the access logs of the requests to the TransientService.

WITH_TRACING

public static final TransientServiceOption WITH_TRACING

Enables to trace the requests to the TransientService.

Method Details

values

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

allOf

public static Set<TransientServiceOption> allOf()

Returns all TransientServiceOptions.