View Javadoc
1   /*
2    * #%L
3    * AdminCommand.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  
24  /**
25   * Helper class to make generating administration command queries easier.
26   * 
27   * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
28   *         mutated in incompatible ways between any two releases of the driver.
29   * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
30   */
31  public class AdminCommand extends Command {
32  
33      /** The administration database name. */
34      public static final String ADMIN_DATABASE = "admin";
35  
36      /**
37       * Create a new Command.
38       * 
39       * @param commandDocument
40       *            The command document containing the command and options.
41       */
42      public AdminCommand(final Document commandDocument) {
43          super(ADMIN_DATABASE, COMMAND_COLLECTION, commandDocument);
44      }
45  }