1 /*
2 * #%L
3 * BuildInfo.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/buildInfo/" >buildinfo</a>
30 * command.
31 * <p>
32 * This is a helper class for retrieving the version of the server:
33 * </p>
34 * <blockquote>
35 *
36 * <pre>
37 * <code>
38 * {
39 * "version" : "2.2.6",
40 * "gitVersion" : "nogitversion",
41 * "sysInfo" : "Linux buildvm-09.phx2.fedoraproject.org 2.6.32-358.14.1.el6.x86_64 #1 SMP Mon Jun 17 15:54:20 EDT 2013 x86_64 BOOST_LIB_VERSION=1_50",
42 * "versionArray" : [
43 * 2,
44 * 2,
45 * 6,
46 * 0
47 * ],
48 * "bits" : 64,
49 * "debug" : false,
50 * "maxBsonObjectSize" : 16777216,
51 * "ok" : 1
52 * }
53 * </code>
54 * </pre>
55 *
56 * </blockquote>
57 *
58 * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
59 * mutated in incompatible ways between any two releases of the driver.
60 * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
61 */
62 public class BuildInfo extends AdminCommand {
63
64 /** The ismaster "query" document. */
65 public static final Document BUILD_INFO;
66
67 static {
68 final DocumentBuilder builder = BuilderFactory.start();
69 builder.addInteger("buildinfo", 1);
70 BUILD_INFO = new ImmutableDocument(builder);
71 }
72
73 /**
74 * Create a new IsMaster command.
75 */
76 public BuildInfo() {
77 super(BUILD_INFO);
78 }
79 }