com.allanbank.mongodb.client

Class ClientImpl

java.lang.Object

com.allanbank.mongodb.client.AbstractClient

com.allanbank.mongodb.client.ClientImpl

All Implemented Interfaces:

Client

public class ClientImpl
extends AbstractClient

Implementation of the internal Client interface which all requests to the MongoDB servers pass.

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 ©:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ClientImpl.ConnectionListener ConnectionListener provides the call back for events occurring on a connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG The logger for the ClientImpl.
static int	MAX_CONNECTION_SCAN The maximum number of connections to scan looking for idle/lightly used connections.

Fields inherited from interface com.allanbank.mongodb.client.Client

MAX_DOCUMENT_SIZE

Constructor Summary

Constructors

Constructor and Description
ClientImpl(MongoClientConfiguration config) Create a new ClientImpl.
ClientImpl(MongoClientConfiguration config, ConnectionFactory connectionFactory) Create a new ClientImpl.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the client.
protected Connection	findConnection(Message message1, Message message2) Locates a Connection to send a message on.
ClusterType	getClusterType() Returns the type of cluster the client is connected to.
MongoClientConfiguration	getConfig() Returns the configuration being used by the logical MongoDB connection.
int	getConnectionCount() Returns the current number of open connections.
Durability	getDefaultDurability() Returns the Durability from the MongoClientConfiguration.
ReadPreference	getDefaultReadPreference() Returns the ReadPreference from the MongoClientConfiguration.
protected void	handleConnectionClosed(Connection connection) Tries to reconnect previously open Connections.
boolean	isCursorDocument(Document doc) Returns true if the document looks like a cursor restart document.
protected void	reconnect(Connection connection) Runs the reconnect logic for the connection.
MongoIterator<Document>	restart(DocumentAssignable cursorDocument) Restarts an iterator that was previously saved.
MongoCursorControl	restart(StreamCallback<Document> results, DocumentAssignable cursorDocument) Restarts a document stream from a cursor that was previously saved.
protected Connection	searchConnection(Message message1, Message message2, boolean waitForReconnect) Searches for a connection to use.

Methods inherited from class com.allanbank.mongodb.client.AbstractClient

send, send

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CONNECTION_SCAN

public static final int MAX_CONNECTION_SCAN

The maximum number of connections to scan looking for idle/lightly used connections.

See Also:

Constant Field Values

LOG

protected static final Logger LOG

The logger for the ClientImpl.

Constructor Detail

ClientImpl

public ClientImpl(MongoClientConfiguration config)

Create a new ClientImpl.

Parameters:

config - The configuration for interacting with MongoDB.

ClientImpl

public ClientImpl(MongoClientConfiguration config,
          ConnectionFactory connectionFactory)

Create a new ClientImpl.

Parameters:

config - The configuration for interacting with MongoDB.

connectionFactory - The source of connection for the client.

Method Detail

close

public void close()

Closes the client.

Overridden to close all of the open connections.

Overridden to close all of the open connections.

Specified by:

close in interface Client

Overrides:

close in class AbstractClient

See Also:

Closeable.close()

getClusterType

public ClusterType getClusterType()

Returns the type of cluster the client is connected to.

Overridden to return the ClusterType of the ConnectionFactory.

Returns:

The type of cluster the client is connected to.

getConfig

public MongoClientConfiguration getConfig()

Returns the configuration being used by the logical MongoDB connection.

Overridden to return the configuration used when the client was constructed.

Returns:

The configuration being used by the logical MongoDB connection.

getConnectionCount

public int getConnectionCount()

Returns the current number of open connections.

Returns:

The current number of open connections.

getDefaultDurability

public Durability getDefaultDurability()

Returns the Durability from the MongoClientConfiguration.

Overridden to return the configurations default durability.

Returns:

The default durability from the MongoClientConfiguration.

See Also:

Client.getDefaultDurability()

getDefaultReadPreference

