Enum Class OrgResourceIdValidationMode

java.lang.Object

java.lang.Enum<OrgResourceIdValidationMode>

io.confluent.kafka.server.plugins.auth.OrgResourceIdValidationMode

All Implemented Interfaces:

Serializable, Comparable<OrgResourceIdValidationMode>, Constable

public enum OrgResourceIdValidationMode
extends Enum<OrgResourceIdValidationMode>

Enum class that represents different modes of organization resource ID validation in the authenticator.

none: No organization verification is performed, even for Universal API Keys (UAKs). LKC resolution still occurs for UAKs, but org matching is skipped.

uak_only: Organization verification is performed only for Universal API Keys. Regular LKC-scoped API keys skip org verification (they use SNI-based LKC validation instead).

This mode can be configured through the JAAS config for TopicBasedPlainSaslAuthenticator.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE
UAK_ONLY

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORG_RESOURCE_ID_VALIDATION_MODE_KEY

Method Summary

Modifier and Type	Method	Description
static OrgResourceIdValidationMode	fromString(String text)
String	getText()
abstract boolean	shouldVerifyOrg(boolean isUniversalApiKey)	Determine if organization verification should be performed based on the key type.
static OrgResourceIdValidationMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OrgResourceIdValidationMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final OrgResourceIdValidationMode NONE

UAK_ONLY

public static final OrgResourceIdValidationMode UAK_ONLY

Field Details

ORG_RESOURCE_ID_VALIDATION_MODE_KEY

public static final String ORG_RESOURCE_ID_VALIDATION_MODE_KEY

See Also:

• Constant Field Values

Method Details

values

public static OrgResourceIdValidationMode[] 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 OrgResourceIdValidationMode 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

fromString

public static OrgResourceIdValidationMode fromString(String text)

getText

public String getText()

shouldVerifyOrg

public abstract boolean shouldVerifyOrg(boolean isUniversalApiKey)

Determine if organization verification should be performed based on the key type.

Parameters:

isUniversalApiKey - true if the API key is a Universal API Key (org-scoped), false if it's a regular LKC-scoped key

Returns:

true if org verification should be performed, false otherwise