Module swim.io

Package swim.io

Enum Class ClientAuth

java.lang.Object

java.lang.Enum<ClientAuth>

swim.io.ClientAuth

All Implemented Interfaces:

Serializable, Comparable<ClientAuth>, Constable, swim.codec.Debug

public enum ClientAuth
extends Enum<ClientAuth>
implements swim.codec.Debug

Transport-layer security client authentication configuration.

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 required.
NONE	Client authentication disabled.
WANT	Client authentication requested.

Method Summary

Modifier and Type	Method	Description
<T> swim.codec.Output<T>	debug(swim.codec.Output<T> output)
static swim.structure.Form<ClientAuth>	form()	Returns the structural Form of ClientAuth.
static ClientAuth	from(String name)	Returns the ClientAuth with the given case-insensitive name, one of none, want, or need.
static ClientAuth	valueOf(String name)	Returns the enum constant of this class with the specified name.
static 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 ClientAuth NONE

Client authentication disabled.

WANT

public static final ClientAuth WANT

Client authentication requested.

NEED

public static final ClientAuth NEED

Client authentication required.

Method Details

values

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

debug

public <T> swim.codec.Output<T> debug(swim.codec.Output<T> output)

Specified by:

debug in interface swim.codec.Debug

from

public static ClientAuth from(String name)

Returns the ClientAuth with the given case-insensitive name, one of none, want, or need.

Throws:

IllegalArgumentException - if name is not a valid ClientAuth token.

form

@Kind
public static swim.structure.Form<ClientAuth> form()

Returns the structural Form of ClientAuth.