com.allanbank.mongodb.client.message

Class Reply

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Reply

All Implemented Interfaces:

Message

public class Reply
extends AbstractMessage

Message received from the database in reply to a query.

 
 struct {
     MsgHeader header;         // standard message header
     int32     responseFlags;  // bit vector - see details below
     int64     cursorID;       // cursor id if client needs to do get more's
     int32     startingFrom;   // where in the cursor this reply is starting
     int32     numberReturned; // number of documents in the reply
     document* documents;      // documents
 }
 
 

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	AWAIT_CAPABLE_BIT Bit for the await capable flag.
static int	CURSOR_NOT_FOUND_BIT Bit for the cursor not found flag.
static int	QUERY_FAILURE_BIT Bit for the query failure flag.
static int	SHARD_CONFIG_STALE_BIT Bit for the shard configuration stale flag.

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Reply(Header header, BsonInputStream in) Creates a new Reply.
Reply(int responseToId, long cursorId, int cursorOffset, List<Document> results, boolean awaitCapable, boolean cursorNotFound, boolean queryFailed, boolean shardConfigStale) Creates a new Reply.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
long	getCursorId() Returns the id of the cursor if the user needs to do a get_more to get the complete results.
int	getCursorOffset() Returns the offset (index) of the first document returned from the cursor.
String	getOperationName() Returns a short name for the operation.
int	getResponseToId() Returns the id of the request this response is for.
List<Document>	getResults() Returns the query results.
int	hashCode() Computes a reasonable hash code.
boolean	isAwaitCapable() Returns true if the server is await capable for tailable cursors.
boolean	isCursorNotFound() Returns true if the cursor in the get_more message was not found.
boolean	isQueryFailed() Returns true if the query failed.
boolean	isShardConfigStale() Returns true if the shard configuration is stale.
int	size() Returns the total size of the message on the wire.
void	validateSize(int maxDocumentSize) Validates that the documents with the message do not exceed the maximum document size specified.
void	write(int messageId, BsonOutputStream out) Writes the message from the stream.
void	write(int messageId, BufferingBsonOutputStream out) Writes the message from the stream.

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

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

Field Detail

AWAIT_CAPABLE_BIT

public static final int AWAIT_CAPABLE_BIT

Bit for the await capable flag.

See Also:

Constant Field Values

CURSOR_NOT_FOUND_BIT

public static final int CURSOR_NOT_FOUND_BIT

Bit for the cursor not found flag.

See Also:

Constant Field Values

QUERY_FAILURE_BIT

public static final int QUERY_FAILURE_BIT

Bit for the query failure flag.

See Also:

Constant Field Values

SHARD_CONFIG_STALE_BIT

public static final int SHARD_CONFIG_STALE_BIT

Bit for the shard configuration stale flag.

See Also:

Constant Field Values

Constructor Detail

Reply

public Reply(Header header,
     BsonInputStream in)
      throws IOException

Creates a new Reply.

Parameters:

header - The header from the reply message.

in - Stream to read the reply message from.

Throws:

IOException - On a failure to read the reply.

Reply

public Reply(int responseToId,
     long cursorId,
     int cursorOffset,
     List<Document> results,
     boolean awaitCapable,
     boolean cursorNotFound,
     boolean queryFailed,
     boolean shardConfigStale)

Creates a new Reply.

Parameters:

responseToId - The id of the request this response is for.

cursorId - The id of the cursor if the user needs to do a get_more to get the complete results.

cursorOffset - The offset (index) of the first document returned from the cursor.

results - The returned documents.

awaitCapable - If true, indicates the server is await capable for tailable cursors.

cursorNotFound - If true, indicates that the cursor in the get_more message was not found.

queryFailed - If true, indicates that the query failed.

shardConfigStale - If true, indicates (to a MongoS?) that its shard configuration is stale.

Method Detail

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class AbstractMessage

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getCursorId

public long getCursorId()

Returns the id of the cursor if the user needs to do a get_more to get the complete results.

Returns:

The id of the cursor if the user needs to do a get_more to get the complete results.

getCursorOffset

public int getCursorOffset()

Returns the offset (index) of the first document returned from the cursor.

Returns:

The offset (index) of the first document returned from the cursor.

getOperationName

public String getOperationName()

Returns a short name for the operation.

Overridden to return the name of the operation: "REPLY".

Returns:

A short name for the operation.

getResponseToId

public int getResponseToId()

Returns the id of the request this response is for.

Returns:

The id of the request this response is for.

getResults

public List<Document> getResults()

Returns the query results.

Returns:

The query results.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

isAwaitCapable

public boolean isAwaitCapable()

Returns true if the server is await capable for tailable cursors.

Returns:

True if the server is await capable for tailable cursors.

isCursorNotFound

public boolean isCursorNotFound()

Returns true if the cursor in the get_more message was not found.

Returns:

True if the cursor in the get_more message was not found.

isQueryFailed

public boolean isQueryFailed()

Returns true if the query failed.

Returns:

True if the query failed.

isShardConfigStale

public boolean isShardConfigStale()

Returns true if the shard configuration is stale.

Returns:

True if the shard configuration is stale.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the Query.

Returns:

The size of the message on the wire.

validateSize

public void validateSize(int maxDocumentSize)
                  throws DocumentToLargeException

Validates that the documents with the message do not exceed the maximum document size specified.

Overrridden to be a no-op since we normally only receive a reply and don't care about the size.

Parameters:

maxDocumentSize - The maximum document size to validate against.

Throws:

DocumentToLargeException - If one of the documents in the message is too large or the documents in aggregate are too large.

write

public void write(int messageId,
         BsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write the reply message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)

write

public void write(int messageId,
         BufferingBsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write the reply message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)