com.mongodb

Class MongoCredential

java.lang.Object

com.mongodb.MongoCredential

@Immutable
public final class MongoCredential
extends java.lang.Object

Represents credentials to authenticate to a mongo server, as well as the source of the credentials and the authentication mechanism to use.

Since:

2.11

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GSSAPI_MECHANISM The GSSAPI mechanism.
static java.lang.String	MONGODB_CR_MECHANISM The MongoDB Challenge Response mechanism.
static java.lang.String	MONGODB_X509_MECHANISM The MongoDB X.509
static java.lang.String	PLAIN_MECHANISM The PLAIN mechanism.
static java.lang.String	SCRAM_SHA_1_MECHANISM The SCRAM-SHA-1 mechanism.

Method Summary

Methods

Modifier and Type	Method and Description
static MongoCredential	createCredential(java.lang.String userName, java.lang.String database, char[] password) Creates a MongoCredential instance with an unspecified mechanism.
static MongoCredential	createGSSAPICredential(java.lang.String userName) Creates a MongoCredential instance for the GSSAPI SASL mechanism.
static MongoCredential	createMongoCRCredential(java.lang.String userName, java.lang.String database, char[] password) Creates a MongoCredential instance for the MongoDB Challenge Response protocol.
static MongoCredential	createMongoX509Credential(java.lang.String userName) Creates a MongoCredential instance for the MongoDB X.509 protocol.
static MongoCredential	createPlainCredential(java.lang.String userName, java.lang.String source, char[] password) Creates a MongoCredential instance for the PLAIN SASL mechanism.
static MongoCredential	createScramSha1Credential(java.lang.String userName, java.lang.String source, char[] password) Creates a MongoCredential instance for the SCRAM-SHA-1 SASL mechanism.
boolean	equals(java.lang.Object o)
java.lang.String	getMechanism() Gets the mechanism
<T> T	getMechanismProperty(java.lang.String key, T defaultValue) Get the value of the given key to a mechanism property, or defaultValue if there is no mapping.
char[]	getPassword() Gets the password.
java.lang.String	getSource() Gets the source of the user name, typically the name of the database where the user is defined.
java.lang.String	getUserName() Gets the user name
int	hashCode()
java.lang.String	toString()
<T> MongoCredential	withMechanismProperty(java.lang.String key, T value) Creates a new MongoCredential as a copy of this instance, with the specified mechanism property added.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MONGODB_CR_MECHANISM

public static final java.lang.String MONGODB_CR_MECHANISM

The MongoDB Challenge Response mechanism.

See Also:

Constant Field Values

GSSAPI_MECHANISM

public static final java.lang.String GSSAPI_MECHANISM

The GSSAPI mechanism. See the RFC.

See Also:

Constant Field Values

Since server release

2.4

PLAIN_MECHANISM

public static final java.lang.String PLAIN_MECHANISM

The PLAIN mechanism. See the RFC.

Since:

2.12

See Also:

Constant Field Values

Since server release

2.6

SCRAM_SHA_1_MECHANISM

public static final java.lang.String SCRAM_SHA_1_MECHANISM

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

Since:

2.13

See Also:

Constant Field Values

Since server release

2.8

MONGODB_X509_MECHANISM

public static final java.lang.String MONGODB_X509_MECHANISM

The MongoDB X.509

Since:

2.12

See Also:

Constant Field Values

Since server release

2.6

Method Detail

createCredential

public static MongoCredential createCredential(java.lang.String userName,
                               java.lang.String database,
                               char[] password)

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 2.8 or higher, the driver will authenticate using the SCRAM-SHA-1 mechanism. Otherwise, the driver will authenticate using the MONGODB_CR mechanism.

Parameters:

userName - the user name

database - the database where the user is defined

password - the user's password

Returns:

the credential

Since:

2.13

createScramSha1Credential

public static MongoCredential createScramSha1Credential(java.lang.String userName,
                                        java.lang.String source,
                                        char[] password)

Creates a MongoCredential instance for the SCRAM-SHA-1 SASL mechanism. Use this method only if you want to ensure that the driver uses the MONGODB_CR mechanism regardless of whether the server you are connecting to supports a more secure authentication mechanism. Otherwise use the createCredential(String, String, char[]) method to allow the driver to negotiate the best mechanism based on the server version.

Parameters:

userName - the non-null user name

source - the source where the user is defined.

password - the non-null user password

Returns:

the credential

Since:

2.13

See Also:

createCredential(String, String, char[])

Since server release

2.8

createMongoCRCredential

public static MongoCredential createMongoCRCredential(java.lang.String userName,
                                      java.lang.String database,
                                      char[] password)

Creates a MongoCredential instance for the MongoDB Challenge Response protocol. Use this method only if you want to ensure that the driver uses the MONGODB_CR mechanism regardless of whether the server you are connecting to supports a more secure authentication mechanism. Otherwise use the createCredential(String, String, char[]) method to allow the driver to negotiate the best mechanism based on the server version.

Parameters:

userName - the user name

database - the database where the user is defined

password - the user's password

Returns:

the credential

See Also:

createCredential(String, String, char[])

createGSSAPICredential

public static MongoCredential createGSSAPICredential(java.lang.String userName)

Creates a MongoCredential instance for the GSSAPI SASL mechanism. To override the default service name of "mongodb", add a mechanism property with the name "SERVICE_NAME". To force canonicalization of the host name prior to authentication, add a mechanism property with the name "CANONICALIZE_HOST_NAME" with the valuetrue.

Parameters:

userName - the user name

Returns:

the credential

See Also:

withMechanismProperty(String, Object)

Since server release

2.4

createMongoX509Credential

public static MongoCredential createMongoX509Credential(java.lang.String userName)

Creates a MongoCredential instance for the MongoDB X.509 protocol.

Parameters:

userName - the user name

Returns:

the credential

Since:

2.12

Since server release

2.6

createPlainCredential

public static MongoCredential createPlainCredential(java.lang.String userName,
                                    java.lang.String source,
                                    char[] password)

Creates a MongoCredential instance for the PLAIN SASL mechanism.

Parameters:

userName - the non-null user name

source - the source where the user is defined. This can be either "$external" or the name of a database.

password - the non-null user password

Returns:

the credential

Since:

2.12

Since server release

2.6

withMechanismProperty

public <T> MongoCredential withMechanismProperty(java.lang.String key,
                                        T value)

Creates a new MongoCredential as a copy of this instance, with the specified mechanism property added.

Type Parameters:

T - the property type

Parameters:

key - the key to the property, which is treated as case-insensitive

value - the value of the property

Returns:

the credential

Since:

2.12

getMechanism

public java.lang.String getMechanism()

Gets the mechanism

Returns:

the mechanism.

getUserName

public java.lang.String getUserName()

Gets the user name

Returns:

the user name. Can never be null.

getSource

public java.lang.String getSource()

Gets the source of the user name, typically the name of the database where the user is defined.

Returns:

the user name. Can never be null.

getPassword

public char[] getPassword()

Gets the password.

Returns:

the password. Can be null for some mechanisms.

getMechanismProperty

public <T> T getMechanismProperty(java.lang.String key,
                         T defaultValue)

Get the value of the given key to a mechanism property, or defaultValue if there is no mapping.

Type Parameters:

T - the value type

Parameters:

key - the mechanism property key, which is treated as case-insensitive

defaultValue - the default value, if no mapping exists

Returns:

the mechanism property value

Since:

2.12

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object