northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronFirewallRulesNorthbound.java

   1 /*
   2  * Copyright (c) 2014, 2015 Red Hat, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.neutron.northbound.api;
  10
  11 import java.net.HttpURLConnection;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import javax.ws.rs.Consumes;
  15 import javax.ws.rs.DELETE;
  16 import javax.ws.rs.GET;
  17 import javax.ws.rs.POST;
  18 import javax.ws.rs.PUT;
  19 import javax.ws.rs.Path;
  20 import javax.ws.rs.PathParam;
  21 import javax.ws.rs.Produces;
  22 import javax.ws.rs.QueryParam;
  23 import javax.ws.rs.core.MediaType;
  24 import javax.ws.rs.core.Response;
  25 import org.codehaus.enunciate.jaxrs.ResponseCode;
  26 import org.codehaus.enunciate.jaxrs.StatusCodes;
  27 import org.opendaylight.neutron.spi.INeutronFirewallRuleCRUD;
  28 import org.opendaylight.neutron.spi.NeutronFirewallRule;
  29
  30 /**
  31  * Neutron Northbound REST APIs for Firewall Rule.<br>
  32  * This class provides REST APIs for managing neutron Firewall Rule
  33  *
  34  * <br>
  35  * <br>
  36  * Authentication scheme : <b>HTTP Basic</b><br>
  37  * Authentication realm : <b>opendaylight</b><br>
  38  * Transport : <b>HTTP and HTTPS</b><br>
  39  * <br>
  40  * HTTPS Authentication is disabled by default. Administrator can enable it in
  41  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  42  * trusted authority.<br>
  43  * More info :
  44  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  45  */
  46
  47 @Path("fw/firewall_rules")
  48 public final class NeutronFirewallRulesNorthbound
  49         extends AbstractNeutronNorthbound<NeutronFirewallRule, NeutronFirewallRuleRequest, INeutronFirewallRuleCRUD> {
  50     private static final String RESOURCE_NAME = "Firewall Rule";
  51
  52     @Override
  53     protected String getResourceName() {
  54         return RESOURCE_NAME;
  55     }
  56
  57     /**
  58      * Returns a list of all Firewall Rules.
  59      */
  60     @GET
  61     @Produces({ MediaType.APPLICATION_JSON })
  62     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  63             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  64             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  65             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  66     public Response listRules(
  67             // return fields
  68             @QueryParam("fields") List<String> fields,
  69             // OpenStack firewall rule attributes
  70             @QueryParam("id") String queryFirewallRuleUUID,
  71             @QueryParam("tenant_id") String queryFirewallRuleTenantID,
  72             @QueryParam("name") String queryFirewallRuleName,
  73             @QueryParam("shared") Boolean queryFirewallRuleIsShared,
  74             @QueryParam("firewall_policy_id") String queryFirewallRulePolicyID,
  75             @QueryParam("protocol") String queryFirewallRuleProtocol,
  76             @QueryParam("ip_version") Integer queryFirewallRuleIpVer,
  77             @QueryParam("source_ip_address") String queryFirewallRuleSrcIpAddr,
  78             @QueryParam("destination_ip_address") String queryFirewallRuleDstIpAddr,
  79             @QueryParam("source_port_range_min") Integer queryFirewallRuleSrcPortRangeMin,
  80             @QueryParam("source_port_range_max") Integer queryFirewallRuleSrcPortRangeMax,
  81             @QueryParam("destination_port_range_min") Integer queryFirewallRuleDstPortRangeMin,
  82             @QueryParam("destination_port_range_max") Integer queryFirewallRuleDstPortRangeMax,
  83             @QueryParam("position") Integer queryFirewallRulePosition,
  84             @QueryParam("action") String queryFirewallRuleAction,
  85             @QueryParam("enabled") Boolean queryFirewallRuleIsEnabled,
  86             // pagination
  87             @QueryParam("limit") String limit,
  88             @QueryParam("marker") String marker,
  89             @QueryParam("page_reverse") String pageReverse
  90     // sorting not supported
  91     ) {
  92         INeutronFirewallRuleCRUD firewallRuleInterface = getNeutronCRUD();
  93         List<NeutronFirewallRule> ans = new ArrayList<>();
  94         for (NeutronFirewallRule nsr : firewallRuleInterface.getAll()) {
  95             if ((queryFirewallRuleUUID == null || queryFirewallRuleUUID.equals(nsr.getID()))
  96                     && (queryFirewallRuleTenantID == null || queryFirewallRuleTenantID.equals(nsr.getTenantID()))
  97                     && (queryFirewallRuleName == null || queryFirewallRuleName.equals(nsr.getName()))
  98                     && (queryFirewallRuleIsShared == null
  99                             || queryFirewallRuleIsShared.equals(nsr.getFirewallRuleIsShared()))
 100                     && (queryFirewallRulePolicyID == null
 101                             || queryFirewallRulePolicyID.equals(nsr.getFirewallRulePolicyID()))
 102                     && (queryFirewallRuleProtocol == null
 103                             || queryFirewallRuleProtocol.equals(nsr.getFirewallRuleProtocol()))
 104                     && (queryFirewallRuleIpVer == null || queryFirewallRuleIpVer.equals(nsr.getFirewallRuleIpVer()))
 105                     && (queryFirewallRuleSrcIpAddr == null
 106                             || queryFirewallRuleSrcIpAddr.equals(nsr.getFirewallRuleSrcIpAddr()))
 107                     && (queryFirewallRuleDstIpAddr == null
 108                             || queryFirewallRuleDstIpAddr.equals(nsr.getFirewallRuleDstIpAddr()))
 109                     && (queryFirewallRuleSrcPortRangeMin == null
 110                             || queryFirewallRuleSrcPortRangeMin.equals(nsr.getFirewallRuleSrcPortRangeMin()))
 111                     && (queryFirewallRuleSrcPortRangeMax == null
 112                             || queryFirewallRuleSrcPortRangeMax.equals(nsr.getFirewallRuleSrcPortRangeMax()))
 113                     && (queryFirewallRuleDstPortRangeMin == null
 114                             || queryFirewallRuleDstPortRangeMin.equals(nsr.getFirewallRuleDstPortRangeMin()))
 115                     && (queryFirewallRuleDstPortRangeMax == null
 116                             || queryFirewallRuleDstPortRangeMax.equals(nsr.getFirewallRuleDstPortRangeMax()))
 117                     && (queryFirewallRulePosition == null
 118                             || queryFirewallRulePosition.equals(nsr.getFirewallRulePosition()))
 119                     && (queryFirewallRuleAction == null || queryFirewallRuleAction.equals(nsr.getFirewallRuleAction()))
 120                     && (queryFirewallRuleIsEnabled == null
 121                             || queryFirewallRuleIsEnabled.equals(nsr.getFirewallRuleIsEnabled()))) {
 122                 if (fields.size() > 0) {
 123                     ans.add(nsr.extractFields(fields));
 124                 } else {
 125                     ans.add(nsr);
 126                 }
 127             }
 128         }
 129         //TODO: apply pagination to results
 130         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronFirewallRuleRequest(ans)).build();
 131     }
 132
 133     /**
 134      * Returns a specific Firewall Rule.
 135      */
 136
 137     @Path("{firewallRuleUUID}")
 138     @GET
 139     @Produces({ MediaType.APPLICATION_JSON })
 140     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 141             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 142             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 143             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 144             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 145     public Response showFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID,
 146             // return fields
 147             @QueryParam("fields") List<String> fields) {
 148         return show(firewallRuleUUID, fields);
 149     }
 150
 151     /**
 152      * Creates new Firewall Rule.
 153      */
 154
 155     @POST
 156     @Produces({ MediaType.APPLICATION_JSON })
 157     @Consumes({ MediaType.APPLICATION_JSON })
 158     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 159             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 160     public Response createFirewallRules(final NeutronFirewallRuleRequest input) {
 161         return create(input);
 162     }
 163
 164     /**
 165      * Updates a Firewall Rule.
 166      */
 167     @Path("{firewallRuleUUID}")
 168     @PUT
 169     @Produces({ MediaType.APPLICATION_JSON })
 170     @Consumes({ MediaType.APPLICATION_JSON })
 171     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 172             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 173             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 174     public Response updateFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID,
 175             final NeutronFirewallRuleRequest input) {
 176         return update(firewallRuleUUID, input);
 177     }
 178
 179     /**
 180      * Deletes a Firewall Rule.
 181      */
 182
 183     @Path("{firewallRuleUUID}")
 184     @DELETE
 185     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 186             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 187             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 188     public Response deleteFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID) {
 189         return delete(firewallRuleUUID);
 190     }
 191 }