| // 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.vm; |
| |
| import org.apache.log4j.Logger; |
| |
| import org.apache.cloudstack.acl.SecurityChecker.AccessType; |
| import org.apache.cloudstack.api.ACL; |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiCommandJobType; |
| 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.UserVmResponse; |
| import org.apache.cloudstack.context.CallContext; |
| |
| import com.cloud.event.EventTypes; |
| import com.cloud.exception.ConcurrentOperationException; |
| import com.cloud.exception.InvalidParameterValueException; |
| import com.cloud.exception.ResourceUnavailableException; |
| import com.cloud.user.Account; |
| import com.cloud.uservm.UserVm; |
| import com.cloud.utils.exception.CloudRuntimeException; |
| import com.cloud.vm.VirtualMachine; |
| |
| @APICommand(name = "expungeVirtualMachine", description = "Expunge a virtual machine. Once expunged, it cannot be recoverd.", responseObject = SuccessResponse.class, entityType = {VirtualMachine.class}, |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class ExpungeVMCmd extends BaseAsyncCmd { |
| public static final Logger s_logger = Logger.getLogger(ExpungeVMCmd.class.getName()); |
| |
| private static final String s_name = "expungevirtualmachineresponse"; |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @ACL(accessType = AccessType.OperateEntry) |
| @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine") |
| private Long id; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public Long getId() { |
| return id; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public String getCommandName() { |
| return s_name; |
| } |
| |
| @Override |
| public long getEntityOwnerId() { |
| UserVm vm = _responseGenerator.findUserVmById(getId()); |
| if (vm != null) { |
| return vm.getAccountId(); |
| } |
| |
| return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are tracked |
| } |
| |
| @Override |
| public String getEventType() { |
| return EventTypes.EVENT_VM_EXPUNGE; |
| } |
| |
| @Override |
| public String getEventDescription() { |
| return "Expunging vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()); |
| } |
| |
| @Override |
| public ApiCommandJobType getInstanceType() { |
| return ApiCommandJobType.VirtualMachine; |
| } |
| |
| @Override |
| public Long getInstanceId() { |
| return getId(); |
| } |
| |
| @Override |
| public void execute() throws ResourceUnavailableException, ConcurrentOperationException { |
| CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId())); |
| try { |
| UserVm result = _userVmService.expungeVm(this.getId()); |
| |
| if (result != null) { |
| SuccessResponse response = new SuccessResponse(getCommandName()); |
| setResponseObject(response); |
| } else { |
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to expunge vm"); |
| } |
| } catch (InvalidParameterValueException ipve) { |
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, ipve.getMessage()); |
| } catch (CloudRuntimeException cre) { |
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, cre.getMessage()); |
| } |
| } |
| } |