io.confluent.kafka.server.plugins.auth

Enum DefaultDataPolicyValidationMode

java.lang.Object

java.lang.Enum<DefaultDataPolicyValidationMode>

io.confluent.kafka.server.plugins.auth.DefaultDataPolicyValidationMode

All Implemented Interfaces:

Serializable, Comparable<DefaultDataPolicyValidationMode>

public enum DefaultDataPolicyValidationMode
extends Enum<DefaultDataPolicyValidationMode>

Enum class that represents different modes of Default Data Policy validation in the authenticator.

none: default mode for the listeners: - no validation of the default data policy is done

strict: to be configured for flat networking listener: - requires - defaultDataPolicyEnabled to be true AND - localLkcEnvironmentId the same as environmentId AND - networkType to be PRIVATE.

This mode can be configured through the jaas config for #TopicBasedPlainSaslAuthenticator

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE
STRICT

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATA_POLICY_VALIDATION_MODE_KEY

Method Summary

Modifier and Type	Method and Description
static DefaultDataPolicyValidationMode	fromConfigs(Supplier<String> jaasConfigEntryOption)
static DefaultDataPolicyValidationMode	fromString(String text)
abstract boolean	trafficAllowed(boolean defaultDataPolicyEnabled, Optional<String> localLkcEnvironmentId, DefaultDataPolicyContext policyContext) Validate if the supplied environmentId and networkType are allowed to talk to this cluster.
static DefaultDataPolicyValidationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultDataPolicyValidationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 DefaultDataPolicyValidationMode NONE

STRICT

public static final DefaultDataPolicyValidationMode STRICT

Field Detail

DEFAULT_DATA_POLICY_VALIDATION_MODE_KEY

public static final String DEFAULT_DATA_POLICY_VALIDATION_MODE_KEY

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static DefaultDataPolicyValidationMode 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

fromString

public static DefaultDataPolicyValidationMode fromString(String text)

fromConfigs

public static DefaultDataPolicyValidationMode fromConfigs(Supplier<String> jaasConfigEntryOption)

trafficAllowed

public abstract boolean trafficAllowed(boolean defaultDataPolicyEnabled,
                                       Optional<String> localLkcEnvironmentId,
                                       DefaultDataPolicyContext policyContext)

Validate if the supplied environmentId and networkType are allowed to talk to this cluster.

Parameters:

defaultDataPolicyEnabled - Enabled if customer opts-in for the default data policy.

localLkcEnvironmentId - Local lkc environment id.

policyContext - The context that contains the client information like client's environment id.

Returns:

true if the traffic is allowed, false otherwise