Module io.helidon.webserver

Package io.helidon.webserver

Enum SocketConfiguration.RequestedUriDiscoveryType

java.lang.Object

java.lang.Enum<SocketConfiguration.RequestedUriDiscoveryType>

io.helidon.webserver.SocketConfiguration.RequestedUriDiscoveryType

All Implemented Interfaces:

Serializable, Comparable<SocketConfiguration.RequestedUriDiscoveryType>

Enclosing interface:

SocketConfiguration

public static enum SocketConfiguration.RequestedUriDiscoveryType
extends Enum<SocketConfiguration.RequestedUriDiscoveryType>

Types of discovery of frontend uri. Defaults to HOST when frontend uri discovery is disabled (uses only Host header and information about current request to determine scheme, host, port, and path). Defaults to FORWARDED when discovery is enabled. Can be explicitly configured on socket configuration builder.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORWARDED	The Http.Header.FORWARDED header is used to discover the original requested URI.
HOST	This is the default, only the Http.Header.HOST header is used to discover requested URI.
X_FORWARDED	The Http.Header.X_FORWARDED_PROTO, Http.Header.X_FORWARDED_HOST, Http.Header.X_FORWARDED_PORT, Http.Header.X_FORWARDED_PREFIX headers are used to discover the original requested URI.

Method Summary

Modifier and Type	Method	Description
static SocketConfiguration.RequestedUriDiscoveryType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SocketConfiguration.RequestedUriDiscoveryType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORWARDED

public static final SocketConfiguration.RequestedUriDiscoveryType FORWARDED

The Http.Header.FORWARDED header is used to discover the original requested URI.

X_FORWARDED

public static final SocketConfiguration.RequestedUriDiscoveryType X_FORWARDED

The Http.Header.X_FORWARDED_PROTO, Http.Header.X_FORWARDED_HOST, Http.Header.X_FORWARDED_PORT, Http.Header.X_FORWARDED_PREFIX headers are used to discover the original requested URI.

HOST

public static final SocketConfiguration.RequestedUriDiscoveryType HOST

This is the default, only the Http.Header.HOST header is used to discover requested URI.

Method Detail

values

public static SocketConfiguration.RequestedUriDiscoveryType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SocketConfiguration.RequestedUriDiscoveryType c : SocketConfiguration.RequestedUriDiscoveryType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SocketConfiguration.RequestedUriDiscoveryType 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