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.command.admin.backup;
  
  import javax.inject.Inject;
  
  import org.apache.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.ApiErrorCode;
  import org.apache.cloudstack.api.BaseAsyncCmd;
  import org.apache.cloudstack.api.BaseCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.BackupOfferingResponse;
  import org.apache.cloudstack.api.response.ZoneResponse;
  import org.apache.cloudstack.backup.BackupManager;
  import org.apache.cloudstack.backup.BackupOffering;
  import org.apache.cloudstack.context.CallContext;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.ConcurrentOperationException;
  import com.cloud.exception.InsufficientCapacityException;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.NetworkRuleConflictException;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.utils.exception.CloudRuntimeException;
  
  @APICommand(name = "importBackupOffering",
          description = "Imports a backup offering using a backup provider",
          responseObject = BackupOfferingResponse.class, since = "4.14.0",
          authorized = {RoleType.Admin})
  public class ImportBackupOfferingCmd extends BaseAsyncCmd {
  
      @Inject
      private BackupManager backupManager;
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      ////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true,
              description = "the name of the backup offering")
      private String name;
  
      @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, required = true,
              description = "the description of the backup offering")
      private String description;
  
      @Parameter(name = ApiConstants.EXTERNAL_ID,
              type = CommandType.STRING,
              required = true,
              description = "The backup offering ID (from backup provider side)")
      private String externalId;
  
      @Parameter(name = ApiConstants.ZONE_ID, type = BaseCmd.CommandType.UUID, entityType = ZoneResponse.class,
              description = "The zone ID", required = true)
      private Long zoneId;
  
      @Parameter(name = ApiConstants.ALLOW_USER_DRIVEN_BACKUPS, type = CommandType.BOOLEAN,
              description = "Whether users are allowed to create adhoc backups and backup schedules", required = true)
      private Boolean userDrivenBackups;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public String getName() {
          return name;
      }
  
      public String getExternalId() {
          return externalId;
      }
  
      public Long getZoneId() {
          return zoneId;
      }
  
      public String getDescription() {
          return description;
      }
  
      public Boolean getUserDrivenBackups() {
          return userDrivenBackups == null ? false : userDrivenBackups;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
          try {
              BackupOffering policy = backupManager.importBackupOffering(this);
              if (policy != null) {
                  BackupOfferingResponse response = _responseGenerator.createBackupOfferingResponse(policy);
                  response.setResponseName(getCommandName());
                  setResponseObject(response);
              } else {
                  throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add a backup offering");
              }
          } catch (InvalidParameterValueException e) {
              throw new ServerApiException(ApiErrorCode.PARAM_ERROR, e.getMessage());
          } catch (CloudRuntimeException e) {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
          }
      }
  
      @Override
      public long getEntityOwnerId() {
          return CallContext.current().getCallingAccount().getId();
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_VM_BACKUP_IMPORT_OFFERING;
      }
  
      @Override
      public String getEventDescription() {
          return "Importing backup offering: " + name + " (external ID: " + externalId + ") on zone ID " + zoneId ;
      }
  }
  