com.allanbank.mongodb.client

Interface Message

All Known Subinterfaces:

CursorableMessage

All Known Implementing Classes:

AbstractMessage, AdminCommand, AggregateCommand, BatchedWriteCommand, BuildInfo, Command, CreateIndexCommand, Delete, GetLastError, GetMore, Insert, IsMaster, KillCursors, ParallelScanCommand, 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.
String	getOperationName() Returns a short name for the operation.
ReadPreference	getReadPreference() Provides the details on which servers are eligible to receive the message.
VersionRange	getRequiredVersionRange() Returns the required version range for the message.
int	size() Returns the total size of the message on the wire.
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.
void	write(int messageId, BufferingBsonOutputStream out) Writes the message from the stream.

Method Detail

getDatabaseName

String getDatabaseName()

Returns the name of the database.

Returns:

The name of the database.

getOperationName

String getOperationName()

Returns a short name for the operation.

Returns:

A short name for the operation.

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.

getRequiredVersionRange

VersionRange getRequiredVersionRange()

Returns the required version range for the message.

This may be null which should be interpreted to mean that all versions of the server support the message's operation. In reality that is probably more accurately stated as all supported versions.

Returns:

The version of the server that introduced support for the operation.

size

int size()

Returns the total size of the message on the wire.

Returns:

The size of the message on the wire.

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.

write

void write(int messageId,
         BufferingBsonOutputStream 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.