com.allanbank.mongodb.connection.message

Class AdminCommand

java.lang.Object

com.allanbank.mongodb.connection.message.AbstractMessage

com.allanbank.mongodb.connection.message.Query

com.allanbank.mongodb.connection.message.Command

com.allanbank.mongodb.connection.message.AdminCommand

All Implemented Interfaces:

Message

Direct Known Subclasses:

IsMaster, ReplicaSetStatus, ServerStatus

public class AdminCommand
extends Command

Helper class to make generating administration command queries easier.

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-2012, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_DATABASE The administration database name.

Fields inherited from class com.allanbank.mongodb.connection.message.Command

COMMAND_COLLECTION

Fields inherited from class com.allanbank.mongodb.connection.message.Query

AWAIT_DATA_FLAG_BIT, DEFAULT_BATCH_SIZE, EXHAUST_FLAG_BIT, NO_CURSOR_TIMEOUT_FLAG_BIT, OPLOG_REPLAY_FLAG_BIT, PARTIAL_FLAG_BIT, REPLICA_OK_FLAG_BIT, TAILABLE_CURSOR_FLAG_BIT

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

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
AdminCommand(Document commandDocument) Create a new Command.

Method Summary

Methods inherited from class com.allanbank.mongodb.connection.message.Query

equals, getBatchSize, getLimit, getNumberToReturn, getNumberToSkip, getQuery, getReturnFields, hashCode, isAwaitData, isBatchSizeSet, isExhaust, isLimitSet, isNoCursorTimeout, isPartial, isTailable, validateSize, write

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

getCollectionName, getDatabaseName, getReadPreference, init, writeHeader

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_DATABASE

public static final String ADMIN_DATABASE

The administration database name.

See Also:

Constant Field Values

Constructor Detail

AdminCommand

public AdminCommand(Document commandDocument)

Create a new Command.

Parameters:

commandDocument - The command document containing the command and options.