Package org.ldaptive.sasl

Enum Mechanism

java.lang.Object

java.lang.Enum<Mechanism>

org.ldaptive.sasl.Mechanism

All Implemented Interfaces:

Serializable, Comparable<Mechanism>

public enum Mechanism
extends Enum<Mechanism>

Enum to define SASL mechanisms.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRAM_MD5	Cram MD5 authentication type.
DIGEST_MD5	Digest MD5 authentication type.
EXTERNAL	External authentication type.
GSSAPI	Kerberos authentication type.
SCRAM_SHA_1	SCRAM SHA1.
SCRAM_SHA_256	SCRAM SHA256.
SCRAM_SHA_512	SCRAM SHA512.

Field Summary

Fields

Modifier and Type	Field	Description
private String	mechanismName	SASL mechanism name.
private String[]	properties	Digest algorithm name.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Mechanism(String mechanism)	Creates a new mechanism.
private	Mechanism(String mechanism, String... props)	Creates a new mechanism.

Method Summary

Modifier and Type	Method	Description
String	mechanism()	Returns the name of this mechanism.
String[]	properties()	Returns any properties associated with this mechanism.
static Mechanism	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Mechanism[]	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

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 Detail

mechanismName

private final String mechanismName

SASL mechanism name.

properties

private final String[] properties

Digest algorithm name.

Constructor Detail

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 Detail

values

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

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