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

Enum SecurityProtocol

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SecurityProtocol>
    public enum SecurityProtocol
extends java.lang.Enum<SecurityProtocol>

    • 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
      short id
      The permanent and immutable id of a security protocol -- this can't change, and must match kafka.cluster.SecurityProtocol
      java.lang.String name
      Name of the security protocol.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SecurityProtocol forId​(short id)  
      static SecurityProtocol forName​(java.lang.String name)
      Case insensitive lookup by protocol name
      static java.util.List<java.lang.String> names()  
      static SecurityProtocol valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SecurityProtocol[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PLAINTEXT

        public static final SecurityProtocol PLAINTEXT
        Un-authenticated, non-encrypted 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 Detail

      • 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 java.lang.String name
        Name of the security protocol. This may be used by client configuration.

    • Method Detail

      • values

        public static SecurityProtocol[] 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 (SecurityProtocol c : SecurityProtocol.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SecurityProtocol valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • names

        public static java.util.List<java.lang.String> names()

      • forName

        public static SecurityProtocol forName​(java.lang.String name)
        Case insensitive lookup by protocol name