Package com.linecorp.armeria.spring

Enum Class InternalServiceId

java.lang.Object

java.lang.Enum<InternalServiceId>

com.linecorp.armeria.spring.InternalServiceId

All Implemented Interfaces:

Serializable, Comparable<InternalServiceId>, Constable

@UnstableApi
public enum InternalServiceId
extends Enum<InternalServiceId>

Defines the IDs of internal HttpServices that should not be exposed to the external network.

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
ACTUATOR	The ID to bind WebOperationService into internal service.
ALL	The ID that represents all internal HttpServices.
DOCS	The ID of DocService.
HEALTH	The ID of HttpService.
METRICS	The ID of PrometheusExpositionService.

Method Summary

Modifier and Type	Method	Description
static List<InternalServiceId>	defaultServiceIds()	Returns the default service IDs that need to secure from the external network.
static InternalServiceId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InternalServiceId[]	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

DOCS

public static final InternalServiceId DOCS

The ID of DocService.

HEALTH

public static final InternalServiceId HEALTH

The ID of HttpService.

METRICS

public static final InternalServiceId METRICS

The ID of PrometheusExpositionService.

ACTUATOR

public static final InternalServiceId ACTUATOR

The ID to bind WebOperationService into internal service.

ALL

public static final InternalServiceId ALL

The ID that represents all internal HttpServices.

Method Details

values

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

defaultServiceIds

public static List<InternalServiceId> defaultServiceIds()

Returns the default service IDs that need to secure from the external network.