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.address;
  
  
  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.BaseCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.IPAddressResponse;
  import org.apache.cloudstack.api.response.SuccessResponse;
  import org.apache.cloudstack.context.CallContext;
  
  import com.cloud.exception.InsufficientAddressCapacityException;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.network.IpAddress;
  
  @APICommand(name = "releaseIpAddress",
          description = "Releases an IP address from the account.",
          since = "4.17",
          responseObject = SuccessResponse.class,
          requestHasSensitiveInfo = false,
          responseHasSensitiveInfo = false,
          authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
  public class ReleaseIPAddrCmd extends BaseCmd {
  
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "the ID of the public IP address"
          + " to release")
      private Long id;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getIpAddressId() {
          return id;
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public long getEntityOwnerId() {
          IpAddress ip = getIpAddress(id);
          if (ip == null) {
              throw new InvalidParameterValueException("Unable to find IP address by ID=" + id);
          }
          return ip.getAccountId();
      }
  
      @Override
      public void execute() throws InsufficientAddressCapacityException {
          CallContext.current().setEventDetails("IP ID: " + getIpAddressId());
          boolean result = _networkService.releaseReservedIpAddress(getIpAddressId());
          if (result) {
              SuccessResponse response = new SuccessResponse(getCommandName());
              this.setResponseObject(response);
          } else {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to release IP address");
          }
      }
  
      private IpAddress getIpAddress(long id) {
          IpAddress ip = _entityMgr.findById(IpAddress.class, id);
  
          if (ip == null) {
              throw new InvalidParameterValueException("Unable to find IP address by ID=" + id);
          } else {
              return ip;
          }
      }
  
  }
  