com.mongodb.connection

Class CommandMessage

java.lang.Object

com.mongodb.connection.RequestMessage

com.mongodb.connection.CommandMessage

class CommandMessage
extends RequestMessage

A command message that uses OP_QUERY to send the command.

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.connection.RequestMessage

RequestMessage.EncodingMetadata, RequestMessage.OpCode

Field Summary

Fields

Modifier and Type	Field and Description
private BsonDocument	command
private boolean	slaveOk
private FieldNameValidator	validator

Fields inherited from class com.mongodb.connection.RequestMessage

REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
CommandMessage(java.lang.String collectionName, BsonDocument command, boolean slaveOk, FieldNameValidator validator, MessageSettings settings) Construct an instance.
CommandMessage(java.lang.String collectionName, BsonDocument command, boolean slaveOk, MessageSettings settings) Construct an instance.

Method Summary

Modifier and Type	Method and Description
protected RequestMessage	encodeMessageBody(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.
protected RequestMessage.EncodingMetadata	encodeMessageBodyWithMetadata(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.

Methods inherited from class com.mongodb.connection.RequestMessage

addCollectibleDocument, addDocument, backpatchMessageLength, encode, encodeWithMetadata, getCodec, getCollectionName, getCurrentGlobalId, getId, getNamespace, getOpCode, getSettings, writeMessagePrologue

Methods inherited from class java.lang.Object

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

Field Detail

slaveOk

private final boolean slaveOk

command

private final BsonDocument command

validator

private final FieldNameValidator validator

Constructor Detail

CommandMessage

public CommandMessage(java.lang.String collectionName,
                      BsonDocument command,
                      boolean slaveOk,
                      MessageSettings settings)

Construct an instance.

Parameters:

collectionName - the collection to execute the command in

command - the command

slaveOk - if querying of non-primary replica set members is allowed

settings - the message settings

CommandMessage

public CommandMessage(java.lang.String collectionName,
                      BsonDocument command,
                      boolean slaveOk,
                      FieldNameValidator validator,
                      MessageSettings settings)

Construct an instance.

Parameters:

collectionName - the collection to execute the command in

command - the command

slaveOk - if querying of non-primary replica set members is allowed

validator - the field name validator

settings - the message settings

Method Detail

encodeMessageBody

protected RequestMessage encodeMessageBody(BsonOutput bsonOutput,
                                           int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBody in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the next message to encode, if the contents of this message need to overflow into the next

encodeMessageBodyWithMetadata

protected RequestMessage.EncodingMetadata encodeMessageBodyWithMetadata(BsonOutput bsonOutput,
                                                                        int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBodyWithMetadata in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the encoding metadata