northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityGroupsNorthbound.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.INeutronSecurityGroupCRUD;
  28 import org.opendaylight.neutron.spi.NeutronSecurityGroup;
  29
  30 /**
  31  * Neutron Northbound REST APIs for Security Group.<br>
  32  * This class provides REST APIs for managing neutron Security Group
  33  *
  34  * <p>
  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 @Path("/security-groups")
  48 public final class NeutronSecurityGroupsNorthbound extends
  49         AbstractNeutronNorthbound<NeutronSecurityGroup, NeutronSecurityGroupRequest, INeutronSecurityGroupCRUD> {
  50     private static final String RESOURCE_NAME = "Security Group";
  51
  52     @Override
  53     protected String getResourceName() {
  54         return RESOURCE_NAME;
  55     }
  56
  57     /**
  58      * Returns a list of all Security Groups.
  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
  67     public Response listGroups(
  68             // return fields
  69             @QueryParam("fields") List<String> fields,
  70             // OpenStack security group attributes
  71             @QueryParam("id") String querySecurityGroupUUID,
  72             @QueryParam("name") String querySecurityGroupName,
  73             @QueryParam("tenant_id") String querySecurityTenantID,
  74             @QueryParam("limit") String limit,
  75             @QueryParam("marker") String marker,
  76             @QueryParam("page_reverse") String pageReverse) {
  77         INeutronSecurityGroupCRUD securityGroupInterface = getNeutronCRUD();
  78         List<NeutronSecurityGroup> allSecurityGroups = securityGroupInterface.getAll();
  79         List<NeutronSecurityGroup> ans = new ArrayList<>();
  80         for (NeutronSecurityGroup nsg : allSecurityGroups) {
  81             if ((querySecurityGroupUUID == null || querySecurityGroupUUID.equals(nsg.getID()))
  82                     && (querySecurityGroupName == null || querySecurityGroupName.equals(nsg.getName()))
  83                     && (querySecurityTenantID == null || querySecurityTenantID.equals(nsg.getTenantID()))) {
  84                 if (fields.size() > 0) {
  85                     ans.add(nsg.extractFields(fields));
  86                 } else {
  87                     ans.add(nsg);
  88                 }
  89             }
  90         }
  91         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronSecurityGroupRequest(ans)).build();
  92     }
  93
  94     /**
  95      * Returns a specific Security Group.
  96      */
  97
  98     @Path("{securityGroupUUID}")
  99     @GET
 100     @Produces({ MediaType.APPLICATION_JSON })
 101     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 102             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 103             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 104             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 105             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 106     public Response showSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID,
 107             // return fields
 108             @QueryParam("fields") List<String> fields) {
 109         return show(securityGroupUUID, fields);
 110     }
 111
 112     /**
 113      * Creates new Security Group.
 114      */
 115
 116     @POST
 117     @Produces({ MediaType.APPLICATION_JSON })
 118     @Consumes({ MediaType.APPLICATION_JSON })
 119     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 120             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 121     public Response createSecurityGroups(final NeutronSecurityGroupRequest input) {
 122         return create(input);
 123     }
 124
 125     /**
 126      * Updates a Security Group.
 127      */
 128
 129     @Path("{securityGroupUUID}")
 130     @PUT
 131     @Produces({ MediaType.APPLICATION_JSON })
 132     @Consumes({ MediaType.APPLICATION_JSON })
 133     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 134             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 135             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 136     public Response updateSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID,
 137             final NeutronSecurityGroupRequest input) {
 138         return update(securityGroupUUID, input);
 139     }
 140
 141     /**
 142      * Deletes a Security Group.
 143      */
 144
 145     @Path("{securityGroupUUID}")
 146     @DELETE
 147     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 148             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 149             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 150     public Response deleteSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID) {
 151         return delete(securityGroupUUID);
 152     }
 153 }