* Copyright (c) 2012-2014 VMware, Inc. All Rights Reserved.

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

*     http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

***************************************************************************/

   /**

    * Default short and long time-outs to help our callers:

    * - short timeout

    *   for use when the database is known to have been previously shut down cleanly

    *   and we will not go into crash recovery, mkfs, etc, upon boot.

    * - long timeout

    *   a conservative timeout when we know nothing about the current state of the

    *   vm. Used as a last resort to prevent permanent leakage of CMS threads on DBVM

    *   hangs of any kind.

    */

   public static final int SHORT_POWER_ON_TIMEOUT_SECS = 10 * 60;

   public static final int LONG_POWER_ON_TIMEOUT_SECS = 2 * 60 * 60;

   /**

    * Sometimes VC's state for VM can be out of sync with

    * what is reported by events and exceptions. As the latter may

    * be generated as a result of hostd state.

    *

    * We use the following timeout to wait for VC to sync its state

    * when we detect such occasion.

    */

   public static final int WAIT_FOR_VC_STATE_TIMEOUT_SECS = 60;

   /**

    * This enum defines the collection of keys that stored as key-value map in the

    * VM's configuration file (vmx file). Use VcVirtualMachine.getDbvmConfig() and

    * VcVirtualMachine.setDbvmConfig() to access the key-value map.

    */

   public enum DbvmConfigKey {

      Dbvm_Description("vm.desc"),

      Import_Error("vm.import_error");

      private String key;

      private DbvmConfigKey(String key) {

         this.key = key;

      }

      public String getKey() {

         return key;

      }

   }

   @SuppressWarnings("serial")

   public class GuestVarReturnCode implements Serializable {

      /* These mirror definitions in agent/src/main/scripts/interface.sh */

      int GUEST_V_DONE = 1; // All is well.

      int GUEST_V_DOING = 0; // In-progress.

      private int code = 0;

      private String statusMsg;

      private String privateIP;

      private Map<String, String> guestVariables = null;

      GuestVarReturnCode(Map<String, String> guestVariables) {

         this.guestVariables = guestVariables;

         String retCode = guestVariables.get("guestinfo.return_code");

         code = Integer.parseInt(retCode);

         if (code == GUEST_V_DONE) {

            statusMsg = "Success";

            privateIP = guestVariables.get("guestinfo.dbvm_private_ip");

         } else if (code == GUEST_V_DOING) {

            statusMsg = "Busy";

         } else {

            AuAssert.check(code < 0);

            statusMsg = guestVariables.get("guestinfo.error_message");

            if (statusMsg == null) {

               statusMsg = "Error"; // Unknown error?

            }

         }

         statusMsg = statusMsg + " (" + code + ")";

      }

      public boolean isSuccess() {

         return code == GUEST_V_DONE;

      }

      public boolean isBusy() {

         return code == GUEST_V_DOING;

      }

      public boolean isError() {

         return code < 0;

      }

      public String getStatusMsg() {

         return statusMsg;

      }

      public String getPrivateIP() {

         return privateIP;

      }

      public Map<String, String> getGuestVariables() {

         return guestVariables;

      }

   }

    * Configuration specification for creating a new virtual machine.

    */

   static public class CreateSpec {

      final String name;

      /**

       * Configuration of VM snapshot from which to clone.

       */

      final VcSnapshot parentSnap;

      /**

       * Resource pool to deploy the new VM.

       */

      final VcResourcePool rp;

      /**

       * Datastore to deploy the new VM.

       */

      final VcDatastore ds;

      /**

       * True if this is a link clone.

       */

      final boolean linkClone;

      /**

       * More VM configuration changes.

       */

      final ConfigSpec spec;

      /**

       * VM folder to hold the new VM,

       * if null, the VM will be put in the root VM folder for the datacenter,

       * in which the resource pool lives.

       */

      final Folder folder;

      /**

       * the vc host the new vm be placed

       */

      final VcHost host;

      /**

       * Create a clone from a VM snapshot.

       */

      public CreateSpec(String name, VcSnapshot parent, VcResourcePool rp, VcDatastore ds,

                        boolean linkClone, ConfigSpec spec) {

         this(name, parent, rp, ds, null, null, linkClone, spec);

      }

      /**

       * Create a clone from a VM snapshot.

       */

      public CreateSpec(String name, VcSnapshot parent, VcResourcePool rp, VcDatastore ds, Folder folder,

            VcHost host, boolean linkClone, ConfigSpec spec) {

         parentSnap = parent;

         AuAssert.check(parentSnap != null);

         this.name = name;

         this.rp = rp;

         this.ds = ds;

         this.folder = folder;

         this.host = host;

         this.linkClone = linkClone;

         this.spec = spec;

      }

      /**

       * @return the corresponding {@link VcSnapshot} object that contains the VM Config.

       */

      VcSnapshot getParentSnapshot() {

         return parentSnap;

      }

      /**

       * @return the parent {@link VcVirtualMachine} VM object .

       */

      VcVirtualMachine getParentVm() {

         return parentSnap.getVm();

      }

   }

   public class DiskCreateSpec {

      DeviceId deviceId;

      VcDatastore ds = null;

      String diskName;

      DiskMode diskMode;

      DiskSize size = null;

      AllocationType allocationType;

      public DiskCreateSpec(DeviceId deviceId, VcDatastore ds, String diskName,

                 DiskMode diskMode, DiskSize size, AllocationType allocationType) {

         this.deviceId = deviceId;

         this.ds = ds;

         this.diskName = diskName;

         this.diskMode = diskMode;

         this.size = size;

         this.allocationType = allocationType;

         AuAssert.check(deviceId != null);