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-2012, Allanbank Consulting, Inc., All Rights Reserved

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.
MongoDbConfiguration	getConfig() Returns the configuration being used by the logical MongoDB connection.
Durability	getDefaultDurability() Returns the Durability from the MongoDbConfiguration.
ReadPreference	getDefaultReadPreference() Returns the ReadPreference from the MongoDbConfiguration.
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.

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

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

Returns:

The default durability from the MongoDbConfiguration.

getDefaultReadPreference

ReadPreference getDefaultReadPreference()

Returns the ReadPreference from the MongoDbConfiguration.

Returns:

The default read preference from the MongoDbConfiguration .

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.