com.allanbank.mongodb.client.message

Class Command

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

All Implemented Interfaces:

Message

Direct Known Subclasses:

AdminCommand, AggregateCommand, BatchedWriteCommand, CreateIndexCommand, ParallelScanCommand

public class Command
extends AbstractMessage

Helper class to make generating command queries easier. Commands are communicated to the server as Operation.QUERY messages. We don't use the Query class as a base class as it adds a lot of weight to the commands.

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 String	COMMAND_COLLECTION The collection to use when issuing commands to the database.

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

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Command(String databaseName, String collectionName, Document commandDocument) Create a new Command.
Command(String databaseName, String collectionName, Document commandDocument, Document routingDocument, ReadPreference readPreference, VersionRange requiredServerVersion) Create a new Command.
Command(String databaseName, String collectionName, Document commandDocument, ReadPreference readPreference) Create a new Command.
Command(String databaseName, String collectionName, Document commandDocument, ReadPreference readPreference, VersionRange requiredServerVersion) Create a new Command.

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.
Document	getCommand() Returns the command's document.
String	getOperationName() Returns a short name for the operation.
Document	getRoutingDocument() Returns the routingDocument value.
int	hashCode() Computes a reasonable hash code.
boolean	isAllowJumbo() Returns true if the command document is allowed to slightly exceed the document size limit.
void	setAllowJumbo(boolean allowJumbo) If set to true then the command document is allowed to slightly exceed the document size limit.
int	size() Returns the total size of the message on the wire.
String	toString()
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.

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, wait, wait, wait

Field Detail

COMMAND_COLLECTION

public static final String COMMAND_COLLECTION

The collection to use when issuing commands to the database.

See Also:

Constant Field Values

Constructor Detail

Command

public Command(String databaseName,
       String collectionName,
       Document commandDocument)

Create a new Command.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not "$cmd" if the real collection is known.

commandDocument - The command document containing the command and options.

Command

public Command(String databaseName,
       String collectionName,
       Document commandDocument,
       Document routingDocument,
       ReadPreference readPreference,
       VersionRange requiredServerVersion)

Create a new Command.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not "$cmd" if the real collection is known.

commandDocument - The command document containing the command and options.

routingDocument - The document that should be used for routing the command.

readPreference - The preference for which servers to use to retrieve the results.

requiredServerVersion - The required version of the server to support processing the message.

Command

public Command(String databaseName,
       String collectionName,
       Document commandDocument,
       ReadPreference readPreference)

Create a new Command.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not "$cmd" if the real collection is known.

commandDocument - The command document containing the command and options.

readPreference - The preference for which servers to use to retrieve the results.

Command

public Command(String databaseName,
       String collectionName,
       Document commandDocument,
       ReadPreference readPreference,
       VersionRange requiredServerVersion)

Create a new Command.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not "$cmd" if the real collection is known.

commandDocument - The command document containing the command and options.

readPreference - The preference for which servers to use to retrieve the results.

requiredServerVersion - The required version of the server to support processing the message.

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)

getCommand

public Document getCommand()

Returns the command's document.

Returns:

The command's document.

getOperationName

public String getOperationName()

Returns a short name for the operation.

Overridden to return the command name.

Returns:

A short name for the operation.

getRoutingDocument

public Document getRoutingDocument()

Returns the routingDocument value.

Returns:

The routingDocument value.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

isAllowJumbo

public boolean isAllowJumbo()

Returns true if the command document is allowed to slightly exceed the document size limit.

Returns:

True if the command document is allowed to slightly exceed the document size limit.

setAllowJumbo

public void setAllowJumbo(boolean allowJumbo)

If set to true then the command document is allowed to slightly exceed the document size limit. This allows us to pack a full size document in a insert command.

Parameters:

allowJumbo - If true then the command document is allowed to slightly exceed the document size limit.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the Command.

Returns:

The size of the message on the wire.

toString

public String toString()

Overridden to return a human readable form of the command.

Overrides:

toString in class Object

validateSize

public void validateSize(SizeOfVisitor visitor,
                int maxDocumentSize)
                  throws DocumentToLargeException

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

Overridden to make sure the command document is not too large.

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

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 Command as a Operation.QUERY 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.

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 Command as a Operation.QUERY 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.