Package org.apache.kafka.clients.admin

Enum ScramMechanism

java.lang.Object
java.lang.Enum<ScramMechanism>
org.apache.kafka.clients.admin.ScramMechanism
All Implemented Interfaces:
Serializable, Comparable<ScramMechanism>, Constable
public enum ScramMechanism
extends Enum<ScramMechanism>
Representation of a SASL/SCRAM Mechanism.
See Also:
KIP-554: Add Broker-side SCRAM Config API

  • Enum Constant Details

  • Method Details

    • values

      public static ScramMechanism[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • fromType

      public static ScramMechanism fromType​(byte type)
      Parameters:
      type - the type indicator
      Returns:
      the instance corresponding to the given type indicator, otherwise UNKNOWN

    • fromMechanismName

      public static ScramMechanism fromMechanismName​(String mechanismName)
      Parameters:
      mechanismName - the SASL SCRAM mechanism name
      Returns:
      the corresponding SASL SCRAM mechanism enum, otherwise UNKNOWN
      See Also:

      mechanismName

      public String mechanismName()
      Returns:
      the corresponding SASL SCRAM mechanism name
      See Also:

      type

      public byte type()
      Returns:
      the type indicator for this SASL SCRAM mechanism