com.mongodb

Class MongoCredentialsStore

java.lang.Object

com.mongodb.MongoCredentialsStore

@ThreadSafe
class MongoCredentialsStore
extends java.lang.Object

An effectively immutable store of credentials to mongo servers. It enforces the invariant that there can be at most one credentials for each database. It allows at most one credentials with a null database. There is still a package-protected method to add a new credentials to the store, but it's only there to support DB.authenticate, which allows you to add new credentials at any point during the life of a MongoClient.

Since:

2.11.0

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	allDatabasesWithCredentials
private java.util.Map<java.lang.String,MongoCredential>	credentialsMap

Constructor Summary

Constructors

Constructor and Description
MongoCredentialsStore() Creates an empty store
MongoCredentialsStore(java.lang.Iterable<MongoCredential> credentialsList) Creates a store with the list of credentials.
MongoCredentialsStore(MongoCredential credentials) Creates a store with a single credentials.

Method Summary

Modifier and Type	Method and Description
(package private) void	add(MongoCredential credentials) Adds a new credentials.
java.util.List<MongoCredential>	asList() Gets the MongoCredentials in this map as a List
boolean	equals(java.lang.Object o)
MongoCredential	get(java.lang.String database) Gets the stored credentials for the given database.
java.util.Set<java.lang.String>	getDatabases() Gets the set of databases for which there are credentials stored.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

credentialsMap

private final java.util.Map<java.lang.String,MongoCredential> credentialsMap

allDatabasesWithCredentials

private volatile java.util.Set<java.lang.String> allDatabasesWithCredentials

Constructor Detail

MongoCredentialsStore

public MongoCredentialsStore()

Creates an empty store

MongoCredentialsStore

public MongoCredentialsStore(MongoCredential credentials)

Creates a store with a single credentials.

Parameters:

credentials - A single credentials, which may be null.

MongoCredentialsStore

public MongoCredentialsStore(java.lang.Iterable<MongoCredential> credentialsList)

Creates a store with the list of credentials.

Parameters:

credentialsList - The list of credentials

Method Detail

add

void add(MongoCredential credentials)

Adds a new credentials.

Parameters:

credentials - the new credentials

Throws:

java.lang.IllegalArgumentException - if there already exist different credentials for the same database

getDatabases

public java.util.Set<java.lang.String> getDatabases()

Gets the set of databases for which there are credentials stored.

Returns:

an unmodifiable set of database names. Can contain the null string.

get

public MongoCredential get(java.lang.String database)

Gets the stored credentials for the given database.

Parameters:

database - the database. This can be null, to get the credentials with the null database.

Returns:

the credentials for the given database. Can be null if not are stored.

asList

public java.util.List<MongoCredential> asList()

Gets the MongoCredentials in this map as a List

Returns:

the list of credentials

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