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.NeutronCRUDInterfaces;
  29 import org.opendaylight.neutron.spi.NeutronFirewallRule;
  30
  31 /**
  32  * Neutron Northbound REST APIs for Firewall Rule.<br>
  33  * This class provides REST APIs for managing neutron Firewall Rule
  34  *
  35  * <br>
  36  * <br>
  37  * Authentication scheme : <b>HTTP Basic</b><br>
  38  * Authentication realm : <b>opendaylight</b><br>
  39  * Transport : <b>HTTP and HTTPS</b><br>
  40  * <br>
  41  * HTTPS Authentication is disabled by default. Administrator can enable it in
  42  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  43  * trusted authority.<br>
  44  * More info :
  45  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  46  */
  47
  48 @Path("fw/firewall_rules")
  49 public class NeutronFirewallRulesNorthbound
  50         extends AbstractNeutronNorthbound<NeutronFirewallRule, NeutronFirewallRuleRequest, INeutronFirewallRuleCRUD> {
  51     private static final String RESOURCE_NAME = "Firewall Rule";
  52
  53     @Override
  54     protected String getResourceName() {
  55         return RESOURCE_NAME;
  56     }
  57
  58     @Override
  59     protected NeutronFirewallRuleRequest newNeutronRequest(NeutronFirewallRule o) {
  60         return new NeutronFirewallRuleRequest(o);
  61     }
  62
  63     @Override
  64     protected INeutronFirewallRuleCRUD getNeutronCRUD() {
  65         NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronFirewallRuleCRUD(this);
  66         if (answer.getFirewallRuleInterface() == null) {
  67             throw new ServiceUnavailableException(serviceUnavailable());
  68         }
  69         return answer.getFirewallRuleInterface();
  70     }
  71
  72     /**
  73      * Returns a list of all Firewall Rules
  74      */
  75     @GET
  76     @Produces({ MediaType.APPLICATION_JSON })
  77     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  78             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  79             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  80             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  81     public Response listRules(
  82             // return fields
  83             @QueryParam("fields") List<String> fields,
  84             // OpenStack firewall rule attributes
  85             @QueryParam("id") String queryFirewallRuleUUID,
  86             @QueryParam("tenant_id") String queryFirewallRuleTenantID,
  87             @QueryParam("name") String queryFirewallRuleName,
  88             @QueryParam("shared") Boolean queryFirewallRuleIsShared,
  89             @QueryParam("firewall_policy_id") String queryFirewallRulePolicyID,
  90             @QueryParam("protocol") String queryFirewallRuleProtocol,
  91             @QueryParam("ip_version") Integer queryFirewallRuleIpVer,
  92             @QueryParam("source_ip_address") String queryFirewallRuleSrcIpAddr,
  93             @QueryParam("destination_ip_address") String queryFirewallRuleDstIpAddr,
  94             @QueryParam("source_port_range_min") Integer queryFirewallRuleSrcPortRangeMin,
  95             @QueryParam("source_port_range_max") Integer queryFirewallRuleSrcPortRangeMax,
  96             @QueryParam("destination_port_range_min") Integer queryFirewallRuleDstPortRangeMin,
  97             @QueryParam("destination_port_range_max") Integer queryFirewallRuleDstPortRangeMax,
  98             @QueryParam("position") Integer queryFirewallRulePosition,
  99             @QueryParam("action") String queryFirewallRuleAction,
 100             @QueryParam("enabled") Boolean queryFirewallRuleIsEnabled,
 101             // pagination
 102             @QueryParam("limit") String limit,
 103             @QueryParam("marker") String marker,
 104             @QueryParam("page_reverse") String pageReverse
 105     // sorting not supported
 106     ) {
 107         INeutronFirewallRuleCRUD firewallRuleInterface = getNeutronCRUD();
 108         List<NeutronFirewallRule> ans = new ArrayList<>();
 109         for (NeutronFirewallRule nsr : firewallRuleInterface.getAll()) {
 110             if ((queryFirewallRuleUUID == null || queryFirewallRuleUUID.equals(nsr.getID()))
 111                     && (queryFirewallRuleTenantID == null || queryFirewallRuleTenantID.equals(nsr.getTenantID()))
 112                     && (queryFirewallRuleName == null || queryFirewallRuleName.equals(nsr.getFirewallRuleName()))
 113                     && (queryFirewallRuleIsShared == null
 114                             || queryFirewallRuleIsShared.equals(nsr.getFirewallRuleIsShared()))
 115                     && (queryFirewallRulePolicyID == null
 116                             || queryFirewallRulePolicyID.equals(nsr.getFirewallRulePolicyID()))
 117                     && (queryFirewallRuleProtocol == null
 118                             || queryFirewallRuleProtocol.equals(nsr.getFirewallRuleProtocol()))
 119                     && (queryFirewallRuleIpVer == null || queryFirewallRuleIpVer.equals(nsr.getFirewallRuleIpVer()))
 120                     && (queryFirewallRuleSrcIpAddr == null
 121                             || queryFirewallRuleSrcIpAddr.equals(nsr.getFirewallRuleSrcIpAddr()))
 122                     && (queryFirewallRuleDstIpAddr == null
 123                             || queryFirewallRuleDstIpAddr.equals(nsr.getFirewallRuleDstIpAddr()))
 124                     && (queryFirewallRuleSrcPortRangeMin == null
 125                             || queryFirewallRuleSrcPortRangeMin.equals(nsr.getFirewallRuleSrcPortRangeMin()))
 126                     && (queryFirewallRuleSrcPortRangeMax == null
 127                             || queryFirewallRuleSrcPortRangeMax.equals(nsr.getFirewallRuleSrcPortRangeMax()))
 128                     && (queryFirewallRuleDstPortRangeMin == null
 129                             || queryFirewallRuleDstPortRangeMin.equals(nsr.getFirewallRuleDstPortRangeMin()))
 130                     && (queryFirewallRuleDstPortRangeMax == null
 131                             || queryFirewallRuleDstPortRangeMax.equals(nsr.getFirewallRuleDstPortRangeMax()))
 132                     && (queryFirewallRulePosition == null
 133                             || queryFirewallRulePosition.equals(nsr.getFirewallRulePosition()))
 134                     && (queryFirewallRuleAction == null || queryFirewallRuleAction.equals(nsr.getFirewallRuleAction()))
 135                     && (queryFirewallRuleIsEnabled == null
 136                             || queryFirewallRuleIsEnabled.equals(nsr.getFirewallRuleIsEnabled()))) {
 137                 if (fields.size() > 0) {
 138                     ans.add(nsr.extractFields(fields));
 139                 } else {
 140                     ans.add(nsr);
 141                 }
 142             }
 143         }
 144         //TODO: apply pagination to results
 145         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronFirewallRuleRequest(ans)).build();
 146     }
 147
 148     /**
 149      * Returns a specific Firewall Rule
 150      */
 151
 152     @Path("{firewallRuleUUID}")
 153     @GET
 154     @Produces({ MediaType.APPLICATION_JSON })
 155     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 156             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 157             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 158             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 159             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 160     public Response showFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID,
 161             // return fields
 162             @QueryParam("fields") List<String> fields) {
 163         return show(firewallRuleUUID, fields);
 164     }
 165
 166     /**
 167      * Creates new Firewall Rule
 168      */
 169
 170     @POST
 171     @Produces({ MediaType.APPLICATION_JSON })
 172     @Consumes({ MediaType.APPLICATION_JSON })
 173     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 174             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 175     public Response createFirewallRules(final NeutronFirewallRuleRequest input) {
 176         return create(input);
 177     }
 178
 179     /**
 180      * Updates a Firewall Rule
 181      */
 182     @Path("{firewallRuleUUID}")
 183     @PUT
 184     @Produces({ MediaType.APPLICATION_JSON })
 185     @Consumes({ MediaType.APPLICATION_JSON })
 186     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 187             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 188             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 189     public Response updateFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID,
 190             final NeutronFirewallRuleRequest input) {
 191         return update(firewallRuleUUID, input);
 192     }
 193
 194     /**
 195      * Deletes a Firewall Rule
 196      */
 197
 198     @Path("{firewallRuleUUID}")
 199     @DELETE
 200     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 201             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 202             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 203     public Response deleteFirewallRule(@PathParam("firewallRuleUUID") String firewallRuleUUID) {
 204         return delete(firewallRuleUUID);
 205     }
 206 }