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

   1 /*
   2  * Copyright (C) 2014 SDN Hub, LLC.
   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  * Authors : Srini Seetharaman
   9  */
  10
  11 package org.opendaylight.controller.networkconfig.neutron.northbound;
  12
  13
  14 import org.codehaus.enunciate.jaxrs.ResponseCode;
  15 import org.codehaus.enunciate.jaxrs.StatusCodes;
  16 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolAware;
  17 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolCRUD;
  18 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolMemberCRUD;
  19 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
  20 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPool;
  21 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPoolMember;
  22 import org.opendaylight.controller.northbound.commons.RestMessages;
  23 import org.opendaylight.controller.northbound.commons.exception.BadRequestException;
  24 import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
  25 import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException;
  26 import org.opendaylight.controller.sal.utils.ServiceHelper;
  27
  28 import javax.ws.rs.Consumes;
  29 import javax.ws.rs.DELETE;
  30 import javax.ws.rs.GET;
  31 import javax.ws.rs.POST;
  32 import javax.ws.rs.PUT;
  33 import javax.ws.rs.Path;
  34 import javax.ws.rs.PathParam;
  35 import javax.ws.rs.Produces;
  36 import javax.ws.rs.QueryParam;
  37 import javax.ws.rs.core.MediaType;
  38 import javax.ws.rs.core.Response;
  39
  40 import java.util.ArrayList;
  41 import java.util.HashMap;
  42 import java.util.Iterator;
  43 import java.util.List;
  44
  45 /**
  46  * Neutron Northbound REST APIs for LoadBalancerPool Policies.<br>
  47  * This class provides REST APIs for managing neutron LoadBalancerPool Policies
  48  *
  49  * <br>
  50  * <br>
  51  * Authentication scheme : <b>HTTP Basic</b><br>
  52  * Authentication realm : <b>opendaylight</b><br>
  53  * Transport : <b>HTTP and HTTPS</b><br>
  54  * <br>
  55  * HTTPS Authentication is disabled by default. Administrator can enable it in
  56  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  57  * trusted authority.<br>
  58  * More info :
  59  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  60  *
  61  */
  62
  63 /**
  64  * For now, the LB pool member data is maintained with the INeutronLoadBalancerPoolCRUD,
  65  * although there may be an overlap with INeutronLoadBalancerPoolMemberCRUD's cache.
  66  * TODO: Consolidate and maintain a single copy
  67  */
  68
  69 @Path("/pools")
  70 public class NeutronLoadBalancerPoolNorthbound {
  71
  72     private NeutronLoadBalancerPool extractFields(NeutronLoadBalancerPool o, List<String> fields) {
  73         return o.extractFields(fields);
  74     }
  75
  76     /**
  77      * Returns a list of all LoadBalancerPool
  78      * */
  79     @GET
  80     @Produces({ MediaType.APPLICATION_JSON })
  81     @StatusCodes({
  82             @ResponseCode(code = 200, condition = "Operation successful"),
  83             @ResponseCode(code = 401, condition = "Unauthorized"),
  84             @ResponseCode(code = 501, condition = "Not Implemented") })
  85
  86     public Response listGroups(
  87             // return fields
  88             @QueryParam("fields") List<String> fields,
  89             // OpenStack LoadBalancerPool attributes
  90             @QueryParam("id") String queryLoadBalancerPoolID,
  91             @QueryParam("tenant_id") String queryLoadBalancerPoolTenantID,
  92             @QueryParam("name") String queryLoadBalancerPoolName,
  93             @QueryParam("description") String queryLoadBalancerDescription,
  94             @QueryParam("protocol") String queryLoadBalancerProtocol,
  95             @QueryParam("lb_algorithm") String queryLoadBalancerPoolLbAlgorithm,
  96             @QueryParam("healthmonitor_id") String queryLoadBalancerPoolHealthMonitorID,
  97             @QueryParam("admin_state_up") String queryLoadBalancerIsAdminStateUp,
  98             @QueryParam("status") String queryLoadBalancerPoolStatus,
  99             @QueryParam("members") List<NeutronLoadBalancerPoolMember> queryLoadBalancerPoolMembers,
 100             // pagination
 101             @QueryParam("limit") String limit,
 102             @QueryParam("marker") String marker,
 103             @QueryParam("page_reverse") String pageReverse
 104             // sorting not supported
 105     ) {
 106         INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
 107         if (loadBalancerPoolInterface == null) {
 108             throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
 109                     + RestMessages.SERVICEUNAVAILABLE.toString());
 110         }
 111         List<NeutronLoadBalancerPool> allLoadBalancerPools = loadBalancerPoolInterface.getAllNeutronLoadBalancerPools();
 112         List<NeutronLoadBalancerPool> ans = new ArrayList<NeutronLoadBalancerPool>();
 113         Iterator<NeutronLoadBalancerPool> i = allLoadBalancerPools.iterator();
 114         while (i.hasNext()) {
 115             NeutronLoadBalancerPool nsg = i.next();
 116             if ((queryLoadBalancerPoolID == null ||
 117                     queryLoadBalancerPoolID.equals(nsg.getLoadBalancerPoolID())) &&
 118                     (queryLoadBalancerPoolTenantID == null ||
 119                             queryLoadBalancerPoolTenantID.equals(nsg.getLoadBalancerPoolTenantID())) &&
 120                     (queryLoadBalancerPoolName == null ||
 121                             queryLoadBalancerPoolName.equals(nsg.getLoadBalancerPoolName())) &&
 122                     (queryLoadBalancerDescription == null ||
 123                             queryLoadBalancerDescription.equals(nsg.getLoadBalancerPoolDescription())) &&
 124                     (queryLoadBalancerPoolLbAlgorithm == null ||
 125                             queryLoadBalancerPoolLbAlgorithm.equals(nsg.getLoadBalancerPoolLbAlgorithm())) &&
 126                     (queryLoadBalancerPoolHealthMonitorID == null ||
 127                             queryLoadBalancerPoolHealthMonitorID.equals(nsg.getNeutronLoadBalancerPoolHealthMonitorID())) &&
 128                     (queryLoadBalancerIsAdminStateUp == null ||
 129                             queryLoadBalancerIsAdminStateUp.equals(nsg.getLoadBalancerPoolAdminIsStateIsUp())) &&
 130                     (queryLoadBalancerPoolStatus == null ||
 131                             queryLoadBalancerPoolStatus.equals(nsg.getLoadBalancerPoolStatus())) &&
 132                     (queryLoadBalancerPoolMembers.size() == 0 ||
 133                             queryLoadBalancerPoolMembers.equals(nsg.getLoadBalancerPoolMembers()))) {
 134                 if (fields.size() > 0) {
 135                     ans.add(extractFields(nsg,fields));
 136                 } else {
 137                     ans.add(nsg);
 138                 }
 139             }
 140         }
 141         return Response.status(200).entity(
 142                 new NeutronLoadBalancerPoolRequest(ans)).build();
 143     }
 144
 145     /**
 146      * Returns a specific LoadBalancerPool */
 147
 148     @Path("{loadBalancerPoolID}")
 149     @GET
 150     @Produces({ MediaType.APPLICATION_JSON })
 151     @StatusCodes({
 152             @ResponseCode(code = 200, condition = "Operation successful"),
 153             @ResponseCode(code = 401, condition = "Unauthorized"),
 154             @ResponseCode(code = 404, condition = "Not Found"),
 155             @ResponseCode(code = 501, condition = "Not Implemented") })
 156     public Response showLoadBalancerPool(@PathParam("loadBalancerPoolID") String loadBalancerPoolID,
 157             // return fields
 158             @QueryParam("fields") List<String> fields) {
 159         INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
 160         if (loadBalancerPoolInterface == null) {
 161             throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
 162                     + RestMessages.SERVICEUNAVAILABLE.toString());
 163         }
 164         if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) {
 165             throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
 166         }
 167         if (fields.size() > 0) {
 168             NeutronLoadBalancerPool ans = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
 169             return Response.status(200).entity(
 170                     new NeutronLoadBalancerPoolRequest(extractFields(ans, fields))).build();
 171         } else {
 172             return Response.status(200).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build();
 173         }
 174     }
 175
 176     /**
 177      * Creates new LoadBalancerPool */
 178
 179     @POST
 180     @Produces({ MediaType.APPLICATION_JSON })
 181     @Consumes({ MediaType.APPLICATION_JSON })
 182     @StatusCodes({
 183             @ResponseCode(code = 201, condition = "Created"),
 184             @ResponseCode(code = 400, condition = "Bad Request"),
 185             @ResponseCode(code = 401, condition = "Unauthorized"),
 186             @ResponseCode(code = 403, condition = "Forbidden"),
 187             @ResponseCode(code = 404, condition = "Not Found"),
 188             @ResponseCode(code = 409, condition = "Conflict"),
 189             @ResponseCode(code = 501, condition = "Not Implemented") })
 190     public Response createLoadBalancerPools(final NeutronLoadBalancerPoolRequest input) {
 191         INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
 192         if (loadBalancerPoolInterface == null) {
 193             throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
 194                     + RestMessages.SERVICEUNAVAILABLE.toString());
 195         }
 196         if (input.isSingleton()) {
 197             NeutronLoadBalancerPool singleton = input.getSingleton();
 198
 199             /*
 200              *  Verify that the LoadBalancerPool doesn't already exist.
 201              */
 202             if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(singleton.getLoadBalancerPoolID())) {
 203                 throw new BadRequestException("LoadBalancerPool UUID already exists");
 204             }
 205             loadBalancerPoolInterface.addNeutronLoadBalancerPool(singleton);
 206
 207             Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
 208             if (instances != null) {
 209                 for (Object instance : instances) {
 210                     INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 211                     int status = service.canCreateNeutronLoadBalancerPool(singleton);
 212                     if (status < 200 || status > 299) {
 213                         return Response.status(status).build();
 214                     }
 215                 }
 216             }
 217             loadBalancerPoolInterface.addNeutronLoadBalancerPool(singleton);
 218             if (instances != null) {
 219                 for (Object instance : instances) {
 220                     INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 221                     service.neutronLoadBalancerPoolCreated(singleton);
 222                 }
 223             }
 224         } else {
 225             List<NeutronLoadBalancerPool> bulk = input.getBulk();
 226             Iterator<NeutronLoadBalancerPool> i = bulk.iterator();
 227             HashMap<String, NeutronLoadBalancerPool> testMap = new HashMap<String, NeutronLoadBalancerPool>();
 228             Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
 229             while (i.hasNext()) {
 230                 NeutronLoadBalancerPool test = i.next();
 231
 232                 /*
 233                  *  Verify that the loadBalancerPool doesn't already exist
 234                  */
 235
 236                 if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(test.getLoadBalancerPoolID())) {
 237                     throw new BadRequestException("Load Balancer Pool UUID already is already created");
 238                 }
 239                 if (testMap.containsKey(test.getLoadBalancerPoolID())) {
 240                     throw new BadRequestException("Load Balancer Pool UUID already exists");
 241                 }
 242                 if (instances != null) {
 243                     for (Object instance : instances) {
 244                         INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 245                         int status = service.canCreateNeutronLoadBalancerPool(test);
 246                         if (status < 200 || status > 299) {
 247                             return Response.status(status).build();
 248                         }
 249                     }
 250                 }
 251             }
 252             /*
 253              * now, each element of the bulk request can be added to the cache
 254              */
 255             i = bulk.iterator();
 256             while (i.hasNext()) {
 257                 NeutronLoadBalancerPool test = i.next();
 258                 loadBalancerPoolInterface.addNeutronLoadBalancerPool(test);
 259                 if (instances != null) {
 260                     for (Object instance : instances) {
 261                         INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 262                         service.neutronLoadBalancerPoolCreated(test);
 263                     }
 264                 }
 265             }
 266         }
 267         return Response.status(201).entity(input).build();
 268     }
 269
 270     /**
 271      * Updates a LoadBalancerPool Policy
 272      */
 273     @Path("{loadBalancerPoolID}")
 274     @PUT
 275     @Produces({ MediaType.APPLICATION_JSON })
 276     @Consumes({ MediaType.APPLICATION_JSON })
 277     @StatusCodes({
 278             @ResponseCode(code = 200, condition = "Operation successful"),
 279             @ResponseCode(code = 400, condition = "Bad Request"),
 280             @ResponseCode(code = 401, condition = "Unauthorized"),
 281             @ResponseCode(code = 403, condition = "Forbidden"),
 282             @ResponseCode(code = 404, condition = "Not Found"),
 283             @ResponseCode(code = 501, condition = "Not Implemented") })
 284     public Response updateLoadBalancerPool(
 285             @PathParam("loadBalancerPoolID") String loadBalancerPoolID, final NeutronLoadBalancerPoolRequest input) {
 286         INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
 287         if (loadBalancerPoolInterface == null) {
 288             throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
 289                     + RestMessages.SERVICEUNAVAILABLE.toString());
 290         }
 291
 292         /*
 293          * verify the LoadBalancerPool exists and there is only one delta provided
 294          */
 295         if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) {
 296             throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
 297         }
 298         if (!input.isSingleton()) {
 299             throw new BadRequestException("Only singleton edit supported");
 300         }
 301         NeutronLoadBalancerPool delta = input.getSingleton();
 302         NeutronLoadBalancerPool original = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
 303
 304         /*
 305          * updates restricted by Neutron
 306          */
 307         if (delta.getLoadBalancerPoolID() != null ||
 308                 delta.getLoadBalancerPoolTenantID() != null ||
 309                 delta.getLoadBalancerPoolName() != null ||
 310                 delta.getLoadBalancerPoolDescription() != null ||
 311                 delta.getLoadBalancerPoolProtocol() != null ||
 312                 delta.getLoadBalancerPoolLbAlgorithm() != null ||
 313                 delta.getNeutronLoadBalancerPoolHealthMonitorID() != null ||
 314                 delta.getLoadBalancerPoolAdminIsStateIsUp() != null ||
 315                 delta.getLoadBalancerPoolStatus() != null ||
 316                 delta.getLoadBalancerPoolMembers() != null) {
 317             throw new BadRequestException("Attribute edit blocked by Neutron");
 318         }
 319
 320         Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
 321         if (instances != null) {
 322             for (Object instance : instances) {
 323                 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 324                 int status = service.canUpdateNeutronLoadBalancerPool(delta, original);
 325                 if (status < 200 || status > 299) {
 326                     return Response.status(status).build();
 327                 }
 328             }
 329         }
 330
 331         /*
 332          * update the object and return it
 333          */
 334         loadBalancerPoolInterface.updateNeutronLoadBalancerPool(loadBalancerPoolID, delta);
 335         NeutronLoadBalancerPool updatedLoadBalancerPool = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
 336         if (instances != null) {
 337             for (Object instance : instances) {
 338                 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 339                 service.neutronLoadBalancerPoolUpdated(updatedLoadBalancerPool);
 340             }
 341         }
 342         return Response.status(200).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build();
 343     }
 344
 345     /**
 346      * Deletes a LoadBalancerPool
 347      */
 348
 349     @Path("{loadBalancerPoolUUID}")
 350     @DELETE
 351     @StatusCodes({
 352             @ResponseCode(code = 204, condition = "No Content"),
 353             @ResponseCode(code = 401, condition = "Unauthorized"),
 354             @ResponseCode(code = 404, condition = "Not Found"),
 355             @ResponseCode(code = 409, condition = "Conflict"),
 356             @ResponseCode(code = 501, condition = "Not Implemented") })
 357     public Response deleteLoadBalancerPool(
 358             @PathParam("loadBalancerPoolUUID") String loadBalancerPoolUUID) {
 359         INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
 360         if (loadBalancerPoolInterface == null) {
 361             throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
 362                     + RestMessages.SERVICEUNAVAILABLE.toString());
 363         }
 364
 365         /*
 366          * verify the LoadBalancerPool exists and it isn't currently in use
 367          */
 368         if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolUUID)) {
 369             throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
 370         }
 371         if (loadBalancerPoolInterface.neutronLoadBalancerPoolInUse(loadBalancerPoolUUID)) {
 372             return Response.status(409).build();
 373         }
 374         NeutronLoadBalancerPool singleton = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolUUID);
 375         Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
 376         if (instances != null) {
 377             for (Object instance : instances) {
 378                 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 379                 int status = service.canDeleteNeutronLoadBalancerPool(singleton);
 380                 if (status < 200 || status > 299) {
 381                     return Response.status(status).build();
 382                 }
 383             }
 384         }
 385
 386         /*
 387          * remove it and return 204 status
 388          */
 389         loadBalancerPoolInterface.removeNeutronLoadBalancerPool(loadBalancerPoolUUID);
 390         if (instances != null) {
 391             for (Object instance : instances) {
 392                 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
 393                 service.neutronLoadBalancerPoolDeleted(singleton);
 394             }
 395         }
 396
 397         /*
 398          * remove corresponding members from the member cache too
 399          */
 400         INeutronLoadBalancerPoolMemberCRUD loadBalancerPoolMemberInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolMemberCRUD(this);
 401         if (loadBalancerPoolMemberInterface != null) {
 402             List<NeutronLoadBalancerPoolMember> allLoadBalancerPoolMembers = new
 403                 ArrayList<NeutronLoadBalancerPoolMember>(loadBalancerPoolMemberInterface.getAllNeutronLoadBalancerPoolMembers());
 404             Iterator<NeutronLoadBalancerPoolMember> i = allLoadBalancerPoolMembers.iterator();
 405             while (i.hasNext()) {
 406                 NeutronLoadBalancerPoolMember member = i.next();
 407                 if (member.getPoolID() == loadBalancerPoolUUID)
 408                     loadBalancerPoolMemberInterface.removeNeutronLoadBalancerPoolMember(member.getPoolMemberID());
 409             }
 410         }
 411         return Response.status(204).build();
 412     }
 413 }