org.hibernate.ogm.datastore.mongodb.options

Enum AuthenticationMechanismType

java.lang.Object

java.lang.Enum<AuthenticationMechanismType>

org.hibernate.ogm.datastore.mongodb.options.AuthenticationMechanismType

All Implemented Interfaces:

Serializable, Comparable<AuthenticationMechanismType>

public enum AuthenticationMechanismType
extends Enum<AuthenticationMechanismType>

Available authentication methods for MongoDB.

Author:

Davide D'Alto, Emmanuel Bernard <emmanuel@hibernate.org>

See Also:

MongoCredential

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEST The client will negotiate the best mechanism based on the version of the server that the client is authenticating to.
GSSAPI
MONGODB_CR Deprecated. since MongoDB 3.0, use SCRAM_SHA_1 or BEST
MONGODB_X509
PLAIN
SCRAM_SHA_1

Method Summary

Modifier and Type	Method and Description
abstract com.mongodb.MongoCredential	createCredential(String username, String databaseName, String password)
static AuthenticationMechanismType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationMechanismType[]	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

GSSAPI

public static final AuthenticationMechanismType GSSAPI

MONGODB_CR

@Deprecated
public static final AuthenticationMechanismType MONGODB_CR

Deprecated. since MongoDB 3.0, use SCRAM_SHA_1 or BEST

PLAIN

public static final AuthenticationMechanismType PLAIN

MONGODB_X509

public static final AuthenticationMechanismType MONGODB_X509

SCRAM_SHA_1

public static final AuthenticationMechanismType SCRAM_SHA_1

BEST

public static final AuthenticationMechanismType BEST

The client will negotiate the best mechanism based on the version of the server that the client is authenticating to.

Method Detail

values

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

Returns:

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

valueOf

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

createCredential

public abstract com.mongodb.MongoCredential createCredential(String username,
                                                             String databaseName,
                                                             String password)