opendaylight/networkconfiguration/neutron/northbound/src/main/java/org/opendaylight/controller/networkconfig/neutron/northbound/NeutronSecurityGroupsNorthbound.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   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
  10 package org.opendaylight.controller.networkconfig.neutron.northbound;
  11
  12
  13 import java.util.ArrayList;
  14 import java.util.HashMap;
  15 import java.util.Iterator;
  16 import java.util.List;
  17
  18 import javax.ws.rs.Consumes;
  19 import javax.ws.rs.DELETE;
  20 import javax.ws.rs.GET;
  21 import javax.ws.rs.POST;
  22 import javax.ws.rs.PUT;
  23 import javax.ws.rs.Path;
  24 import javax.ws.rs.PathParam;
  25 import javax.ws.rs.Produces;
  26 import javax.ws.rs.QueryParam;
  27 import javax.ws.rs.core.MediaType;
  28 import javax.ws.rs.core.Response;
  29
  30 import org.codehaus.enunciate.jaxrs.ResponseCode;
  31 import org.codehaus.enunciate.jaxrs.StatusCodes;
  32 import org.opendaylight.controller.networkconfig.neutron.INeutronSecurityGroupAware;
  33 import org.opendaylight.controller.networkconfig.neutron.INeutronSecurityGroupCRUD;
  34 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
  35 import org.opendaylight.controller.networkconfig.neutron.NeutronSecurityGroup;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Neutron Northbound REST APIs for Security Group.<br>
  41  * This class provides REST APIs for managing neutron Security Group
  42  * <p/>
  43  * <br>
  44  * <br>
  45  * Authentication scheme : <b>HTTP Basic</b><br>
  46  * Authentication realm : <b>opendaylight</b><br>
  47  * Transport : <b>HTTP and HTTPS</b><br>
  48  * <br>
  49  * HTTPS Authentication is disabled by default. Administrator can enable it in
  50  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  51  * trusted authority.<br>
  52  * More info :
  53  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  54  */
  55 @Path ("/security-groups")
  56 public class NeutronSecurityGroupsNorthbound {
  57     static final Logger logger = LoggerFactory.getLogger(NeutronSecurityGroupsNorthbound.class);
  58
  59     private NeutronSecurityGroup extractFields(NeutronSecurityGroup o, List<String> fields) {
  60         return o.extractFields(fields);
  61     }
  62
  63     /**
  64      * Returns a list of all Security Groups
  65      */
  66     @GET
  67     @Produces ({MediaType.APPLICATION_JSON})
  68     @StatusCodes ({
  69             @ResponseCode (code = 200, condition = "Operation successful"),
  70             @ResponseCode (code = 401, condition = "Unauthorized"),
  71             @ResponseCode (code = 501, condition = "Not Implemented")})
  72
  73     public Response listGroups(
  74             // return fields
  75             @QueryParam ("fields") List<String> fields,
  76             // OpenStack security group attributes
  77             @QueryParam ("id") String querySecurityGroupUUID,
  78             @QueryParam ("name") String querySecurityGroupName,
  79             @QueryParam ("description") String querySecurityDescription,
  80             @QueryParam ("tenant_id") String querySecurityTenantID,
  81             @QueryParam ("limit") String limit,
  82             @QueryParam ("marker") String marker,
  83             @QueryParam ("page_reverse") String pageReverse
  84     ) {
  85         INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
  86
  87         if (securityGroupInterface == null) {
  88             throw new ServiceUnavailableException("Security Group CRUD Interface "
  89                     + RestMessages.SERVICEUNAVAILABLE.toString());
  90         }
  91         List<NeutronSecurityGroup> allSecurityGroups = securityGroupInterface.getAllNeutronSecurityGroups();
  92         List<NeutronSecurityGroup> ans = new ArrayList<NeutronSecurityGroup>();
  93         Iterator<NeutronSecurityGroup> i = allSecurityGroups.iterator();
  94         while (i.hasNext()) {
  95             NeutronSecurityGroup nsg = i.next();
  96             if ((querySecurityGroupUUID == null ||
  97                     querySecurityGroupUUID.equals(nsg.getSecurityGroupUUID())) &&
  98                     (querySecurityGroupName == null ||
  99                             querySecurityGroupName.equals(nsg.getSecurityGroupName())) &&
 100                     (querySecurityDescription == null ||
 101                             querySecurityDescription.equals(nsg.getSecurityGroupDescription())) &&
 102                     (querySecurityTenantID == null ||
 103                             querySecurityTenantID.equals(nsg.getSecurityGroupTenantID()))) {
 104                 if (fields.size() > 0) {
 105                     ans.add(extractFields(nsg, fields));
 106                 } else {
 107                     ans.add(nsg);
 108                 }
 109             }
 110         }
 111         return Response.status(200).entity(
 112                 new NeutronSecurityGroupRequest(ans)).build();
 113     }
 114
 115     /**
 116      * Returns a specific Security Group
 117      */
 118
 119     @Path ("{securityGroupUUID}")
 120     @GET
 121     @Produces ({MediaType.APPLICATION_JSON})
 122     @StatusCodes ({
 123             @ResponseCode (code = 200, condition = "Operation successful"),
 124             @ResponseCode (code = 401, condition = "Unauthorized"),
 125             @ResponseCode (code = 404, condition = "Not Found"),
 126             @ResponseCode (code = 501, condition = "Not Implemented")})
 127     public Response showSecurityGroup(@PathParam ("securityGroupUUID") String securityGroupUUID,
 128                                       // return fields
 129                                       @QueryParam ("fields") List<String> fields) {
 130         INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
 131         if (securityGroupInterface == null) {
 132             throw new ServiceUnavailableException("Security Group CRUD Interface "
 133                     + RestMessages.SERVICEUNAVAILABLE.toString());
 134         }
 135         if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
 136             throw new ResourceNotFoundException("Security Group UUID does not exist.");
 137         }
 138         if (!fields.isEmpty()) {
 139             NeutronSecurityGroup ans = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
 140             return Response.status(200).entity(
 141                     new NeutronSecurityGroupRequest(extractFields(ans, fields))).build();
 142         } else {
 143             return Response.status(200).entity(new NeutronSecurityGroupRequest(securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID))).build();
 144         }
 145     }
 146
 147     /**
 148      * Creates new Security Group
 149      */
 150
 151     @POST
 152     @Produces ({MediaType.APPLICATION_JSON})
 153     @Consumes ({MediaType.APPLICATION_JSON})
 154     @StatusCodes ({
 155             @ResponseCode (code = 201, condition = "Created"),
 156             @ResponseCode (code = 400, condition = "Bad Request"),
 157             @ResponseCode (code = 401, condition = "Unauthorized"),
 158             @ResponseCode (code = 403, condition = "Forbidden"),
 159             @ResponseCode (code = 404, condition = "Not Found"),
 160             @ResponseCode (code = 409, condition = "Conflict"),
 161             @ResponseCode (code = 501, condition = "Not Implemented")})
 162     public Response createSecurityGroups(final NeutronSecurityGroupRequest input) {
 163         INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
 164         if (securityGroupInterface == null) {
 165             throw new ServiceUnavailableException("Security Group CRUD Interface "
 166                     + RestMessages.SERVICEUNAVAILABLE.toString());
 167         }
 168
 169         if (input.isSingleton()) {
 170             NeutronSecurityGroup singleton = input.getSingleton();
 171
 172             /*
 173              *  Verify that the Security Group doesn't already exist.
 174              */
 175             if (securityGroupInterface.neutronSecurityGroupExists(singleton.getSecurityGroupUUID())) {
 176                 throw new BadRequestException("Security Group UUID already exists");
 177             }
 178
 179             Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
 180             if (instances != null) {
 181                 for (Object instance : instances) {
 182                     INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 183                     int status = service.canCreateNeutronSecurityGroup(singleton);
 184                     if (status < 200 || status > 299) {
 185                         return Response.status(status).build();
 186                     }
 187                 }
 188             }
 189             // Add to Neutron cache
 190             securityGroupInterface.addNeutronSecurityGroup(singleton);
 191             if (instances != null) {
 192                 for (Object instance : instances) {
 193                     INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 194                     service.neutronSecurityGroupCreated(singleton);
 195                 }
 196             }
 197         } else {
 198             List<NeutronSecurityGroup> bulk = input.getBulk();
 199             Iterator<NeutronSecurityGroup> i = bulk.iterator();
 200             HashMap<String, NeutronSecurityGroup> testMap = new HashMap<String, NeutronSecurityGroup>();
 201             Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
 202             while (i.hasNext()) {
 203                 NeutronSecurityGroup test = i.next();
 204
 205                 /*
 206                  *  Verify that the security group doesn't already exist
 207                  */
 208
 209                 if (securityGroupInterface.neutronSecurityGroupExists(test.getSecurityGroupUUID())) {
 210                     throw new BadRequestException("Security Group UUID already is already created");
 211                 }
 212                 if (instances != null) for (Object instance : instances) {
 213                     INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 214                     int status = service.canCreateNeutronSecurityGroup(test);
 215                     if ((status < 200) || (status > 299)) return Response.status(status).build();
 216                 }
 217             }
 218
 219             /*
 220              * now, each element of the bulk request can be added to the cache
 221              */
 222             i = bulk.iterator();
 223             while (i.hasNext()) {
 224                 NeutronSecurityGroup test = i.next();
 225                 securityGroupInterface.addNeutronSecurityGroup(test);
 226                 if (instances != null) {
 227                     for (Object instance : instances) {
 228                         INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 229                         service.neutronSecurityGroupCreated(test);
 230                     }
 231                 }
 232             }
 233         }
 234         return Response.status(201).entity(input).build();
 235     }
 236
 237     /**
 238      * Updates a Security Group
 239      */
 240
 241     @Path ("{securityGroupUUID}")
 242     @PUT
 243     @Produces ({MediaType.APPLICATION_JSON})
 244     @Consumes ({MediaType.APPLICATION_JSON})
 245     @StatusCodes ({
 246             @ResponseCode (code = 200, condition = "Operation successful"),
 247             @ResponseCode (code = 400, condition = "Bad Request"),
 248             @ResponseCode (code = 401, condition = "Unauthorized"),
 249             @ResponseCode (code = 403, condition = "Forbidden"),
 250             @ResponseCode (code = 404, condition = "Not Found"),
 251             @ResponseCode (code = 501, condition = "Not Implemented")})
 252     public Response updateSecurityGroup(
 253             @PathParam ("securityGroupUUID") String securityGroupUUID, final NeutronSecurityGroupRequest input) {
 254         INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
 255         if (securityGroupInterface == null) {
 256             throw new ServiceUnavailableException("Security Group CRUD Interface "
 257                     + RestMessages.SERVICEUNAVAILABLE.toString());
 258         }
 259
 260         /*
 261          * verify the Security Group exists and there is only one delta provided
 262          */
 263         if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
 264             throw new ResourceNotFoundException("Security Group UUID does not exist.");
 265         }
 266         if (!input.isSingleton()) {
 267             throw new BadRequestException("Only singleton edit supported");
 268         }
 269         NeutronSecurityGroup delta = input.getSingleton();
 270         NeutronSecurityGroup original = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
 271
 272         if (delta.getSecurityGroupUUID() != null ||
 273                 delta.getSecurityGroupTenantID() != null ||
 274                 delta.getSecurityGroupName() != null ||
 275                 delta.getSecurityGroupDescription() != null) {
 276             throw new BadRequestException("Attribute edit blocked by Neutron");
 277         }
 278
 279         Object[] instances =  NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
 280         if (instances != null) {
 281             for (Object instance : instances) {
 282                 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 283                 int status = service.canUpdateNeutronSecurityGroup(delta, original);
 284                 if (status < 200 || status > 299) {
 285                     return Response.status(status).build();
 286                 }
 287             }
 288         }
 289
 290         /*
 291          * update the object and return it
 292          */
 293         securityGroupInterface.updateNeutronSecurityGroup(securityGroupUUID, delta);
 294         NeutronSecurityGroup updatedSecurityGroup = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
 295         if (instances != null) {
 296             for (Object instance : instances) {
 297                 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 298                 service.neutronSecurityGroupUpdated(updatedSecurityGroup);
 299             }
 300         }
 301         return Response.status(200).entity(new NeutronSecurityGroupRequest(securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID))).build();
 302     }
 303
 304     /**
 305      * Deletes a Security Group
 306      */
 307
 308     @Path ("{securityGroupUUID}")
 309     @DELETE
 310     @StatusCodes ({
 311             @ResponseCode (code = 204, condition = "No Content"),
 312             @ResponseCode (code = 401, condition = "Unauthorized"),
 313             @ResponseCode (code = 404, condition = "Not Found"),
 314             @ResponseCode (code = 409, condition = "Conflict"),
 315             @ResponseCode (code = 501, condition = "Not Implemented")})
 316     public Response deleteSecurityGroup(
 317             @PathParam ("securityGroupUUID") String securityGroupUUID) {
 318         INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
 319         if (securityGroupInterface == null) {
 320             throw new ServiceUnavailableException("Security Group CRUD Interface "
 321                     + RestMessages.SERVICEUNAVAILABLE.toString());
 322         }
 323
 324         /*
 325          * verify the Security Group exists and it isn't currently in use
 326          */
 327         if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
 328             throw new ResourceNotFoundException("Security Group UUID does not exist.");
 329         }
 330         if (securityGroupInterface.neutronSecurityGroupInUse(securityGroupUUID)) {
 331             return Response.status(409).build();
 332         }
 333         NeutronSecurityGroup singleton = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
 334         Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
 335         if (instances != null) {
 336             for (Object instance : instances) {
 337                 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 338                 int status = service.canDeleteNeutronSecurityGroup(singleton);
 339                 if ((status < 200) || (status > 299)) {
 340                     return Response.status(status).build();
 341                 }
 342             }
 343         }
 344
 345         /*
 346          * remove it and return 204 status
 347          */
 348         securityGroupInterface.removeNeutronSecurityGroup(securityGroupUUID);
 349         if (instances != null) {
 350             for (Object instance : instances) {
 351                 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
 352                 service.neutronSecurityGroupDeleted(singleton);
 353             }
 354         }
 355         return Response.status(204).build();
 356     }
 357 }