com.allanbank.mongodb.connection.auth

Class AuthenticatingConnection

java.lang.Object

com.allanbank.mongodb.connection.proxy.AbstractProxyConnection

com.allanbank.mongodb.connection.auth.AuthenticatingConnection

All Implemented Interfaces:

Connection, Closeable, Flushable, AutoCloseable

public class AuthenticatingConnection
extends AbstractProxyConnection

AuthenticatingConnection provides a connection that authenticated with the server for each database before it is used.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

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

Nested Class Summary

Nested classes/interfaces inherited from class com.allanbank.mongodb.connection.proxy.AbstractProxyConnection

AbstractProxyConnection.ProxiedChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_DB_NAME The name of the administration database.
static Logger	LOG The logger for the authenticator.

Fields inherited from class com.allanbank.mongodb.connection.proxy.AbstractProxyConnection

myConfig

Fields inherited from interface com.allanbank.mongodb.connection.Connection

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
AuthenticatingConnection(Connection connection, MongoClientConfiguration config) Creates a new AuthenticatingConnection.

Method Summary

Methods

Modifier and Type	Method and Description
protected Connection	getProxiedConnection() Returns the proxiedConnection value.
String	send(Message message, Callback<Reply> replyCallback) Sends a message on the connection.
String	send(Message message1, Message message2, Callback<Reply> replyCallback) Sends a message on the connection.
String	toString()

Methods inherited from class com.allanbank.mongodb.connection.proxy.AbstractProxyConnection

addPending, addPropertyChangeListener, close, drainPending, flush, getPendingCount, getServerName, isIdle, isOpen, onExceptin, raiseErrors, removePropertyChangeListener, shutdown, waitForClosed

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_DB_NAME

public static final String ADMIN_DB_NAME

The name of the administration database.

See Also:

Constant Field Values

LOG

public static final Logger LOG

The logger for the authenticator.

Constructor Detail

AuthenticatingConnection

public AuthenticatingConnection(Connection connection,
                        MongoClientConfiguration config)

Creates a new AuthenticatingConnection.

Parameters:

connection - The connection to ensure gets authenticated as needed.

config - The MongoDB client configuration.

Method Detail

send

public String send(Message message,
          Callback<Reply> replyCallback)
            throws MongoDbException

Sends a message on the connection.

Forwards the call to the proxied Connection.

Makes sure the connection is authenticated for the current database before forwarding to the proxied connection.

Specified by:

send in interface Connection

Overrides:

send in class AbstractProxyConnection

Parameters:

message - The message to send on the connection.

replyCallback - The callback to notify of responses to the messages. May be null.

Returns:

The server that was sent the request.

Throws:

MongoDbException - On an error sending the message.

send

public String send(Message message1,
          Message message2,
          Callback<Reply> replyCallback)
            throws MongoDbException

Sends a message on the connection.

Forwards the call to the proxied Connection.

Makes sure the connection is authenticated for the current database before forwarding to the proxied connection.

Specified by:

send in interface Connection

Overrides:

send in class AbstractProxyConnection

Parameters:

message1 - The first message to send on the connection.

message2 - The second message to send on the connection.

replyCallback - The callback to notify of responses to the message2. May be null.

Returns:

The server that was sent the request.

Throws:

MongoDbException - On an error sending the message.

toString

public String toString()

Overridden to return the socket information.

Overrides:

toString in class Object

getProxiedConnection

protected Connection getProxiedConnection()

Returns the proxiedConnection value.

Overridden to give access to the proxied connections to tests.

Overrides:

getProxiedConnection in class AbstractProxyConnection

Returns:

The proxiedConnection value.