io.toro.martini.database

Enum MongoDbDatabase.AuthenticationMechanism

java.lang.Object

java.lang.Enum<MongoDbDatabase.AuthenticationMechanism>

io.toro.martini.database.MongoDbDatabase.AuthenticationMechanism

All Implemented Interfaces:

Serializable, Comparable<MongoDbDatabase.AuthenticationMechanism>

Enclosing class:

MongoDbDatabase

public static enum MongoDbDatabase.AuthenticationMechanism
extends Enum<MongoDbDatabase.AuthenticationMechanism>

An enumeration of the MongoDB-supported authentication mechanisms.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Creates a MongoCredential instance with an unspecified mechanism.
PLAIN The PLAIN mechanism.
SCRAM_SHA_1 The SCRAM-SHA-1 mechanism.
SCRAM_SHA_256 The SCRAM-SHA-256 mechanism.

Method Summary

Modifier and Type	Method and Description
static MongoDbDatabase.AuthenticationMechanism	from(String str)
static MongoDbDatabase.AuthenticationMechanism	valueOf(String name) Returns the enum constant of this type with the specified name.
static MongoDbDatabase.AuthenticationMechanism[]	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

AUTO

public static final MongoDbDatabase.AuthenticationMechanism AUTO

Creates a MongoCredential instance with an unspecified mechanism. The client will negotiate the best mechanism based on the version of the server that the client is authenticating to.

If the server version is 4.0 or higher, the driver will negotiate with the server preferring the SCRAM-SHA-256 mechanism. 3.x servers will authenticate using SCRAM-SHA-1, older servers will authenticate using the MONGODB_CR mechanism.

PLAIN

public static final MongoDbDatabase.AuthenticationMechanism PLAIN

The PLAIN mechanism. See the RFC.

SCRAM_SHA_1

public static final MongoDbDatabase.AuthenticationMechanism SCRAM_SHA_1

The SCRAM-SHA-1 mechanism. See the RFC.

SCRAM_SHA_256

public static final MongoDbDatabase.AuthenticationMechanism SCRAM_SHA_256

The SCRAM-SHA-256 mechanism. See the RFC.

Method Detail

values

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

Returns:

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

valueOf

public static MongoDbDatabase.AuthenticationMechanism 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

from

public static MongoDbDatabase.AuthenticationMechanism from(String str)