com.allanbank.mongodb.client

Class AbstractClient

java.lang.Object

com.allanbank.mongodb.client.AbstractClient

All Implemented Interfaces:

Client

Direct Known Subclasses:

ClientImpl, SerialClientImpl

public abstract class AbstractClient
extends Object
implements Client

AbstractClient provides a base class for Client implementations.

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

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

Field Summary

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

MAX_DOCUMENT_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractClient() Creates a new AbstractClient.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the client.
protected abstract Connection	findConnection(Message message1, Message message2) Locates a Connection to send a message on.
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.

Methods inherited from class java.lang.Object

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

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

getClusterType, getConfig, getDefaultDurability, getDefaultReadPreference, restart, restart

Constructor Detail

AbstractClient

public AbstractClient()

Creates a new AbstractClient.

Method Detail

close

public void close()

Closes the client.

Overridden to close all of the open connections.

Specified by:

close in interface Client

See Also:

Closeable.close()

send

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

Sends a message on the connection.

Overridden to locate the a connection to send the message and then forward the message to that connection.

Specified by:

send in interface Client

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

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

Sends a message on the connection.

Overridden to locate the a connection to send the messages and then forward the messages to that connection.

Specified by:

send in interface Client

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.

findConnection

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

Locates a Connection to send a message on.

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.