Package com.couchbase.client.core.env

Enum SaslMechanism

java.lang.Object

java.lang.Enum<SaslMechanism>

com.couchbase.client.core.env.SaslMechanism

All Implemented Interfaces:

Serializable, Comparable<SaslMechanism>, java.lang.constant.Constable

public enum SaslMechanism
extends Enum<SaslMechanism>

Describes the support SASL authentication 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
PLAIN
SCRAM_SHA1
SCRAM_SHA256
SCRAM_SHA512

Method Summary

Modifier and Type	Method	Description
static SaslMechanism	from(String mech)	Helper method to create the enum from its string representation.
String	mech()	Returns the "raw" string representation of the mechanism on the wire.
int	roundtrips()	Returns the number of roundtrips this algorithm has with the server.
static SaslMechanism	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SaslMechanism[]	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, 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

PLAIN

public static final SaslMechanism PLAIN

SCRAM_SHA1

public static final SaslMechanism SCRAM_SHA1

SCRAM_SHA256

public static final SaslMechanism SCRAM_SHA256

SCRAM_SHA512

public static final SaslMechanism SCRAM_SHA512

Method Details

values

public static SaslMechanism[] values()

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

Returns:

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

valueOf

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

mech

public String mech()

Returns the "raw" string representation of the mechanism on the wire.

roundtrips

public int roundtrips()

Returns the number of roundtrips this algorithm has with the server.

from

public static SaslMechanism from(String mech)

Helper method to create the enum from its string representation.

Parameters:

mech - the mechanism to convert.

Returns:

null if not found, otherwise the enum representation.