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 java.util.ArrayList;
  import java.util.List;
  
  
  import org.apache.cloudstack.acl.RoleType;
  import org.apache.cloudstack.api.APICommand;
  import org.apache.cloudstack.api.ApiConstants;
  import org.apache.cloudstack.api.BaseListTaggedResourcesCmd;
  import org.apache.cloudstack.api.Parameter;
  import org.apache.cloudstack.api.response.FirewallResponse;
  import org.apache.cloudstack.api.response.FirewallRuleResponse;
  import org.apache.cloudstack.api.response.IPAddressResponse;
  import org.apache.cloudstack.api.response.ListResponse;
  import org.apache.cloudstack.api.response.NetworkResponse;
  
  import com.cloud.network.rules.FirewallRule;
  import com.cloud.utils.Pair;
  
  @APICommand(name = "listEgressFirewallRules", description = "Lists all egress firewall rules for network ID.", responseObject = FirewallResponse.class, entityType = {FirewallRule.class},
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class ListEgressFirewallRulesCmd extends BaseListTaggedResourcesCmd implements IListFirewallRulesCmd {
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
      @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "Lists rule with the specified ID.")
      private Long id;
  
      @Parameter(name = ApiConstants.NETWORK_ID,
                 type = CommandType.UUID,
                 entityType = NetworkResponse.class,
                 description = "the network ID for the egress firewall services")
      private Long networkId;
  
      @Parameter(name = ApiConstants.IP_ADDRESS_ID,
                 type = CommandType.UUID,
                 entityType = IPAddressResponse.class,
                 description = "the ID of IP address of the firewall services")
      private Long ipAddressId;
  
      @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
      private Boolean display;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getIpAddressId() {
          return ipAddressId;
      }
  
      public Long getNetworkId() {
          return networkId;
      }
  
      public FirewallRule.TrafficType getTrafficType() {
          return FirewallRule.TrafficType.Egress;
      }
  
      public Long getId() {
          return id;
      }
  
      @Override
      public Boolean getDisplay() {
          if (display != null) {
              return display;
          }
          return super.getDisplay();
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public void execute() {
          Pair<List<? extends FirewallRule>, Integer> result = _firewallService.listFirewallRules(this);
          ListResponse<FirewallResponse> response = new ListResponse<FirewallResponse>();
          List<FirewallResponse> fwResponses = new ArrayList<FirewallResponse>();
  
          if (result != null) {
              for (FirewallRule fwRule : result.first()) {
                  FirewallResponse ruleData = _responseGenerator.createFirewallResponse(fwRule);
                  ruleData.setObjectName("firewallrule");
                  fwResponses.add(ruleData);
              }
              response.setResponses(fwResponses, result.second());
          }
          response.setResponseName(getCommandName());
          setResponseObject(response);
      }
  }
  