com.allanbank.mongodb.client

Interface Client

All Known Implementing Classes:

AbstractClient, ClientImpl, SerialClientImpl

public interface Client

Unified client interface to 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_DOCUMENT_SIZE The absolute maximum size for a BSON document supported by all versions of MongoDB servers: 16MiB (16777216 ).

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the client.
ClusterType	getClusterType() Returns the type of cluster the client is connected to.
MongoClientConfiguration	getConfig() Returns the configuration being used by the logical MongoDB connection.
Durability	getDefaultDurability() Returns the Durability from the MongoClientConfiguration.
ReadPreference	getDefaultReadPreference() Returns the ReadPreference from the MongoClientConfiguration.
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.
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.

Field Detail

MAX_DOCUMENT_SIZE

static final int MAX_DOCUMENT_SIZE

The absolute maximum size for a BSON document supported by all versions of MongoDB servers: 16MiB (16777216 ).

See Also:

Constant Field Values

Method Detail

close

void close()

Closes the client.

getClusterType

ClusterType getClusterType()

Returns the type of cluster the client is connected to.

Returns:

The type of cluster the client is connected to.

getConfig

MongoClientConfiguration getConfig()

Returns the configuration being used by the logical MongoDB connection.

Returns:

The configuration being used by the logical MongoDB connection.

getDefaultDurability

Durability getDefaultDurability()

Returns the Durability from the MongoClientConfiguration.

Returns:

The default durability from the MongoClientConfiguration.

getDefaultReadPreference

ReadPreference getDefaultReadPreference()

Returns the ReadPreference from the MongoClientConfiguration.

Returns:

The default read preference from the MongoClientConfiguration .

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

send

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

Sends a message on the connection.

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

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

Sends a message on the connection.

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.