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.volume;
  
  import com.cloud.event.EventTypes;
  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 com.cloud.storage.Volume;
  import com.cloud.user.Account;
  
  import org.apache.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiCommandResourceType;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.ApiErrorCode;
  import org.apache.cloudstack.api.BaseAsyncCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.SuccessResponse;
  import org.apache.cloudstack.api.response.VolumeResponse;
  import org.apache.cloudstack.storage.volume.VolumeImportUnmanageService;
  
  import javax.inject.Inject;
  
  @APICommand(name = "unmanageVolume",
          description = "Unmanage a volume on storage pool.",
          entityType = {Volume.class},
          responseObject = SuccessResponse.class,
          requestHasSensitiveInfo = false,
          authorized = {RoleType.Admin},
          since = "4.19.1")
  public class UnmanageVolumeCmd extends BaseAsyncCmd {
  
      @Inject
      public VolumeImportUnmanageService volumeImportService;
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID,
              type = CommandType.UUID,
              entityType = VolumeResponse.class,
              required = true,
              description = "The ID of the volume to unmanage")
      private Long volumeId;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
  
      public Long getVolumeId() {
          return volumeId;
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_VOLUME_UNMANAGE;
      }
  
      @Override
      public String getEventDescription() {
          return String.format("Unmanaging Volume with ID %s", volumeId);
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException,
              ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
          try {
              boolean result = volumeImportService.unmanageVolume(volumeId);
              if (result) {
                  SuccessResponse response = new SuccessResponse(getCommandName());
                  setResponseObject(response);
              } else {
                  throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to unmanage the volume");
              }
  
          } catch (Exception e) {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getLocalizedMessage());
          }
      }
  
      @Override
      public long getEntityOwnerId() {
          Volume volume = _responseGenerator.findVolumeById(volumeId);
          if (volume != null) {
              return volume.getAccountId();
          }
          return Account.ACCOUNT_ID_SYSTEM;
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
          return ApiCommandResourceType.Volume;
      }
  
      @Override
      public Long getApiResourceId() {
          return volumeId;
      }
  
  }
  