content: // Licensed to the Apache Software Foundation (ASF) under one
  // or more contributor license agreements.  See the NOTICE file
  // distributed with this work for additional information
  // regarding copyright ownership.  The ASF licenses this file
  // to you 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.
  package org.apache.cloudstack.api;
  
  import com.cloud.cpu.CPU;
  import org.apache.cloudstack.api.response.GuestOSResponse;
  import org.apache.cloudstack.api.response.TemplateResponse;
  import org.apache.commons.lang3.StringUtils;
  
  import java.util.Collection;
  import java.util.Map;
  
  public abstract class BaseUpdateTemplateOrIsoCmd extends BaseCmd {
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "true if image is bootable, false otherwise; available only for updateIso API")
      private Boolean bootable;
  
      @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "true if the template requires HVM, false otherwise; available only for updateTemplate API")
      private Boolean requiresHvm;
  
      @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the image", length = 4096)
      private String displayText;
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the image file")
      private Long id;
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the image file")
      private String templateName;
  
      @Parameter(name = ApiConstants.OS_TYPE_ID,
                 type = CommandType.UUID,
                 entityType = GuestOSResponse.class,
                 description = "the ID of the OS type that best represents the OS of this image.")
      private Long osTypeId;
  
      @Parameter(name = ApiConstants.FORCE_UPDATE_OS_TYPE, type = CommandType.BOOLEAN, since = "4.21", description = "Force OS type update. Warning: Updating OS type will " +
              "update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.")
      private Boolean forceUpdateOsType;
  
      @Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, description = "the format for the image")
      private String format;
  
      @Parameter(name = ApiConstants.PASSWORD_ENABLED, type = CommandType.BOOLEAN, description = "true if the image supports the password reset feature; default is false")
      private Boolean passwordEnabled;
  
      @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the sshkey upload feature; default is false")
      private Boolean sshKeyEnabled;
  
      @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the template, integer")
      private Integer sortKey;
  
      @Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
                 type = CommandType.BOOLEAN,
                 description = "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
      private Boolean isDynamicallyScalable;
  
      @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "true if the template type is routing i.e., if template is used to deploy router")
      protected Boolean isRoutingType;
  
      @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61")
      protected Map details;
  
      @Parameter(name = ApiConstants.CLEAN_UP_DETAILS,
              type = CommandType.BOOLEAN,
              description = "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)")
      private Boolean cleanupDetails;
  
      @Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
              description = "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64",
              since = "4.20")
      private String arch;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Boolean getBootable() {
          return bootable;
      }
  
      public Boolean getRequiresHvm() {
          return requiresHvm;
      }
  
      public String getDisplayText() {
          return displayText;
      }
  
      public Long getId() {
          return id;
      }
  
      public String getTemplateName() {
          return templateName;
      }
  
      public Long getOsTypeId() {
          return osTypeId;
      }
  
      public Boolean getForceUpdateOsType() {
          return forceUpdateOsType;
      }
  
      public Boolean getPasswordEnabled() {
          return passwordEnabled;
      }
  
      public Boolean isSshKeyEnabled() {
          return sshKeyEnabled;
      }
  
      public String getFormat() {
          return format;
      }
  
      public Integer getSortKey() {
          return sortKey;
      }
  
      public Boolean isDynamicallyScalable() {
          return isDynamicallyScalable;
      }
  
      public Boolean isRoutingType() {
          return isRoutingType;
      }
  
      public Map getDetails() {
          if (this.details == null || this.details.isEmpty()) {
              return null;
          }
  
          Collection paramsCollection = this.details.values();
          return (Map) (paramsCollection.toArray())[0];
      }
  
      public boolean isCleanupDetails(){
          return cleanupDetails == null ? false : cleanupDetails.booleanValue();
      }
  
      public CPU.CPUArch getCPUArch() {
          if (StringUtils.isBlank(arch)) {
              return null;
          }
          return CPU.CPUArch.fromType(arch);
      }
  }
  