com.allanbank.mongodb

Class Credential

java.lang.Object

com.allanbank.mongodb.Credential

All Implemented Interfaces:

Serializable

public final class Credential
extends Object
implements Serializable

Credential provides an immutable set of credential for accessing MongoDB.

A given client can support a different set of credential for each database the client is accessing. The client can also authenticate against the "admin" database which will apply across all databases.

Note: While we use the term user name/password within this class the values may not actually be a user name or a password. In addition not all authentication mechanisms may use all of the fields in this class. See the documentation for the authenticator being used for details on what values are expected for each of the fields in this class.

See Also:

Authentication Usage Guide, Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Credential.Builder Builder provides a helper for creating a Credential.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_DB The name of the administration database used to authenticate a administrator to MongoDB.
static String	KERBEROS Constant for Kerberos authentication.
static String	MONGODB_CR Constant for traditional MongoDB Challenge/Response.
static char[]	NO_PASSWORD An empty password array.
static String	PLAIN_SASL Constant for authentication using plain SASL (LDAP/PAM) client certificates passed at connection establishment.
static String	X509 Constant for authentication using x.509 client certificates passed at connection establishment.

Constructor Summary

Constructors

Constructor and Description
Credential(Credential.Builder builder) Creates a new Credential.

Method Summary

Methods

Modifier and Type	Method and Description
Authenticator	authenticator() Returns an authenticator for the credential.
static Credential.Builder	builder() Creates a Credential.Builder for creating a Credential.
boolean	equals(Object object)
String	getAuthenticationType() Returns the authentication type or mode that the credential should be used with.
Authenticator	getAuthenticator() Returns the authenticator value.
String	getDatabase() Returns the database the credential are valid for.
File	getFile() Returns the file containing the full credentials.
boolean	getOption(String optionName, boolean defaultValue) Returns the option value.
int	getOption(String optionName, int defaultValue) Returns the option value.
String	getOption(String optionName, String defaultValue) Returns the option value.
char[]	getPassword() Returns the password for the credential set.
String	getUserName() Returns the user name for the credential set.
int	hashCode()
boolean	hasPassword() Returns true if the password has atleast a single character.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_DB

public static final String ADMIN_DB

The name of the administration database used to authenticate a administrator to MongoDB.

See Also:

Constant Field Values

KERBEROS

public static final String KERBEROS

Constant for Kerberos authentication.

Note: Use of the Kerberos for authentication requires the driver's extensions. See the Kerberos Usage Guide for details.

See Also:

Kerberos Usage Guide

MONGODB_CR

public static final String MONGODB_CR

Constant for traditional MongoDB Challenge/Response.

NO_PASSWORD

public static final char[] NO_PASSWORD

An empty password array.

PLAIN_SASL

public static final String PLAIN_SASL

Constant for authentication using plain SASL (LDAP/PAM) client certificates passed at connection establishment.

Note: Use of Plain SASL for authentication requires the driver's extensions. See the Plain SASL Usage Guide for details.

See Also:

Plain SASL Usage Guide

X509

public static final String X509

Constant for authentication using x.509 client certificates passed at connection establishment.

Note: Use of the x.509 for authentication requires the driver's extensions. See the TLS/SSL Usage Guide for details.

See Also:

TLS/SSL Usage Guide, x.509 Authentication Usage Guide

Constructor Detail

Credential

public Credential(Credential.Builder builder)

Creates a new Credential.

Parameters:

builder - The builder for the credentials.

Method Detail

builder

public static Credential.Builder builder()

Creates a Credential.Builder for creating a Credential.

Returns:

The Credential.Builder for creating a Credential.

authenticator

public Authenticator authenticator()
                            throws MongoDbAuthenticationException

Returns an authenticator for the credential.

Returns:

The authenticator for the credential.

Throws:

MongoDbAuthenticationException - On a failure to load the authenticator for the credential.

equals

public boolean equals(Object object)

Overridden to return true if the passed value equals these credential.

Overrides:

equals in class Object

getAuthenticationType

public String getAuthenticationType()

Returns the authentication type or mode that the credential should be used with.

Returns:

The authentication type or mode that the credential should be used with.

getAuthenticator

public Authenticator getAuthenticator()

Returns the authenticator value.

Returns:

The authenticator value.

getDatabase

public String getDatabase()

Returns the database the credential are valid for. Use ADMIN_DB to authenticate as an administrator.

Returns:

The database the credential are valid for.

getFile

public File getFile()

Returns the file containing the full credentials.

Returns:

The file containing the full credentials. May be null.

getOption

public boolean getOption(String optionName,
                boolean defaultValue)

Returns the option value.

Parameters:

optionName - The name of the option to set.

defaultValue - The value of the option if it is not set or cannot be parsed via Boolean.parseBoolean(String).

Returns:

The option value.

getOption

public int getOption(String optionName,
            int defaultValue)

Returns the option value.

Parameters:

optionName - The name of the option to set.

defaultValue - The value of the option if it is not set or cannot be parsed via Integer.parseInt(String).

Returns:

The option value.

getOption

public String getOption(String optionName,
               String defaultValue)

Returns the option value.

Parameters:

optionName - The name of the option to set.

defaultValue - The value of the option if it is not set.

Returns:

The option value.

getPassword

public char[] getPassword()

Returns the password for the credential set. A clone of the internal array is returns that should be cleared when it is done being used via something like Arrays.fill(password, 0)

Returns:

The password for the credential set.

getUserName

public String getUserName()

Returns the user name for the credential set.

Returns:

The user name for the credential set.

hashCode

public int hashCode()

Overridden to hash the credential.

Overrides:

hashCode in class Object

hasPassword

public boolean hasPassword()

Returns true if the password has atleast a single character.

Returns:

True if the password has atleast a single character, false otherwise.

toString

public String toString()

Overridden to returns the credential in a human readable form.

Overrides:

toString in class Object