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