org.apache.nifi.security.util

Enum ClientAuth

java.lang.Object

java.lang.Enum<ClientAuth>

org.apache.nifi.security.util.ClientAuth

All Implemented Interfaces:

Serializable, Comparable<ClientAuth>

public enum ClientAuth
extends Enum<ClientAuth>

This enum is used to indicate the three possible options for a server requesting a client certificate during TLS handshake negotiation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE
REQUIRED
WANT

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	type

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getType()
static boolean	isValidClientAuthType(String type) Returns true if the provided type is a valid ClientAuth type.
String	toString()
static ClientAuth	valueOf(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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WANT

public static final ClientAuth WANT

REQUIRED

public static final ClientAuth REQUIRED

NONE

public static final ClientAuth NONE

Field Detail

type

private final String type

description

private final String description

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(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

getType

public String getType()

getDescription

public String getDescription()

toString

public String toString()

Overrides:

toString in class Enum<ClientAuth>

isValidClientAuthType

public static boolean isValidClientAuthType(String type)

Returns true if the provided type is a valid ClientAuth type.

Parameters:

type - the raw type string

Returns:

true if the type is valid