io.netty.handler.ssl

Enum ClientAuth

java.lang.Object

java.lang.Enum<ClientAuth>

io.netty.handler.ssl.ClientAuth

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClientAuth>

public enum ClientAuth
extends java.lang.Enum<ClientAuth>

Indicates the state of the SSLEngine with respect to client authentication. This configuration item really only applies when building the server-side SslContext.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Indicates that the SSLEngine will not request client authentication.
OPTIONAL Indicates that the SSLEngine will request client authentication.
REQUIRE Indicates that the SSLEngine will *require* client authentication.

Method Summary

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

NONE

public static final ClientAuth NONE

Indicates that the SSLEngine will not request client authentication.

OPTIONAL

public static final ClientAuth OPTIONAL

Indicates that the SSLEngine will request client authentication.

REQUIRE

public static final ClientAuth REQUIRE

Indicates that the SSLEngine will *require* client authentication.

Method Detail

values

public static ClientAuth[] 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 (ClientAuth c : ClientAuth.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientAuth valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null