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