Package io.opentelemetry.instrumentation.api.instrumenter.http

Enum HttpServerRouteSource

java.lang.Object

java.lang.Enum<HttpServerRouteSource>

io.opentelemetry.instrumentation.api.instrumenter.http.HttpServerRouteSource

All Implemented Interfaces:

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

public enum HttpServerRouteSource
extends Enum<HttpServerRouteSource>

Represents the source that provided the http.route attribute.

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
CONTROLLER	Represents the controller, usually defined as part of some MVC framework.
NESTED_CONTROLLER	Represents a nested controller, usually defined as part of some MVC framework.
SERVER	Represents the actual server handler.
SERVER_FILTER	Represents a "filter" that may execute before the actual server handler.

Method Summary

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

SERVER_FILTER

public static final HttpServerRouteSource SERVER_FILTER

Represents a "filter" that may execute before the actual server handler. E.g. the Servlet API Filter interface. Since multiple filters may match the same request, the one with the longest (most detailed) route will be chosen.

SERVER

public static final HttpServerRouteSource SERVER

Represents the actual server handler. E.g. the Servlet API Servlet interface.

CONTROLLER

public static final HttpServerRouteSource CONTROLLER

Represents the controller, usually defined as part of some MVC framework. E.g. a Spring Web MVC controller method, or a JAX-RS annotated resource method.

NESTED_CONTROLLER

public static final HttpServerRouteSource NESTED_CONTROLLER

Represents a nested controller, usually defined as part of some MVC framework. E.g. a JAX-RS annotated sub-resource method. Since multiple nested controllers may match the same request, the one with the longest (most detailed) route will be chosen.

Method Details

values

public static HttpServerRouteSource[] values()

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

Returns:

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

valueOf

public static HttpServerRouteSource 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