com.allanbank.mongodb.connection.message

Class IsMaster

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

com.allanbank.mongodb.connection.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.connection.message.AdminCommand

ADMIN_DATABASE

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

IS_MASTER

public static final Document IS_MASTER

The ismaster "query" document.

Constructor Detail

IsMaster

public IsMaster()

Create a new IsMaster command.