com.allanbank.mongodb

Interface MongoClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

Mongo

All Known Implementing Classes:

MongoClientImpl, MongoImpl

public interface MongoClient
extends Closeable

Interface to bootstrap into interactions with MongoDB.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

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.
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. Use the listDatabaseNames() method instead.
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 interface java.io.Closeable

close

Method Detail

asSerializedClient

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.

Returns:

A serialized view of the MongoDB connections.

getConfig

MongoClientConfiguration getConfig()

Returns the configuration being used by the logical MongoDB connection.

Returns:

The configuration being used by the logical MongoDB connection.

getDatabase

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.

Parameters:

name - The name of the existing database.

Returns:

The MongoDatabase.

listDatabaseNames

List<String> listDatabaseNames()

Returns a list of database names.

Returns:

A list of available database names.

listDatabases

@Deprecated
List<String> listDatabases()

Deprecated. Use the listDatabaseNames() method instead.

Returns a list of database names.

Returns:

A list of available database names.

restart

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

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.

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

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.