com.hivemq.spi.services.configuration.entity

Enum Tls.ClientAuthMode

java.lang.Object

java.lang.Enum<Tls.ClientAuthMode>

com.hivemq.spi.services.configuration.entity.Tls.ClientAuthMode

All Implemented Interfaces:

Serializable, Comparable<Tls.ClientAuthMode>

Enclosing class:

Tls

public static enum Tls.ClientAuthMode
extends Enum<Tls.ClientAuthMode>

The X509 client certificate authentication mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Clients are not allowed to send X509 client certificates
OPTIONAL Clients can send X509 client certificates but they're not required to do so
REQUIRED Clients must send X509 client certificates

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientAuthMode()
String	toString()
static Tls.ClientAuthMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Tls.ClientAuthMode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Tls.ClientAuthMode NONE

Clients are not allowed to send X509 client certificates

OPTIONAL

public static final Tls.ClientAuthMode OPTIONAL

Clients can send X509 client certificates but they're not required to do so

REQUIRED

public static final Tls.ClientAuthMode REQUIRED

Clients must send X509 client certificates

Method Detail

values

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

Returns:

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

valueOf

public static Tls.ClientAuthMode 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

getClientAuthMode

public String getClientAuthMode()

Returns:

the client authentication mode

toString

public String toString()

Overrides:

toString in class Enum<Tls.ClientAuthMode>