public ReadPreference getDefaultReadPreference()

Returns the ReadPreference from the MongoClientConfiguration.

Overridden to return the configurations default read preference.

Returns:

The default read preference from the MongoClientConfiguration .

See Also:

Client.getDefaultReadPreference()

isCursorDocument

public boolean isCursorDocument(Document doc)

Returns true if the document looks like a cursor restart document. e.g., one that is created by MongoIteratorImpl.asDocument().

Parameters:

doc - The potential cursor document.

Returns:

True if the document looks like it was created by MongoIteratorImpl.asDocument().

restart

public MongoIterator<Document> restart(DocumentAssignable cursorDocument)
                                throws IllegalArgumentException

Restarts an iterator that was previously saved.

Parameters:

cursorDocument - The document containing the state of the cursor.

Returns:

The restarted iterator.

Throws:

IllegalArgumentException - If the document does not contain a valid cursor state.

restart

public MongoCursorControl restart(StreamCallback<Document> results,
                         DocumentAssignable cursorDocument)
                           throws IllegalArgumentException

Restarts a document stream from a cursor that was previously saved.

Parameters:

results - Callback that will be notified of the results of the cursor.

cursorDocument - The document containing the state of the cursor.

Returns:

A MongoCursorControl to control the cursor streaming documents to the caller. This includes the ability to stop the cursor and persist its state.

Throws:

IllegalArgumentException - If the document does not contain a valid cursor state.

findConnection

protected Connection findConnection(Message message1,
                        Message message2)
                             throws MongoDbException

Locates a Connection to send a message on.

Tries to locate a connection that can quickly dispatch the message to a MongoDB server. The basic metrics for determining if a connection is idle is to look at the number of messages waiting to be sent. The basic logic for finding a connection is:

1. Scan the list of connection looking for an idle connection. If one is found use it.
2. If there are no idle connections determine the maximum number of allowed connections and if there are fewer that the maximum allowed then take the connection creation lock, create a new connection, use it, and add to the set of available connections and release the lock.
3. If there are is still not a connection idle then sort the connections based on a snapshot of pending messages and use the connection with the least messages.

Specified by:

findConnection in class AbstractClient

Parameters:

message1 - The first message that will be sent. The connection return should be compatible with all of the messages ReadPreference.

message2 - The second message that will be sent. The connection return should be compatible with all of the messages ReadPreference. May be null.

Returns:

The Connection to send a message on.

Throws:

MongoDbException - In the case of an error finding a Connection.

handleConnectionClosed

protected void handleConnectionClosed(Connection connection)

Tries to reconnect previously open Connections. If a connection was being closed then cleans up the remaining state.

Parameters:

connection - The connection that was closed.

reconnect

protected void reconnect(Connection connection)

Runs the reconnect logic for the connection.

Parameters:

connection - The connection to reconnect.

searchConnection

protected Connection searchConnection(Message message1,
                          Message message2,
                          boolean waitForReconnect)
                               throws MongoDbException

Searches for a connection to use.

Tries to locate a connection that can quickly dispatch the message to a MongoDB server. The basic metrics for determining if a connection is idle is to look at the number of messages waiting to be sent. The basic logic for finding a connection is:

1. Scan the list of connection looking for an idle connection. If one is found use it.
2. If there are no idle connections determine the maximum number of allowed connections and if there are fewer that the maximum allowed then take the connection creation lock, create a new connection, use it, and add to the set of available connections and release the lock.
3. If there are is still not a connection idle then sort the connections based on a snapshot of pending messages and use the connection with the least messages.

Parameters:

message1 - The first message that will be sent. The connection return should be compatible with all of the messages ReadPreference.

message2 - The second message that will be sent. The connection return should be compatible with all of the messages ReadPreference. May be null.

waitForReconnect - If true then the search will block while there is an active reconnect attempt.

Returns:

The Connection to send a message on.

Throws:

MongoDbException - In the case of an error finding a Connection.