com.allanbank.mongodb.client.callback

Class CursorCallback

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

com.allanbank.mongodb.client.callback.AbstractReplyCallback<MongoIterator<Document>>

com.allanbank.mongodb.client.callback.CursorCallback

All Implemented Interfaces:

Callback<Reply>, AddressAware, ReplyCallback

public final class CursorCallback
extends AbstractReplyCallback<MongoIterator<Document>>
implements AddressAware

Callback to convert a CursorableMessage Reply into a MongoIteratorImpl.

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 inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

ERROR_CODE_FIELD, ERROR_MESSAGE_FIELDS

Constructor Summary

Constructors

Constructor and Description
CursorCallback(Client client, CursorableMessage message, boolean command, Callback<MongoIterator<Document>> results) Create a new CursorCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected MongoDbException	asError(Reply reply, int okValue, int errorNumber, String errorMessage) Creates an exception from the parsed reply fields.
protected MongoIterator<Document>	convert(Reply reply) Converts the Reply into the final response type.
String	getAddress() Returns the server the original request was sent to.
protected void	handle(Reply reply) Called once the Reply has been validated.
protected boolean	isCommand() Returns true if the callback should expect a command formated cursor reply.
void	setAddress(String address) Sets the value of the server the original request was sent to.

Methods inherited from class com.allanbank.mongodb.client.callback.AbstractReplyCallback

exception, getForwardCallback, isLightWeight

Methods inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

asError, asError, asError, asString, callback, checkForError, toInt, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

CursorCallback

public CursorCallback(Client client,
              CursorableMessage message,
              boolean command,
              Callback<MongoIterator<Document>> results)

Create a new CursorCallback.

Parameters:

client - The client interface to the server.

message - The original query.

command - If true then the callback should expect a command formated cursor reply.

results - The callback to update once the first set of results are ready.

Method Detail

getAddress

public String getAddress()

Returns the server the original request was sent to.

Returns:

The server the original request was sent to.

setAddress

public void setAddress(String address)

Sets the value of the server the original request was sent to.

Specified by:

setAddress in interface AddressAware

Parameters:

address - The new value for the server the original request was sent to.

asError

protected MongoDbException asError(Reply reply,
                       int okValue,
                       int errorNumber,
                       String errorMessage)

Creates an exception from the parsed reply fields.

Overridden to add the Query to the exception.

Overrides:

asError in class AbstractValidatingReplyCallback

Parameters:

reply - The raw reply.

okValue - The 'ok' field.

errorNumber - The 'errno' field.

errorMessage - The 'errmsg' field.

Returns:

The exception created.

See Also:

AbstractValidatingReplyCallback.asError(Reply, int, int, String)

convert

protected MongoIterator<Document> convert(Reply reply)
                                   throws MongoDbException

Converts the Reply into the final response type.

Overridden to construct a MongoIteratorImpl around the reply.

Specified by:

convert in class AbstractReplyCallback<MongoIterator<Document>>

Parameters:

reply - The reply to convert.

Returns:

The converted reply.

Throws:

MongoDbException - On a failure converting the reply. Generally, the AbstractValidatingReplyCallback.verify(Reply) method should be used to report errors.

See Also:

AbstractReplyCallback.convert(Reply)

handle

protected void handle(Reply reply)

Called once the Reply has been validated.

Overriden to convert and then pass the converted reply to the forward callback.

Overridden to check if the server address has been set and if so then pass the converted reply to the forward callback. Otherwise the call is dropped.

Overrides:

handle in class AbstractReplyCallback<MongoIterator<Document>>

Parameters:

reply - The Reply to be handled.

isCommand

protected boolean isCommand()

Returns true if the callback should expect a command formated cursor reply.

Returns:

True if the callback should expect a command formated cursor reply.