Enum Class Mechanism

java.lang.Object
java.lang.Enum<Mechanism>
org.ldaptive.sasl.Mechanism
All Implemented Interfaces:
Serializable, Comparable<Mechanism>, Constable

public enum Mechanism extends Enum<Mechanism>
Enum to define SASL mechanisms.
  • Enum Constant Details

    • EXTERNAL

      public static final Mechanism EXTERNAL
      External authentication type.
    • DIGEST_MD5

      public static final Mechanism DIGEST_MD5
      Digest MD5 authentication type.
    • CRAM_MD5

      public static final Mechanism CRAM_MD5
      Cram MD5 authentication type.
    • GSSAPI

      public static final Mechanism GSSAPI
      Kerberos authentication type.
    • SCRAM_SHA_1

      public static final Mechanism SCRAM_SHA_1
      SCRAM SHA1.
    • SCRAM_SHA_256

      public static final Mechanism SCRAM_SHA_256
      SCRAM SHA256.
    • SCRAM_SHA_512

      public static final Mechanism SCRAM_SHA_512
      SCRAM SHA512.
  • Field Details

    • mechanismName

      private final String mechanismName
      SASL mechanism name.
    • properties

      private final String[] properties
      Digest algorithm name.
  • Constructor Details

    • Mechanism

      private Mechanism(String mechanism)
      Creates a new mechanism.
      Parameters:
      mechanism - SASL mechanism name
    • Mechanism

      private Mechanism(String mechanism, String... props)
      Creates a new mechanism.
      Parameters:
      mechanism - SASL mechanism name
      props - mechanism properties
  • Method Details

    • values

      public static Mechanism[] 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 Mechanism 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
    • mechanism

      public String mechanism()
      Returns the name of this mechanism.
      Returns:
      mechanism name
    • properties

      public String[] properties()
      Returns any properties associated with this mechanism.
      Returns:
      mechanism properties or null