Enum Class RemoteIp.Usage

java.lang.Object

java.lang.Enum<RemoteIp.Usage>

org.springframework.boot.tomcat.RemoteIp.Usage

All Implemented Interfaces:

Serializable, Comparable<RemoteIp.Usage>, Constable

Enclosing class:

RemoteIp

public static enum RemoteIp.Usage
extends Enum<RemoteIp.Usage>

Since:

4.2.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always configure the remote IP valve.
FOR_FORWARDED_REQUEST_HEADERS	Only configure the remote IP value when the server has a non-null ForwardedRequestHeaders configuration.

Method Summary

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

ALWAYS

public static final RemoteIp.Usage ALWAYS

Always configure the remote IP valve.

FOR_FORWARDED_REQUEST_HEADERS

public static final RemoteIp.Usage FOR_FORWARDED_REQUEST_HEADERS

Only configure the remote IP value when the server has a non-null ForwardedRequestHeaders configuration.

Method Details

values

public static RemoteIp.Usage[] 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 RemoteIp.Usage 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