Module crypt.api

Package io.github.astrapi69.crypt.api.mechanism

Enum Class SaslClientMechanism

java.lang.Object

java.lang.Enum<SaslClientMechanism>

io.github.astrapi69.crypt.api.mechanism.SaslClientMechanism

All Implemented Interfaces:

Mechanism, Serializable, Comparable<SaslClientMechanism>, Constable

public enum SaslClientMechanism
extends Enum<SaslClientMechanism>
implements Mechanism

The enum SaslClientMechanism provides all the algorithm names that can be specified * when generating an instance of javax.security.sasl.SaslClient. For more info see: https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#exemption-mechanisms

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRAM_MD5	The enum constant CRAM_MD5
DIGEST_MD5	The enum constant DIGEST_MD5
EXTERNAL	The enum constant EXTERNAL
GSSAPI	The enum constant GSSAPI
NTLM	The enum constant NTLM
PLAIN	The enum constant PLAIN
UNKNOWN	The enum constant 'UNKNOWN' if the SaslClient mechanism name is unknown

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRAM_MD5_MECHANISM_NAME	The string constant CRAM_MD5_MECHANISM_NAME
static final String	DIGEST_MD5_MECHANISM_NAME	The string constant DIGEST_MD5_MECHANISM_NAME
static final String	EXTERNAL_MECHANISM_NAME	The string constant EXTERNAL_MECHANISM_NAME
static final String	GSSAPI_MECHANISM_NAME	The string constant GSSAPI_MECHANISM_NAME
static final String	NTLM_MECHANISM_NAME	The string constant NTLM_MECHANISM_NAME
static final String	PLAIN_MECHANISM_NAME	The string constant PLAIN_MECHANISM_NAME

Fields inherited from interface io.github.astrapi69.crypt.api.mechanism.Mechanism

UNKNOWN_MECHANISM_NAME

Method Summary

Modifier and Type	Method	Description
String	getMechanism()	Gets the mechanism
static SaslClientMechanism	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SaslClientMechanism[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CRAM_MD5

public static final SaslClientMechanism CRAM_MD5

The enum constant CRAM_MD5

DIGEST_MD5

public static final SaslClientMechanism DIGEST_MD5

The enum constant DIGEST_MD5

EXTERNAL

public static final SaslClientMechanism EXTERNAL

The enum constant EXTERNAL

GSSAPI

public static final SaslClientMechanism GSSAPI

The enum constant GSSAPI

NTLM

public static final SaslClientMechanism NTLM

The enum constant NTLM

PLAIN

public static final SaslClientMechanism PLAIN

The enum constant PLAIN

UNKNOWN

public static final SaslClientMechanism UNKNOWN

The enum constant 'UNKNOWN' if the SaslClient mechanism name is unknown

Field Details

CRAM_MD5_MECHANISM_NAME

public static final String CRAM_MD5_MECHANISM_NAME

The string constant CRAM_MD5_MECHANISM_NAME

See Also:

• Constant Field Values

DIGEST_MD5_MECHANISM_NAME

public static final String DIGEST_MD5_MECHANISM_NAME

The string constant DIGEST_MD5_MECHANISM_NAME

See Also:

• Constant Field Values

EXTERNAL_MECHANISM_NAME

public static final String EXTERNAL_MECHANISM_NAME

The string constant EXTERNAL_MECHANISM_NAME

See Also:

• Constant Field Values

GSSAPI_MECHANISM_NAME

public static final String GSSAPI_MECHANISM_NAME

The string constant GSSAPI_MECHANISM_NAME

See Also:

• Constant Field Values

NTLM_MECHANISM_NAME

public static final String NTLM_MECHANISM_NAME

The string constant NTLM_MECHANISM_NAME

See Also:

• Constant Field Values

PLAIN_MECHANISM_NAME

public static final String PLAIN_MECHANISM_NAME

The string constant PLAIN_MECHANISM_NAME

See Also:

• Constant Field Values

Method Details

values

public static SaslClientMechanism[] 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 SaslClientMechanism 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

getMechanism

public String getMechanism()

Gets the mechanism

Specified by:

getMechanism in interface Mechanism

Returns:

the mechanism