com.allanbank.mongodb.client

Class SerialClientImpl

java.lang.Object

com.allanbank.mongodb.client.AbstractClient

com.allanbank.mongodb.client.SerialClientImpl

All Implemented Interfaces:

Client

public class SerialClientImpl
extends AbstractClient

A specialization of the ClientImpl to always try to use the same connection.

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

Modifier and Type	Field and Description
protected static boolean	ASSERTIONS_ENABLED If true then assertions have been enabled for the class.

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

MAX_DOCUMENT_SIZE

Constructor Summary

Constructors

Constructor and Description
SerialClientImpl(ClientImpl client) Create a new SerialClientImpl.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the client.
protected Connection	findConnection(Message message1, Message message2) Tries to reuse the last connection used.
ClusterStats	getClusterStats() Returns the meta-data on the current cluster.
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.

Methods inherited from class com.allanbank.mongodb.client.AbstractClient

send, send

Methods inherited from class java.lang.Object

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

Field Detail

ASSERTIONS_ENABLED

protected static final boolean ASSERTIONS_ENABLED

If true then assertions have been enabled for the class.

Constructor Detail

SerialClientImpl

public SerialClientImpl(ClientImpl client)

Create a new SerialClientImpl.

Parameters:

client - The delegate client for accessing connections.

Method Detail

close

public void close()

Closes the client.

Overridden to close all of the open connections.

Overridden to close all of the open connections.

Specified by:

close in interface Client

Overrides:

close in class AbstractClient

See Also:

Closeable.close()

getClusterStats

public ClusterStats getClusterStats()

Returns the meta-data on the current cluster.

Overridden to return the cluster stats from the delegate client.

Returns:

The meta-data on the current cluster.

getClusterType

public ClusterType getClusterType()

Returns the type of cluster the client is connected to.

Overridden to return the ClusterType of delegate ClientImpl.

Returns:

The type of cluster the client is connected to.

getConfig

public MongoClientConfiguration getConfig()

Returns the configuration being used by the logical MongoDB connection.

Overridden to return the configuration used when the client was constructed.

Returns:

The configuration being used by the logical MongoDB connection.

getDefaultDurability

public Durability getDefaultDurability()

Returns the Durability from the MongoClientConfiguration.

Overridden to return the configurations default durability.

Returns:

The default durability from the MongoClientConfiguration.

See Also:

Client.getDefaultDurability()

getDefaultReadPreference

public ReadPreference getDefaultReadPreference()

Returns the ReadPreference from the MongoClientConfiguration.

Overridden to return the configurations default read preference.

Returns:

The default read preference from the MongoClientConfiguration .

See Also:

Client.getDefaultReadPreference()

restart

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

Restarts an iterator that was previously saved.

Overridden to forward to the delegate client.

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.

See Also:

Client.restart(DocumentAssignable)

restart

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

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

Overridden to forward to the delegate client.

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.

See Also:

Client.restart(StreamCallback, DocumentAssignable)

findConnection

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

Tries to reuse the last connection used. If the connection it closed or does not exist then the request is delegated to the ClientImpl and the result cached for future requests.

Specified by:

findConnection in class AbstractClient

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 found connection.

Throws:

MongoDbException - On a failure to talk to the MongoDB servers.