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>
public enum SaslMechanism extends Enum<SaslMechanism>
Describes the support SASL authentication mechanisms.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description PLAIN
SCRAM_SHA1
SCRAM_SHA256
SCRAM_SHA512
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static SaslMechanism[] 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 (SaslMechanism c : SaslMechanism.values()) System.out.println(c);
- 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 nameNullPointerException
- 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.
-
-