com.allanbank.mongodb.connection

Interface Message

All Known Implementing Classes:

AbstractMessage, AdminCommand, Command, Delete, GetLastError, GetMore, Insert, IsMaster, KillCursors, Query, ReplicaSetStatus, Reply, ServerStatus, Update

public interface Message

Common interface for all MongoDB messages read from and sent to a MongoDB server.

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getDatabaseName() Returns the name of the database.
ReadPreference	getReadPreference() Provides the details on which servers are eligible to receive the message.
void	validateSize(SizeOfVisitor visitor, 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.

Method Detail

getDatabaseName

String getDatabaseName()

Returns the name of the database.

Returns:

The name of the database.

getReadPreference

ReadPreference getReadPreference()

Provides the details on which servers are eligible to receive the message.

Returns:

The ReadPreference for which servers should be sent the request.

validateSize

void validateSize(SizeOfVisitor visitor,
                int maxDocumentSize)
                  throws DocumentToLargeException

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

Parameters:

visitor - The SizeOfVisitor to compute the size of the document.

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

void write(int messageId,
         BsonOutputStream out)
           throws IOException

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

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.