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.api.ApiCommandResourceType;
  
  import org.apache.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.BaseAsyncCustomIdCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.ResponseObject.ResponseView;
  import org.apache.cloudstack.api.ServerApiException;
  import org.apache.cloudstack.api.response.AccountResponse;
  import org.apache.cloudstack.api.response.IPAddressResponse;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.ConcurrentOperationException;
  import com.cloud.exception.InsufficientCapacityException;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.NetworkRuleConflictException;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.network.IpAddress;
  import com.cloud.user.Account;
  
  @APICommand(name = "updateIpAddress", description = "Updates an IP address", responseObject = IPAddressResponse.class,
   requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, entityType = { IpAddress.class })
  public class UpdateIPAddrCmd extends BaseAsyncCustomIdCmd {
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "the ID of the public IP address"
              + " to update")
      private Long id;
      // unexposed parameter needed for events logging
      @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, expose = false)
      private Long ownerId;
  
      @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the IP to the end user or not", since = "4.4", authorized = {RoleType.Admin})
      private Boolean display;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
      public Long getId() {
          return id;
      }
  
      public Boolean getDisplayIp() {
          return display;
      }
  
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
      @Override
      public String getEventType() {
          return EventTypes.EVENT_NET_IP_UPDATE;
      }
  
      @Override
      public String getEventDescription() {
          return ("Updating IP address with ID=" + id);
      }
  
  
      @Override
      public long getEntityOwnerId() {
          if (ownerId == null) {
              IpAddress ip = getIpAddress(id);
              if (ip == null) {
                  throw new InvalidParameterValueException("Unable to find IP address by ID=" + id);
              }
              ownerId = ip.getAccountId();
          }
  
          if (ownerId == null) {
              return Account.ACCOUNT_ID_SYSTEM;
          }
          return ownerId;
      }
  
      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;
          }
      }
  
      @Override
      public void checkUuid() {
          if (getCustomId() != null) {
              _uuidMgr.checkUuid(getCustomId(), IpAddress.class);
          }
      }
  
      @Override
      public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException,
              NetworkRuleConflictException {
  
          IpAddress result = _networkService.updateIP(getId(), getCustomId(), getDisplayIp());
          if(result != null) {
              IPAddressResponse ipResponse = _responseGenerator.createIPAddressResponse(ResponseView.Restricted, result);
              ipResponse.setResponseName(getCommandName());
              setResponseObject(ipResponse);
          }
      }
  
      @Override
      public Long getApiResourceId() {
          return getId();
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
          return ApiCommandResourceType.IpAddress;
      }
  }
  