Enum Class WebFluxProperties.HeaderFormat

java.lang.Object

java.lang.Enum<WebFluxProperties.HeaderFormat>

org.springframework.boot.webflux.autoconfigure.WebFluxProperties.HeaderFormat

All Implemented Interfaces:

Serializable, Comparable<WebFluxProperties.HeaderFormat>, Constable

Enclosing class:

WebFluxProperties

public static enum WebFluxProperties.HeaderFormat
extends Enum<WebFluxProperties.HeaderFormat>

Formats of forwarded headers supported by WebFluxProperties.Forwardedheaders.

Since:

4.0.0

Author:

Brian Clozel, Vedran Pavic

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
STANDARD	Use the standard "Forwarded" header, as defined by RFC 7239.
X_FORWARDED	Use the non-standard "X-Forwarded-*" headers.

Method Summary

Modifier and Type	Method	Description
static WebFluxProperties.HeaderFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebFluxProperties.HeaderFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STANDARD

public static final WebFluxProperties.HeaderFormat STANDARD

Use the standard "Forwarded" header, as defined by RFC 7239.

X_FORWARDED

public static final WebFluxProperties.HeaderFormat X_FORWARDED

Use the non-standard "X-Forwarded-*" headers.

Method Details

values

public static WebFluxProperties.HeaderFormat[] 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 WebFluxProperties.HeaderFormat 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