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.Iterator;
  14 import java.util.List;
  15 import javax.ws.rs.Consumes;
  16 import javax.ws.rs.DELETE;
  17 import javax.ws.rs.GET;
  18 import javax.ws.rs.POST;
  19 import javax.ws.rs.PUT;
  20 import javax.ws.rs.Path;
  21 import javax.ws.rs.PathParam;
  22 import javax.ws.rs.Produces;
  23 import javax.ws.rs.QueryParam;
  24 import javax.ws.rs.core.MediaType;
  25 import javax.ws.rs.core.Response;
  26 import org.codehaus.enunciate.jaxrs.ResponseCode;
  27 import org.codehaus.enunciate.jaxrs.StatusCodes;
  28 import org.opendaylight.neutron.spi.INeutronSecurityGroupCRUD;
  29 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
  30 import org.opendaylight.neutron.spi.NeutronSecurityGroup;
  31
  32 /**
  33  * Neutron Northbound REST APIs for Security Group.<br>
  34  * This class provides REST APIs for managing neutron Security Group
  35  * <p>
  36  * <br>
  37  * <br>
  38  * Authentication scheme : <b>HTTP Basic</b><br>
  39  * Authentication realm : <b>opendaylight</b><br>
  40  * Transport : <b>HTTP and HTTPS</b><br>
  41  * <br>
  42  * HTTPS Authentication is disabled by default. Administrator can enable it in
  43  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  44  * trusted authority.<br>
  45  * More info :
  46  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  47  */
  48 @Path("/security-groups")
  49 public class NeutronSecurityGroupsNorthbound extends
  50         AbstractNeutronNorthbound<NeutronSecurityGroup, NeutronSecurityGroupRequest, INeutronSecurityGroupCRUD> {
  51     private static final String RESOURCE_NAME = "Security Group";
  52
  53     @Override
  54     protected String getResourceName() {
  55         return RESOURCE_NAME;
  56     }
  57
  58     @Override
  59     protected NeutronSecurityGroupRequest newNeutronRequest(NeutronSecurityGroup o) {
  60         return new NeutronSecurityGroupRequest(o);
  61     }
  62
  63     @Override
  64     protected INeutronSecurityGroupCRUD getNeutronCRUD() {
  65         NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronSecurityGroupCRUD(this);
  66         if (answer.getSecurityGroupInterface() == null) {
  67             throw new ServiceUnavailableException(serviceUnavailable());
  68         }
  69         return answer.getSecurityGroupInterface();
  70     }
  71
  72     /**
  73      * Returns a list of all Security Groups
  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
  82     public Response listGroups(
  83             // return fields
  84             @QueryParam("fields") List<String> fields,
  85             // OpenStack security group attributes
  86             @QueryParam("id") String querySecurityGroupUUID,
  87             @QueryParam("name") String querySecurityGroupName,
  88             @QueryParam("tenant_id") String querySecurityTenantID,
  89             @QueryParam("limit") String limit,
  90             @QueryParam("marker") String marker,
  91             @QueryParam("page_reverse") String pageReverse) {
  92         INeutronSecurityGroupCRUD securityGroupInterface = getNeutronCRUD();
  93         List<NeutronSecurityGroup> allSecurityGroups = securityGroupInterface.getAll();
  94         List<NeutronSecurityGroup> ans = new ArrayList<>();
  95         Iterator<NeutronSecurityGroup> i = allSecurityGroups.iterator();
  96         while (i.hasNext()) {
  97             NeutronSecurityGroup nsg = i.next();
  98             if ((querySecurityGroupUUID == null || querySecurityGroupUUID.equals(nsg.getID()))
  99                     && (querySecurityGroupName == null || querySecurityGroupName.equals(nsg.getSecurityGroupName()))
 100                     && (querySecurityTenantID == null || querySecurityTenantID.equals(nsg.getTenantID()))) {
 101                 if (fields.size() > 0) {
 102                     ans.add(nsg.extractFields(fields));
 103                 } else {
 104                     ans.add(nsg);
 105                 }
 106             }
 107         }
 108         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronSecurityGroupRequest(ans)).build();
 109     }
 110
 111     /**
 112      * Returns a specific Security Group
 113      */
 114
 115     @Path("{securityGroupUUID}")
 116     @GET
 117     @Produces({ MediaType.APPLICATION_JSON })
 118     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 119             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 120             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 121             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 122             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 123     public Response showSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID,
 124             // return fields
 125             @QueryParam("fields") List<String> fields) {
 126         return show(securityGroupUUID, fields);
 127     }
 128
 129     /**
 130      * Creates new Security Group
 131      */
 132
 133     @POST
 134     @Produces({ MediaType.APPLICATION_JSON })
 135     @Consumes({ MediaType.APPLICATION_JSON })
 136     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 137             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 138     public Response createSecurityGroups(final NeutronSecurityGroupRequest input) {
 139         return create(input);
 140     }
 141
 142     /**
 143      * Updates a Security Group
 144      */
 145
 146     @Path("{securityGroupUUID}")
 147     @PUT
 148     @Produces({ MediaType.APPLICATION_JSON })
 149     @Consumes({ MediaType.APPLICATION_JSON })
 150     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 151             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 152             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 153     public Response updateSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID,
 154             final NeutronSecurityGroupRequest input) {
 155         return update(securityGroupUUID, input);
 156     }
 157
 158     /**
 159      * Deletes a Security Group
 160      */
 161
 162     @Path("{securityGroupUUID}")
 163     @DELETE
 164     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 165             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 166             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 167     public Response deleteSecurityGroup(@PathParam("securityGroupUUID") String securityGroupUUID) {
 168         return delete(securityGroupUUID);
 169     }
 170 }