Enum Class KafkaJaasLoginModuleInitializer.ControlFlag

java.lang.Object

java.lang.Enum<KafkaJaasLoginModuleInitializer.ControlFlag>

org.springframework.kafka.security.jaas.KafkaJaasLoginModuleInitializer.ControlFlag

All Implemented Interfaces:

Serializable, Comparable<KafkaJaasLoginModuleInitializer.ControlFlag>, Constable

Enclosing class:

KafkaJaasLoginModuleInitializer

public static enum KafkaJaasLoginModuleInitializer.ControlFlag
extends Enum<KafkaJaasLoginModuleInitializer.ControlFlag>

Control flag values for login configuration.

Since:

1.3

Author:

Marius Bogoevici, Gary Russell, Edan Idzerda, Soby Chacko

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
OPTIONAL	Optional - The LoginModule is not required to succeed.
REQUIRED	Required - The LoginModule is required to succeed.
REQUISITE	Requisite - The LoginModule is required to succeed.
SUFFICIENT	Sufficient - The LoginModule is not required to succeed.

Method Summary

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

REQUIRED

public static final KafkaJaasLoginModuleInitializer.ControlFlag REQUIRED

Required - The LoginModule is required to succeed. If it succeeds or fails, authentication still continues to proceed down the LoginModule list.

REQUISITE

public static final KafkaJaasLoginModuleInitializer.ControlFlag REQUISITE

Requisite - The LoginModule is required to succeed. If it succeeds, authentication continues down the LoginModule list. If it fails, control immediately returns to the application (authentication does not proceed down the LoginModule list).

SUFFICIENT

public static final KafkaJaasLoginModuleInitializer.ControlFlag SUFFICIENT

Sufficient - The LoginModule is not required to succeed. If it does succeed, control immediately returns to the application (authentication does not proceed down the LoginModule list). If it fails, authentication continues down the LoginModule list.

OPTIONAL

public static final KafkaJaasLoginModuleInitializer.ControlFlag OPTIONAL

Optional - The LoginModule is not required to succeed. If it succeeds or fails, authentication still continues to proceed down the LoginModule list.

Method Details

values

public static KafkaJaasLoginModuleInitializer.ControlFlag[] 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 KafkaJaasLoginModuleInitializer.ControlFlag 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