com.allanbank.mongodb.client.connection.auth

Class MongoDbAuthenticator

java.lang.Object

com.allanbank.mongodb.client.connection.auth.MongoDbAuthenticator

All Implemented Interfaces:

Authenticator, Cloneable

public class MongoDbAuthenticator
extends Object
implements Authenticator

MongoDbAuthenticator provides an authenticator for the legacy, pre-2.4 version, of MongoDB authentication.

Copyright ©:

2013-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	ASCII The UTF-8 character encoding.
protected FutureCallback<Boolean>	myResults The result of the Authentication attempt.

Constructor Summary

Constructors

Constructor and Description
MongoDbAuthenticator() Creates a new MongoDbAuthenticator.

Method Summary

Methods

Modifier and Type	Method and Description
MongoDbAuthenticator	clone() Provides the ability to clone the authenticator.
String	passwordHash(Credential credentials) Creates the MongoDB authentication hash of the password.
protected String	passwordHash(MessageDigest md5, Credential credentials) Creates the MongoDB authentication hash of the password.
boolean	result() Returns the results of the authentication attempt.
void	startAuthentication(Credential credential, Connection connection) Starts to authenticate the user with the specified credentials.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASCII

public static final Charset ASCII

The UTF-8 character encoding.

myResults

protected FutureCallback<Boolean> myResults

The result of the Authentication attempt.

Constructor Detail

MongoDbAuthenticator

public MongoDbAuthenticator()

Creates a new MongoDbAuthenticator.

Method Detail

clone

public MongoDbAuthenticator clone()

Provides the ability to clone the authenticator. A new Authenticator instance is created for each physical connection in use.

Using clone allows users to create a "template" version of the authenticator that is then copied prior to use by each connection.

Overridden to return a new authenticator.

Specified by:

clone in interface Authenticator

Overrides:

clone in class Object

Returns:

The cloned authenticator.

passwordHash

public String passwordHash(Credential credentials)
                    throws NoSuchAlgorithmException

Creates the MongoDB authentication hash of the password.

Parameters:

credentials - The credentials to hash.

Returns:

The hashed password/myCredential.

Throws:

NoSuchAlgorithmException - On a failure to create a MD5 message digest.

result

public boolean result()
               throws MongoDbAuthenticationException

Returns the results of the authentication attempt.

Overridden to returns the results of the authentication, once complete.

Specified by:

result in interface Authenticator

Returns:

True if the user is successfully authenticated on the connection, false if the authentication fails.

Throws:

MongoDbAuthenticationException - On a failure in the protocol to authenticate the user on the connection.

startAuthentication

public void startAuthentication(Credential credential,
                       Connection connection)
                         throws MongoDbAuthenticationException

Starts to authenticate the user with the specified credentials.

Overridden to authenticate with MongoDB using the native/legacy authentication mechanisms.

Specified by:

startAuthentication in interface Authenticator

Parameters:

credential - The credentials to use to login to the database.

connection - The connection to authenticate the user with.

Throws:

MongoDbAuthenticationException - On a failure in the protocol to authenticate the user on the connection.

passwordHash

protected String passwordHash(MessageDigest md5,
                  Credential credentials)

Creates the MongoDB authentication hash of the password.

Parameters:

md5 - The MD5 digest to compute the hash.

credentials - The credentials to hash.

Returns:

The hashed password/myCredential.