com.allanbank.mongodb.client.message

Class IsMaster

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

com.allanbank.mongodb.client.message.AdminCommand

com.allanbank.mongodb.client.message.IsMaster

All Implemented Interfaces:

Message

public class IsMaster
extends AdminCommand

Provides a convenient mechanism for creating a ismaster command.

This is a helper class for retrieving the status of replica sets. The results of this command will look like:

 
 {
         "ismaster" : false,
         "secondary" : true,
         "hosts" : [
                 "ny1.acme.com",
                 "ny2.acme.com",
                 "sf1.acme.com"
         ],
         "passives" : [
              "ny3.acme.com",
              "sf3.acme.com"
         ],
         "arbiters" : [
             "sf2.acme.com",
         ]
         "primary" : "ny2.acme.com",
         "ok" : true
 }
 
 

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 Document	IS_MASTER The ismaster "query" document.

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

ADMIN_DATABASE

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
IsMaster() Create a new IsMaster 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

IS_MASTER

public static final Document IS_MASTER

The ismaster "query" document.

Constructor Detail

IsMaster

public IsMaster()

Create a new IsMaster command.