com.allanbank.mongodb.client.connection.auth

Interface Authenticator

All Superinterfaces:

Cloneable

All Known Implementing Classes:

MongoDbAuthenticator

public interface Authenticator
extends Cloneable

Authenticator provides the common interface for all MongoDB authenticators.

A single Authenticator instance will only ever be used with a single Connection and set of credentials. The "clone()" method is used to quickly allocate a new instance for a connection allowing for shared "preauthentication" work to be done.

The startAuthentication(Credential, Connection) method may assume that it is only invoked from a single thread. The "result" method should not make the same assumption.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
Authenticator	clone() Provides the ability to clone the authenticator.
boolean	result() Returns the results of the authentication attempt.
void	startAuthentication(Credential credentials, Connection connection) Starts to authenticate the user with the specified credentials.

Method Detail

clone

Authenticator 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.

Returns:

The cloned authenticator.

result

boolean result()
               throws MongoDbAuthenticationException

Returns the results of the authentication attempt.

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

void startAuthentication(Credential credentials,
                       Connection connection)
                         throws MongoDbAuthenticationException

Starts to authenticate the user with the specified credentials.

Parameters:

credentials - 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.