Package org.ldaptive.sasl
Enum Class Mechanism
- All Implemented Interfaces:
Serializable
,Comparable<Mechanism>
,Constable
Enum to define SASL mechanisms.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionCram MD5 authentication type.Digest MD5 authentication type.External authentication type.Kerberos authentication type.SCRAM SHA1.SCRAM SHA256.SCRAM SHA512. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of this mechanism.String[]
Returns any properties associated with this mechanism.static Mechanism
Returns the enum constant of this class with the specified name.static Mechanism[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
EXTERNAL
External authentication type. -
DIGEST_MD5
Digest MD5 authentication type. -
CRAM_MD5
Cram MD5 authentication type. -
GSSAPI
Kerberos authentication type. -
SCRAM_SHA_1
SCRAM SHA1. -
SCRAM_SHA_256
SCRAM SHA256. -
SCRAM_SHA_512
SCRAM SHA512.
-
-
Field Details
-
mechanismName
SASL mechanism name. -
properties
Digest algorithm name.
-
-
Constructor Details
-
Mechanism
Creates a new mechanism.- Parameters:
mechanism
- SASL mechanism name
-
Mechanism
Creates a new mechanism.- Parameters:
mechanism
- SASL mechanism nameprops
- mechanism properties
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
mechanism
Returns the name of this mechanism.- Returns:
- mechanism name
-
properties
Returns any properties associated with this mechanism.- Returns:
- mechanism properties or null
-