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