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 java.util.List;
  
  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.BaseBackupListCmd;
  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 com.cloud.exception.ConcurrentOperationException;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.utils.exception.CloudRuntimeException;
  
  @APICommand(name = "listBackupProviderOfferings",
          description = "Lists external backup offerings of the provider",
          responseObject = BackupOfferingResponse.class, since = "4.14.0",
          authorized = {RoleType.Admin})
  public class ListBackupProviderOfferingsCmd extends BaseBackupListCmd {
  
      @Inject
      private BackupManager backupManager;
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ZONE_ID, type = BaseCmd.CommandType.UUID, entityType = ZoneResponse.class,
              required = true, description = "The zone ID")
      private Long zoneId;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getZoneId() {
          return zoneId;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      private void validateParameters() {
          if (getZoneId() == null) {
              throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Please provide a valid zone ID ");
          }
      }
  
      @Override
      public void execute() throws ResourceUnavailableException, ServerApiException, ConcurrentOperationException {
          validateParameters();
          try {
              final List<BackupOffering> backupOfferings = backupManager.listBackupProviderOfferings(getZoneId());
              setupResponseBackupOfferingsList(backupOfferings, backupOfferings.size());
          } catch (InvalidParameterValueException e) {
              throw new ServerApiException(ApiErrorCode.PARAM_ERROR, e.getMessage());
          } catch (CloudRuntimeException e) {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
          }
      }
  
      }
  