1 /*
2 * #%L
3 * IsMaster.java - mongodb-async-driver - Allanbank Consulting, Inc.
4 * %%
5 * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package com.allanbank.mongodb.client.message;
21
22 import com.allanbank.mongodb.bson.Document;
23 import com.allanbank.mongodb.bson.builder.BuilderFactory;
24 import com.allanbank.mongodb.bson.builder.DocumentBuilder;
25 import com.allanbank.mongodb.bson.impl.ImmutableDocument;
26
27 /**
28 * Provides a convenient mechanism for creating a <a href=
29 * "http://docs.mongodb.org/manual/reference/command/isMaster/" >ismaster</a>
30 * command.
31 * <p>
32 * This is a helper class for retrieving the status of replica sets. The results
33 * of this command will look like:
34 * </p>
35 * <blockquote>
36 *
37 * <pre>
38 * <code>
39 * {
40 * "ismaster" : false,
41 * "secondary" : true,
42 * "hosts" : [
43 * "ny1.acme.com",
44 * "ny2.acme.com",
45 * "sf1.acme.com"
46 * ],
47 * "passives" : [
48 * "ny3.acme.com",
49 * "sf3.acme.com"
50 * ],
51 * "arbiters" : [
52 * "sf2.acme.com",
53 * ]
54 * "primary" : "ny2.acme.com",
55 * "ok" : true
56 * }
57 * </code>
58 * </pre>
59 *
60 * </blockquote>
61 *
62 *
63 * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
64 * mutated in incompatible ways between any two releases of the driver.
65 * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
66 */
67 public class IsMaster extends AdminCommand {
68
69 /** The ismaster "query" document. */
70 public static final Document IS_MASTER;
71
72 static {
73 final DocumentBuilder builder = BuilderFactory.start();
74 builder.addInteger("isMaster", 1);
75 IS_MASTER = new ImmutableDocument(builder);
76 }
77
78 /**
79 * Create a new IsMaster command.
80 */
81 public IsMaster() {
82 super(IS_MASTER);
83 }
84 }