com.allanbank.mongodb.client.message

Class AdminCommand

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

com.allanbank.mongodb.client.message.AdminCommand

All Implemented Interfaces:

Message

Direct Known Subclasses:

BuildInfo, 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-2013, 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.client.message.Command

COMMAND_COLLECTION

Fields inherited from class com.allanbank.mongodb.client.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.client.message.Command

equals, getCommand, getOperationName, getRoutingDocument, hashCode, isAllowJumbo, setAllowJumbo, size, toString, validateSize, write, write

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

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.