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                 if (instances.length > 0) {
 202                     for (Object instance : instances) {
 203                         INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 204                         int status = service.canCreateNeutronLoadBalancerListener(singleton);
 205                         if (status < 200 || status > 299) {
 206                             return Response.status(status).build();
 207                         }
 208                     }
 209                 } else {
 210                     throw new ServiceUnavailableException("No providers registered.  Please try again later");
 211                 }
 212             } else {
 213                 throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 214             }
 215             loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton);
 216             if (instances != null) {
 217                 for (Object instance : instances) {
 218                     INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 219                     service.neutronLoadBalancerListenerCreated(singleton);
 220                 }
 221             }
 222         } else {
 223             List<NeutronLoadBalancerListener> bulk = input.getBulk();
 224             Iterator<NeutronLoadBalancerListener> i = bulk.iterator();
 225             HashMap<String, NeutronLoadBalancerListener> testMap = new HashMap<String, NeutronLoadBalancerListener>();
 226             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 227             while (i.hasNext()) {
 228                 NeutronLoadBalancerListener test = i.next();
 229
 230                 /*
 231                  *  Verify that the firewall policy doesn't already exist
 232                  */
 233
 234                 if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(test.getLoadBalancerListenerID())) {
 235                     throw new BadRequestException("LoadBalancerListener UUID already is already created");
 236                 }
 237                 if (testMap.containsKey(test.getLoadBalancerListenerID())) {
 238                     throw new BadRequestException("LoadBalancerListener UUID already exists");
 239                 }
 240                 if (instances != null) {
 241                     if (instances.length > 0) {
 242                         for (Object instance : instances) {
 243                             INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 244                             int status = service.canCreateNeutronLoadBalancerListener(test);
 245                             if (status < 200 || status > 299) {
 246                                 return Response.status(status).build();
 247                             }
 248                         }
 249                     } else {
 250                         throw new ServiceUnavailableException("No providers registered.  Please try again later");
 251                     }
 252                 } else {
 253                     throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 254                 }
 255             }
 256             /*
 257              * now, each element of the bulk request can be added to the cache
 258              */
 259             i = bulk.iterator();
 260             while (i.hasNext()) {
 261                 NeutronLoadBalancerListener test = i.next();
 262                 loadBalancerListenerInterface.addNeutronLoadBalancerListener(test);
 263                 if (instances != null) {
 264                     for (Object instance : instances) {
 265                         INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 266                         service.neutronLoadBalancerListenerCreated(test);
 267                     }
 268                 }
 269             }
 270         }
 271         return Response.status(201).entity(input).build();
 272     }
 273
 274     /**
 275      * Updates a LoadBalancerListener Policy
 276      */
 277     @Path("{loadBalancerListenerID}")
 278     @PUT
 279     @Produces({ MediaType.APPLICATION_JSON })
 280     @Consumes({ MediaType.APPLICATION_JSON })
 281     @StatusCodes({
 282             @ResponseCode(code = 200, condition = "Operation successful"),
 283             @ResponseCode(code = 400, condition = "Bad Request"),
 284             @ResponseCode(code = 401, condition = "Unauthorized"),
 285             @ResponseCode(code = 403, condition = "Forbidden"),
 286             @ResponseCode(code = 404, condition = "Not Found"),
 287             @ResponseCode(code = 501, condition = "Not Implemented") })
 288     public Response updateLoadBalancerListener(
 289             @PathParam("loadBalancerListenerID") String loadBalancerListenerID, final NeutronLoadBalancerListenerRequest input) {
 290         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 291         if (loadBalancerListenerInterface == null) {
 292             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 293                     + RestMessages.SERVICEUNAVAILABLE.toString());
 294         }
 295
 296         /*
 297          * verify the LoadBalancerListener exists and there is only one delta provided
 298          */
 299         if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
 300             throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
 301         }
 302         if (!input.isSingleton()) {
 303             throw new BadRequestException("Only singleton edit supported");
 304         }
 305         NeutronLoadBalancerListener delta = input.getSingleton();
 306         NeutronLoadBalancerListener original = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 307
 308         /*
 309          * updates restricted by Neutron
 310          */
 311         if (delta.getLoadBalancerListenerID() != null ||
 312                 delta.getNeutronLoadBalancerListenerDefaultPoolID() != null ||
 313                 delta.getLoadBalancerListenerTenantID() != null ||
 314                 delta.getLoadBalancerListenerName() != null ||
 315                 delta.getLoadBalancerListenerDescription() != null ||
 316                 delta.getLoadBalancerListenerIsShared() != null ||
 317                 delta.getNeutronLoadBalancerListenerProtocol() != null ||
 318                 delta.getNeutronLoadBalancerListenerProtocolPort() != null ||
 319                 delta.getNeutronLoadBalancerListenerLoadBalancerID() != null ||
 320                 delta.getLoadBalancerListenerAdminStateIsUp() != null ||
 321                 delta.getLoadBalancerListenerStatus() != null) {
 322             throw new BadRequestException("Attribute edit blocked by Neutron");
 323         }
 324
 325         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 326         if (instances != null) {
 327             if (instances.length > 0) {
 328                 for (Object instance : instances) {
 329                     INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 330                     int status = service.canUpdateNeutronLoadBalancerListener(delta, original);
 331                     if (status < 200 || status > 299) {
 332                         return Response.status(status).build();
 333                     }
 334                 }
 335             } else {
 336                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
 337             }
 338         } else {
 339             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 340         }
 341
 342         /*
 343          * update the object and return it
 344          */
 345         loadBalancerListenerInterface.updateNeutronLoadBalancerListener(loadBalancerListenerID, delta);
 346         NeutronLoadBalancerListener updatedLoadBalancerListener = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 347         if (instances != null) {
 348             for (Object instance : instances) {
 349                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 350                 service.neutronLoadBalancerListenerUpdated(updatedLoadBalancerListener);
 351             }
 352         }
 353         return Response.status(200).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build();
 354     }
 355
 356     /**
 357      * Deletes a LoadBalancerListener */
 358
 359     @Path("{loadBalancerListenerID}")
 360     @DELETE
 361     @StatusCodes({
 362             @ResponseCode(code = 204, condition = "No Content"),
 363             @ResponseCode(code = 401, condition = "Unauthorized"),
 364             @ResponseCode(code = 404, condition = "Not Found"),
 365             @ResponseCode(code = 409, condition = "Conflict"),
 366             @ResponseCode(code = 501, condition = "Not Implemented") })
 367     public Response deleteLoadBalancerListener(
 368             @PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
 369         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
 370         if (loadBalancerListenerInterface == null) {
 371             throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
 372                     + RestMessages.SERVICEUNAVAILABLE.toString());
 373         }
 374
 375         /*
 376          * verify the LoadBalancerListener exists and it isn't currently in use
 377          */
 378         if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
 379             throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
 380         }
 381         if (loadBalancerListenerInterface.neutronLoadBalancerListenerInUse(loadBalancerListenerID)) {
 382             return Response.status(409).build();
 383         }
 384         NeutronLoadBalancerListener singleton = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
 385         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this);
 386         if (instances != null) {
 387             if (instances.length > 0) {
 388                 for (Object instance : instances) {
 389                     INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 390                     int status = service.canDeleteNeutronLoadBalancerListener(singleton);
 391                     if (status < 200 || status > 299) {
 392                         return Response.status(status).build();
 393                     }
 394                 }
 395             } else {
 396                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
 397             }
 398         } else {
 399             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 400         }
 401
 402         loadBalancerListenerInterface.removeNeutronLoadBalancerListener(loadBalancerListenerID);
 403         if (instances != null) {
 404             for (Object instance : instances) {
 405                 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
 406                 service.neutronLoadBalancerListenerDeleted(singleton);
 407             }
 408         }
 409         return Response.status(204).build();
 410     }
 411 }