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.user.backup;
  
  import javax.inject.Inject;
  
  import com.amazonaws.util.CollectionUtils;
  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.BaseListProjectAndAccountResourcesCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.BackupScheduleResponse;
  import org.apache.cloudstack.api.response.ListResponse;
  import org.apache.cloudstack.api.response.UserVmResponse;
  import org.apache.cloudstack.backup.BackupManager;
  import org.apache.cloudstack.backup.BackupSchedule;
  import org.apache.cloudstack.context.CallContext;
  
  import com.cloud.exception.ConcurrentOperationException;
  import com.cloud.exception.InsufficientCapacityException;
  import com.cloud.exception.NetworkRuleConflictException;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.exception.ResourceUnavailableException;
  
  import java.util.ArrayList;
  import java.util.List;
  
  @APICommand(name = "listBackupSchedule",
          description = "List backup schedule of a VM",
          responseObject = BackupScheduleResponse.class, since = "4.14.0",
          authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
  public class ListBackupScheduleCmd extends BaseListProjectAndAccountResourcesCmd {
  
      @Inject
      BackupManager backupManager;
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
              type = CommandType.UUID,
              entityType = UserVmResponse.class,
              description = "ID of the VM")
      private Long vmId;
  
      @Parameter(name = ApiConstants.ID,
              type = CommandType.UUID,
              entityType = BackupScheduleResponse.class,
              description = "the ID of the backup schedule",
              since = "4.22.0")
      private Long id;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getVmId() {
          return vmId;
      }
  
      public Long getId() {
          return id;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
          try{
              List<BackupSchedule> schedules = backupManager.listBackupSchedules(this);
              ListResponse<BackupScheduleResponse> response = new ListResponse<>();
              List<BackupScheduleResponse> scheduleResponses = new ArrayList<>();
  
              if (!CollectionUtils.isNullOrEmpty(schedules)) {
                  for (BackupSchedule schedule : schedules) {
                      scheduleResponses.add(_responseGenerator.createBackupScheduleResponse(schedule));
                  }
              }
              response.setResponses(scheduleResponses, schedules.size());
              response.setResponseName(getCommandName());
              setResponseObject(response);
          } catch (Exception e) {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
          }
      }
  
      @Override
      public long getEntityOwnerId() {
          return CallContext.current().getCallingAccount().getId();
      }
  }
  