com.allanbank.mongodb.client

Class MongoClientImpl

java.lang.Object

com.allanbank.mongodb.client.MongoClientImpl

All Implemented Interfaces:

MongoClient, Closeable, AutoCloseable

Direct Known Subclasses:

MongoImpl

public class MongoClientImpl
extends Object
implements MongoClient

Implements the bootstrap point for interactions with MongoDB.

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

Constructor Summary

Constructors

Constructor and Description
MongoClientImpl(Client client) Create a new MongoClient.
MongoClientImpl(MongoClientConfiguration config) Create a new MongoClient.

Method Summary

Methods

Modifier and Type	Method and Description
MongoClient	asSerializedClient() Returns a MongoClient instance that shares connections with this MongoClient instance but serializes all of its requests on a single connection.
void	close()
Client	getClient() Returns the client value.
MongoClientConfiguration	getConfig() Returns the configuration being used by the logical MongoDB connection.
MongoDatabase	getDatabase(String name) Returns the MongoDatabase with the specified name.
List<String>	listDatabaseNames() Returns a list of database names.
List<String>	listDatabases() Deprecated.
MongoIterator<Document>	restart(DocumentAssignable cursorDocument) Restarts an iterator that was previously saved.
MongoCursorControl	restart(LambdaCallback<Document> results, DocumentAssignable cursorDocument) Restarts a document stream from a cursor that was previously saved.
MongoCursorControl	restart(StreamCallback<Document> results, DocumentAssignable cursorDocument) Restarts a document stream from a cursor that was previously saved.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoClientImpl

public MongoClientImpl(Client client)

Create a new MongoClient.

Parameters:

client - The client interface for interacting with the database.

MongoClientImpl

public MongoClientImpl(MongoClientConfiguration config)

Create a new MongoClient.

Parameters:

config - The configuration for interacting with MongoDB.

Method Detail

asSerializedClient

public MongoClient asSerializedClient()

Returns a MongoClient instance that shares connections with this MongoClient instance but serializes all of its requests on a single connection.

While the returned MongoClient instance is thread safe it is intended to be used by a single logical thread to ensure requests issued to the MongoDB server are guaranteed to be processed in the same order they are requested.

Creation of the serial instance is lightweight with minimal object allocation and no server interaction.

Overridden to create a new Mongo instance around a SerialClientImpl.

Specified by:

asSerializedClient in interface MongoClient

Returns:

A serialized view of the MongoDB connections.

close

public void close()

Overridden to close the underlying client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getClient

public Client getClient()

Returns the client value.

Returns:

The client value.

getConfig

public MongoClientConfiguration getConfig()

Returns the configuration being used by the logical MongoDB connection.

Overridden to return the clients configuration.

Specified by:

getConfig in interface MongoClient

Returns:

The configuration being used by the logical MongoDB connection.

getDatabase

public MongoDatabase getDatabase(String name)

Returns the MongoDatabase with the specified name. This method does not validate that the database already exists in the MongoDB instance.

Overridden to create a MongoDatabase instance with the given name.

Specified by:

getDatabase in interface MongoClient

Parameters:

name - The name of the existing database.

Returns:

The MongoDatabase.

See Also:

MongoClient.getDatabase(String)

listDatabaseNames

public List<String> listDatabaseNames()

Returns a list of database names.

Overridden to issue a listDatabases command against the 'admin' database.

Specified by:

listDatabaseNames in interface MongoClient

Returns:

A list of available database names.

See Also:

MongoClient.listDatabaseNames()

listDatabases

@Deprecated
public List<String> listDatabases()

Deprecated.

Returns a list of database names.

Specified by:

listDatabases in interface MongoClient

Returns:

A list of available database names.

restart

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

Restarts an iterator that was previously saved.

Specified by:

restart in interface MongoClient

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(LambdaCallback<Document> results,
                         DocumentAssignable cursorDocument)
                           throws IllegalArgumentException

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

The sequence of callbacks will be terminated by either calling the results.accept(...) method with null for both parameters or by calling the method with an error for the first parameter.

Overridden to call restart(StreamCallback, DocumentAssignable) with an adapter for the LambdaCallback.

Specified by:

restart in interface MongoClient

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.

restart

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

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

Specified by:

restart in interface MongoClient

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.