Package org.apache.kafka.common.security.auth

Enum Class SecurityProtocol

java.lang.Object

java.lang.Enum<SecurityProtocol>

org.apache.kafka.common.security.auth.SecurityProtocol

All Implemented Interfaces:

Serializable, Comparable<SecurityProtocol>, Constable

public enum SecurityProtocol
extends Enum<SecurityProtocol>

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
PLAINTEXT	Un-authenticated, non-encrypted channel
SASL_PLAINTEXT	SASL authenticated, non-encrypted channel
SASL_SSL	SASL authenticated, SSL channel
SSL	SSL channel

Field Summary

Fields

Modifier and Type	Field	Description
final short	id	The permanent and immutable id of a security protocol -- this can't change, and must match kafka.cluster.SecurityProtocol
final String	name	Name of the security protocol.

Method Summary

Modifier and Type	Method	Description
static SecurityProtocol	forId(short id)
static SecurityProtocol	forName(String name)	Case insensitive lookup by protocol name
static List<String>	names()
static SecurityProtocol	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecurityProtocol[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAINTEXT

public static final SecurityProtocol PLAINTEXT

Un-authenticated, non-encrypted channel

SSL

public static final SecurityProtocol SSL

SSL channel

SASL_PLAINTEXT

public static final SecurityProtocol SASL_PLAINTEXT

SASL authenticated, non-encrypted channel

SASL_SSL

public static final SecurityProtocol SASL_SSL

SASL authenticated, SSL channel

Field Details

id

public final short id

The permanent and immutable id of a security protocol -- this can't change, and must match kafka.cluster.SecurityProtocol

name

public final String name

Name of the security protocol. This may be used by client configuration.

Method Details

values

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

names

public static List<String> names()

forId

public static SecurityProtocol forId(short id)

forName

public static SecurityProtocol forName(String name)

Case insensitive lookup by protocol name