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.firewall;
  
  package org.apache.cloudstack.api.command.user.firewall;
  
  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.response.AccountResponse;
  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.InvalidParameterValueException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.network.rules.FirewallRule;
  import com.cloud.network.rules.FirewallRule.TrafficType;
  
  @APICommand(name = "updateFirewallRule", description = "Updates firewall rule ", responseObject = FirewallResponse.class, since = "4.4",
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class UpdateFirewallRuleCmd extends BaseAsyncCustomIdCmd {
  
  
      // ///////////////////////////////////////////////////
      // ////////////// API parameters /////////////////////
      // ///////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the firewall rule")
      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 rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
      private Boolean display;
  
      // ///////////////////////////////////////////////////
      // ///////////////// Accessors ///////////////////////
      // ///////////////////////////////////////////////////
  
      public Long getId() {
          return id;
      }
  
      public Boolean getDisplay() {
          return display;
      }
  
      // ///////////////////////////////////////////////////
      // ///////////// API Implementation///////////////////
      // ///////////////////////////////////////////////////
  
      @Override
      public void execute() throws ResourceUnavailableException {
          CallContext.current().setEventDetails("Rule ID: " + id);
          FirewallRule rule = _firewallService.updateIngressFirewallRule(id, this.getCustomId(), getDisplay());
  
          FirewallResponse fwResponse = new FirewallResponse();
          if (rule != null) {
              fwResponse = _responseGenerator.createFirewallResponse(rule);
              setResponseObject(fwResponse);
          }
          fwResponse.setResponseName(getCommandName());
      }
  
      @Override
      public void checkUuid() {
          if (this.getCustomId() != null) {
              _uuidMgr.checkUuid(this.getCustomId(), FirewallRule.class);
          }
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_FIREWALL_UPDATE;
  
      }
  
      @Override
      public String getEventDescription() {
          return ("Updating firewall rule id=" + id);
  
      }
  
      @Override
      public long getEntityOwnerId() {
          if (ownerId == null) {
              FirewallRule rule = _entityMgr.findById(FirewallRule.class, id);
              if (rule == null || rule.getTrafficType() != TrafficType.Ingress) {
                  throw new InvalidParameterValueException("Unable to find firewall rule by ID");
              } else {
                  ownerId = _entityMgr.findById(FirewallRule.class, id).getAccountId();
              }
          }
          return ownerId;
      }
  }
  