Package org.apache.kafka.clients.admin

Enum ScramMechanism

  • All Implemented Interfaces:
    Serializable, Comparable<ScramMechanism>
    public enum ScramMechanism
extends Enum<ScramMechanism>
    Representation of a SASL/SCRAM Mechanism.
    See Also:
    KIP-554: Add Broker-side SCRAM Config API This code is duplicated in org.apache.kafka.common.security.scram.internals.ScramMechanism. The type field in both files must match and must not change. The type field is used both for passing ScramCredentialUpsertion and for the internal UserScramCredentialRecord. Do not change the type field.

    • Method Detail

      • values

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

      • type

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