io.grpc

Enum TlsServerCredentials.ClientAuth

java.lang.Object

java.lang.Enum<TlsServerCredentials.ClientAuth>

io.grpc.TlsServerCredentials.ClientAuth

All Implemented Interfaces:

Serializable, Comparable<TlsServerCredentials.ClientAuth>

Enclosing class:

TlsServerCredentials

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

The level of authentication the server should expect from the client.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Clients will not present any identity.
OPTIONAL Clients are requested to present their identity, but clients without identities are permitted.
REQUIRE Clients are requested to present their identity, and are required to provide a valid identity.

Method Summary

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

Clients will not present any identity.

OPTIONAL

public static final TlsServerCredentials.ClientAuth OPTIONAL

Clients are requested to present their identity, but clients without identities are permitted.

REQUIRE

public static final TlsServerCredentials.ClientAuth REQUIRE

Clients are requested to present their identity, and are required to provide a valid identity.

Method Detail

values

public static TlsServerCredentials.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 (TlsServerCredentials.ClientAuth c : TlsServerCredentials.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 TlsServerCredentials.ClientAuth 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