opendaylight/networkconfiguration/neutron/northbound/src/main/java/org/opendaylight/controller/networkconfig/neutron/northbound/NeutronLoadBalancerListenerNorthbound.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 package org.opendaylight.controller.networkconfig.neutron.northbound;
  10
  11
  12 import java.util.ArrayList;
  13 import java.util.HashMap;
  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.controller.networkconfig.neutron.INeutronLoadBalancerListenerAware;
  32 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerListenerCRUD;
  33 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
  34 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerListener;
  35
  36 /**
  37  * Neutron Northbound REST APIs for LoadBalancerListener Policies.<br>
  38  * This class provides REST APIs for managing neutron LoadBalancerListener Policies
  39  *
  40  * <br>
  41  * <br>
  42  * Authentication scheme : <b>HTTP Basic</b><br>
  43  * Authentication realm : <b>opendaylight</b><br>
  44  * Transport : <b>HTTP and HTTPS</b><br>
  45  * <br>
  46  * HTTPS Authentication is disabled by default. Administrator can enable it in
  47  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  48  * trusted authority.<br>
  49  * More info :
  50  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  51  *
  52  */
  53 @Path("/listeners")
  54 public class NeutronLoadBalancerListenerNorthbound {
  55
  56     private NeutronLoadBalancerListener extractFields(NeutronLoadBalancerListener o, List<String> fields) {
  57         return o.extractFields(fields);
  58     }
  59
  60     /**
  61      * Returns a list of all LoadBalancerListener */
  62     @GET
  63     @Produces({ MediaType.APPLICATION_JSON })
  64     @StatusCodes({
  65             @ResponseCode(code = 200, condition = "Operation successful"),
  66             @ResponseCode(code = 401, condition = "Unauthorized"),
  67             @ResponseCode(code = 501, condition = "Not Implemented") })
  68
  69     public Response listGroups(
  70             // return fields
  71             @QueryParam("fields") List<String> fields,
  72             // OpenStack LoadBalancerListener attributes
  73             @QueryParam("id") String queryLoadBalancerListenerID,
  74             @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
  75             @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
  76             @QueryParam("name") String queryLoadBalancerListenerName,
  77             @QueryParam("description") String queryLoadBalancerListenerDescription,
  78             @QueryParam("shared") String queryLoadBalancerListenerIsShared,
  79             @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
  80             @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
  81             @QueryParam("load_balancer_id") String queryLoadBalancerListenerLoadBalancerID,
  82             @QueryParam("admin_state_up") String queryLoadBalancerListenerAdminIsUp,
  83             @QueryParam("status") String queryLoadBalancerListenerStatus,
  84             // pagination
  85             @QueryParam("limit") String limit,
  86             @QueryParam("marker") String marker,
  87             @QueryParam("page_reverse") String pageReverse
  88             // sorting not supported
  89     ) {
  90         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
  91         //        INeutronLoadBalancerListenerRuleCRUD firewallRuleInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerRuleCRUD(this);
  92
  93         if (loadBalancerListenerInterface == null) {
  94             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
  95                     + RestMessages.SERVICEUNAVAILABLE.toString());
  96         }
  97         List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAllNeutronLoadBalancerListeners();
  98         //        List<NeutronLoadBalancerListenerRule> allLoadBalancerListenerRules = firewallRuleInterface.getAllNeutronLoadBalancerListenerRules();
  99         List<NeutronLoadBalancerListener> ans = new ArrayList<NeutronLoadBalancerListener>();
 100         //        List<NeutronLoadBalancerListenerRule> rules = new ArrayList<NeutronLoadBalancerListenerRule>();
 101         Iterator<NeutronLoadBalancerListener> i = allLoadBalancerListeners.iterator();
 102         while (i.hasNext()) {
 103             NeutronLoadBalancerListener nsg = i.next();
 104             if ((queryLoadBalancerListenerID == null ||
 105                     queryLoadBalancerListenerID.equals(nsg.getLoadBalancerListenerID())) &&
 106                     (queryLoadBalancerListenerDefaultPoolID == null ||
 107                             queryLoadBalancerListenerDefaultPoolID.equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID())) &&
 108                     (queryLoadBalancerListenerTenantID == null ||
 109                             queryLoadBalancerListenerTenantID.equals(nsg.getLoadBalancerListenerTenantID())) &&
 110                     (queryLoadBalancerListenerName == null ||
 111                             queryLoadBalancerListenerName.equals(nsg.getLoadBalancerListenerName())) &&
 112                     (queryLoadBalancerListenerDescription == null ||
 113                             queryLoadBalancerListenerDescription.equals(nsg.getLoadBalancerListenerDescription())) &&
 114                     (queryLoadBalancerListenerIsShared == null ||
 115                             queryLoadBalancerListenerIsShared.equals(nsg.getLoadBalancerListenerIsShared())) &&
 116                     (queryLoadBalancerListenerProtocol == null ||
 117                             queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol())) &&
 118                     (queryLoadBalancerListenerProtocolPort == null ||
 119                             queryLoadBalancerListenerProtocolPort.equals(nsg.getNeutronLoadBalancerListenerProtocolPort())) &&
 120                     (queryLoadBalancerListenerLoadBalancerID == null ||
 121                             queryLoadBalancerListenerLoadBalancerID.equals(nsg.getNeutronLoadBalancerListenerLoadBalancerID())) &&
 122                     (queryLoadBalancerListenerAdminIsUp == null ||
 123                             queryLoadBalancerListenerAdminIsUp.equals(nsg.getLoadBalancerListenerAdminStateIsUp())) &&
 124                     (queryLoadBalancerListenerStatus == null ||
 125                             queryLoadBalancerListenerStatus.equals(nsg.getLoadBalancerListenerStatus()))) {
 126                 if (fields.size() > 0) {
 127                     ans.add(extractFields(nsg,fields));
 128                 } else {
 129                     ans.add(nsg);
 130                 }
 131             }
 132         }
 133         return Response.status(200).entity(
 134                 new NeutronLoadBalancerListenerRequest(ans)).build();
 135     }
 136
 137     /**
 138      * Returns a specific LoadBalancerListener */
 139
 140     @Path("{loadBalancerListenerID}")
 141     @GET
 142     @Produces({ MediaType.APPLICATION_JSON })
 143     @StatusCodes({
 144             @ResponseCode(code = 200, condition = "Operation successful"),
 145             @ResponseCode(code = 401, condition = "Unauthorized"),
 146             @ResponseCode(code = 404, condition = "Not Found"),
 147             @ResponseCode(code = 501, condition = "Not Implemented") })
 148     public Response showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
 149             // return fields
 150             @QueryParam("fields") List<String> fields) {
 151         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 152         if (loadBalancerListenerInterface == null) {
 153             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 154                     + RestMessages.SERVICEUNAVAILABLE.toString());
 155         }
 156         if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
 157             throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
 158         }
 159         if (fields.size() > 0) {
 160             NeutronLoadBalancerListener ans = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 161             return Response.status(200).entity(
 162                     new NeutronLoadBalancerListenerRequest(extractFields(ans, fields))).build();
 163         } else {
 164             return Response.status(200).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build();
 165         }
 166     }
 167
 168     /**
 169      * Creates new LoadBalancerListener */
 170
 171     @POST
 172     @Produces({ MediaType.APPLICATION_JSON })
 173     @Consumes({ MediaType.APPLICATION_JSON })
 174     @StatusCodes({
 175             @ResponseCode(code = 201, condition = "Created"),
 176             @ResponseCode(code = 400, condition = "Bad Request"),
 177             @ResponseCode(code = 401, condition = "Unauthorized"),
 178             @ResponseCode(code = 403, condition = "Forbidden"),
 179             @ResponseCode(code = 404, condition = "Not Found"),
 180             @ResponseCode(code = 409, condition = "Conflict"),
 181             @ResponseCode(code = 501, condition = "Not Implemented") })
 182     public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
 183         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 184         if (loadBalancerListenerInterface == null) {
 185             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 186                     + RestMessages.SERVICEUNAVAILABLE.toString());
 187         }
 188         if (input.isSingleton()) {
 189             NeutronLoadBalancerListener singleton = input.getSingleton();
 190
 191             /*
 192              *  Verify that the LoadBalancerListener doesn't already exist.
 193              */
 194             if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(singleton.getLoadBalancerListenerID())) {
 195                 throw new BadRequestException("LoadBalancerListener UUID already exists");
 196             }
 197             loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton);
 198
 199             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 200             if (instances != null) {
 201                 for (Object instance : instances) {
 202                     INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 203                     int status = service.canCreateNeutronLoadBalancerListener(singleton);
 204                     if (status < 200 || status > 299) {
 205                         return Response.status(status).build();
 206                     }
 207                 }
 208             }
 209             loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton);
 210             if (instances != null) {
 211                 for (Object instance : instances) {
 212                     INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 213                     service.neutronLoadBalancerListenerCreated(singleton);
 214                 }
 215             }
 216         } else {
 217             List<NeutronLoadBalancerListener> bulk = input.getBulk();
 218             Iterator<NeutronLoadBalancerListener> i = bulk.iterator();
 219             HashMap<String, NeutronLoadBalancerListener> testMap = new HashMap<String, NeutronLoadBalancerListener>();
 220             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 221             while (i.hasNext()) {
 222                 NeutronLoadBalancerListener test = i.next();
 223
 224                 /*
 225                  *  Verify that the firewall policy doesn't already exist
 226                  */
 227
 228                 if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(test.getLoadBalancerListenerID())) {
 229                     throw new BadRequestException("LoadBalancerListener UUID already is already created");
 230                 }
 231                 if (testMap.containsKey(test.getLoadBalancerListenerID())) {
 232                     throw new BadRequestException("LoadBalancerListener UUID already exists");
 233                 }
 234                 if (instances != null) {
 235                     for (Object instance : instances) {
 236                         INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 237                         int status = service.canCreateNeutronLoadBalancerListener(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                 NeutronLoadBalancerListener test = i.next();
 250                 loadBalancerListenerInterface.addNeutronLoadBalancerListener(test);
 251                 if (instances != null) {
 252                     for (Object instance : instances) {
 253                         INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 254                         service.neutronLoadBalancerListenerCreated(test);
 255                     }
 256                 }
 257             }
 258         }
 259         return Response.status(201).entity(input).build();
 260     }
 261
 262     /**
 263      * Updates a LoadBalancerListener Policy
 264      */
 265     @Path("{loadBalancerListenerID}")
 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 updateLoadBalancerListener(
 277             @PathParam("loadBalancerListenerID") String loadBalancerListenerID, final NeutronLoadBalancerListenerRequest input) {
 278         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 279         if (loadBalancerListenerInterface == null) {
 280             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 281                     + RestMessages.SERVICEUNAVAILABLE.toString());
 282         }
 283
 284         /*
 285          * verify the LoadBalancerListener exists and there is only one delta provided
 286          */
 287         if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
 288             throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
 289         }
 290         if (!input.isSingleton()) {
 291             throw new BadRequestException("Only singleton edit supported");
 292         }
 293         NeutronLoadBalancerListener delta = input.getSingleton();
 294         NeutronLoadBalancerListener original = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 295
 296         /*
 297          * updates restricted by Neutron
 298          */
 299         if (delta.getLoadBalancerListenerID() != null ||
 300                 delta.getNeutronLoadBalancerListenerDefaultPoolID() != null ||
 301                 delta.getLoadBalancerListenerTenantID() != null ||
 302                 delta.getLoadBalancerListenerName() != null ||
 303                 delta.getLoadBalancerListenerDescription() != null ||
 304                 delta.getLoadBalancerListenerIsShared() != null ||
 305                 delta.getNeutronLoadBalancerListenerProtocol() != null ||
 306                 delta.getNeutronLoadBalancerListenerProtocolPort() != null ||
 307                 delta.getNeutronLoadBalancerListenerLoadBalancerID() != null ||
 308                 delta.getLoadBalancerListenerAdminStateIsUp() != null ||
 309                 delta.getLoadBalancerListenerStatus() != null) {
 310             throw new BadRequestException("Attribute edit blocked by Neutron");
 311         }
 312
 313         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 314         if (instances != null) {
 315             for (Object instance : instances) {
 316                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 317                 int status = service.canUpdateNeutronLoadBalancerListener(delta, original);
 318                 if (status < 200 || status > 299) {
 319                     return Response.status(status).build();
 320                 }
 321             }
 322         }
 323
 324         /*
 325          * update the object and return it
 326          */
 327         loadBalancerListenerInterface.updateNeutronLoadBalancerListener(loadBalancerListenerID, delta);
 328         NeutronLoadBalancerListener updatedLoadBalancerListener = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 329         if (instances != null) {
 330             for (Object instance : instances) {
 331                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 332                 service.neutronLoadBalancerListenerUpdated(updatedLoadBalancerListener);
 333             }
 334         }
 335         return Response.status(200).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build();
 336     }
 337
 338     /**
 339      * Deletes a LoadBalancerListener */
 340
 341     @Path("{loadBalancerListenerID}")
 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 deleteLoadBalancerListener(
 350             @PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
 351         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 352         if (loadBalancerListenerInterface == null) {
 353             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 354                     + RestMessages.SERVICEUNAVAILABLE.toString());
 355         }
 356
 357         /*
 358          * verify the LoadBalancerListener exists and it isn't currently in use
 359          */
 360         if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
 361             throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
 362         }
 363         if (loadBalancerListenerInterface.neutronLoadBalancerListenerInUse(loadBalancerListenerID)) {
 364             return Response.status(409).build();
 365         }
 366         NeutronLoadBalancerListener singleton = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 367         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 368         if (instances != null) {
 369             for (Object instance : instances) {
 370                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 371                 int status = service.canDeleteNeutronLoadBalancerListener(singleton);
 372                 if (status < 200 || status > 299) {
 373                     return Response.status(status).build();
 374                 }
 375             }
 376         }
 377
 378         loadBalancerListenerInterface.removeNeutronLoadBalancerListener(loadBalancerListenerID);
 379         if (instances != null) {
 380             for (Object instance : instances) {
 381                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 382                 service.neutronLoadBalancerListenerDeleted(singleton);
 383             }
 384         }
 385         return Response.status(204).build();
 386     }
 387 }