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.network.routing;
  
  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.BaseAsyncCustomIdCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.response.FirewallResponse;
  import org.apache.cloudstack.api.response.FirewallRuleResponse;
  import org.apache.cloudstack.context.CallContext;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.network.rules.FirewallRule;
  import com.cloud.user.Account;
  
  @APICommand(name = "updateRoutingFirewallRule",
          description = "Updates Routing firewall rule with specified ID",
          since = "4.20.0",
          responseObject = FirewallRuleResponse.class,
          requestHasSensitiveInfo = false,
          responseHasSensitiveInfo = false,
          authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
  public class UpdateRoutingFirewallRuleCmd extends BaseAsyncCustomIdCmd {
  
  
      // ///////////////////////////////////////////////////
      // ////////////// API parameters /////////////////////
      // ///////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the Routing firewall rule")
      private Long id;
  
      @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the Routing firewall rule to the end user or not",
              authorized = {RoleType.Admin})
      private Boolean display;
  
      // ///////////////////////////////////////////////////
      // ///////////////// Accessors ///////////////////////
      // ///////////////////////////////////////////////////
  
      @Override
      public boolean isDisplay() {
          if (display != null) {
              return display;
          } else {
              return true;
          }
      }
  
      public Long getId() {
          return id;
      }
  
      // ///////////////////////////////////////////////////
      // ///////////// API Implementation///////////////////
      // ///////////////////////////////////////////////////
  
      @Override
      public long getEntityOwnerId() {
          FirewallRule rule = _firewallService.getFirewallRule(id);
          if (rule != null) {
              return rule.getAccountId();
          }
          Account caller = CallContext.current().getCallingAccount();
          return caller.getAccountId();
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_ROUTING_IPV4_FIREWALL_RULE_UPDATE;
      }
  
      @Override
      public String getEventDescription() {
          return "Updating ipv4 routing firewall rule";
      }
  
      @Override
      public void execute() throws ResourceUnavailableException {
          CallContext.current().setEventDetails("Rule Id: " + getId());
          FirewallRule rule = routedIpv4Manager.updateRoutingFirewallRule(this);
          FirewallResponse ruleResponse = _responseGenerator.createFirewallResponse(rule);
          setResponseObject(ruleResponse);
          ruleResponse.setResponseName(getCommandName());
      }
  
      @Override
      public void checkUuid() {
          if (this.getCustomId() != null) {
              _uuidMgr.checkUuid(this.getCustomId(), FirewallRule.class);
          }
      }
  
      @Override
      public Long getApiResourceId() {
          FirewallRule rule = _firewallService.getFirewallRule(id);
          if (rule != null) {
              return rule.getNetworkId();
          }
          return null;
      }
  
      @Override
      public ApiCommandResourceType getApiResourceType() {
          return ApiCommandResourceType.Network;
      }
  }
  