Package org.springframework.boot.web.server

Enum Class Ssl.ClientAuth

java.lang.Object

java.lang.Enum<Ssl.ClientAuth>

org.springframework.boot.web.server.Ssl.ClientAuth

All Implemented Interfaces:

Serializable, Comparable<Ssl.ClientAuth>, Constable

Enclosing class:

Ssl

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

Client authentication types.

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
NEED	Client authentication is needed and mandatory.
NONE	Client authentication is not wanted.
WANT	Client authentication is wanted but not mandatory.

Method Summary

Modifier and Type	Method	Description
static <R> R	map(Ssl.ClientAuth clientAuth, R none, R want, R need)	Map an optional Ssl.ClientAuth value to a different type.
static Ssl.ClientAuth	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Ssl.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 Ssl.ClientAuth NONE

Client authentication is not wanted.

WANT

public static final Ssl.ClientAuth WANT

Client authentication is wanted but not mandatory.

NEED

public static final Ssl.ClientAuth NEED

Client authentication is needed and mandatory.

Method Details

values

public static Ssl.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 Ssl.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

map

public static <R> R map(Ssl.ClientAuth clientAuth,
 R none,
 R want,
 R need)

Map an optional Ssl.ClientAuth value to a different type.

Type Parameters:

R - the result type

Parameters:

clientAuth - the client auth to map (may be null)

none - the value for NONE or null

want - the value for WANT

need - the value for NEED

Returns:

the mapped value

Since:

3.1.0