Module io.inverno.mod.http.server

Package io.inverno.mod.http.server

Enum Class HttpServerConfiguration.ClientAuth

java.lang.Object

java.lang.Enum<HttpServerConfiguration.ClientAuth>

io.inverno.mod.http.server.HttpServerConfiguration.ClientAuth

All Implemented Interfaces:

Serializable, Comparable<HttpServerConfiguration.ClientAuth>, Constable

Enclosing interface:

HttpServerConfiguration

public static enum HttpServerConfiguration.ClientAuth
extends Enum<HttpServerConfiguration.ClientAuth>

The HTTP client authentication type.

Since:

1.7

Author:

Jeremy Kuhn

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
NONE	Indicates that client authentication will not be requested during TLS handshake.
REQUESTED	Indicates that client authentication will be requested during TLS handshake but that it is not required for the handshake to succeed.
REQUIRED	Indicates that client authentication will be requested during TLS handshake and that the handshake will fail if the client does not present authentication.

Method Summary

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

NONE

public static final HttpServerConfiguration.ClientAuth NONE

Indicates that client authentication will not be requested during TLS handshake.

REQUESTED

public static final HttpServerConfiguration.ClientAuth REQUESTED

Indicates that client authentication will be requested during TLS handshake but that it is not required for the handshake to succeed.

REQUIRED

public static final HttpServerConfiguration.ClientAuth REQUIRED

Indicates that client authentication will be requested during TLS handshake and that the handshake will fail if the client does not present authentication.

Method Details

values

public static HttpServerConfiguration.ClientAuth[] 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 HttpServerConfiguration.ClientAuth 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