opendaylight/networkconfiguration/neutron/northbound/src/main/java/org/opendaylight/controller/networkconfig/neutron/northbound/NeutronLoadBalancerHealthMonitorNorthbound.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.INeutronLoadBalancerHealthMonitorAware;
  32 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerHealthMonitorCRUD;
  33 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
  34 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancer;
  35 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerHealthMonitor;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Neutron Northbound REST APIs for Load Balancer HealthMonitor.<br>
  41  * This class provides REST APIs for managing neutron LoadBalancerHealthMonitor
  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 @Path("/healthmonitors")
  57 public class NeutronLoadBalancerHealthMonitorNorthbound {
  58     private static final Logger logger = LoggerFactory.getLogger(NeutronLoadBalancer.class);
  59
  60     private NeutronLoadBalancerHealthMonitor extractFields(NeutronLoadBalancerHealthMonitor o, List<String> fields) {
  61         return o.extractFields(fields);
  62     }
  63
  64     /**
  65      * Returns a list of all LoadBalancerHealthMonitor */
  66     @GET
  67     @Produces({ MediaType.APPLICATION_JSON })
  68     @StatusCodes({
  69             @ResponseCode(code = 200, condition = "Operation successful"),
  70             @ResponseCode(code = 401, condition = "Unauthorized"),
  71             @ResponseCode(code = 501, condition = "Not Implemented") })
  72
  73     public Response listGroups(
  74             // return fields
  75             @QueryParam("fields") List<String> fields,
  76             // OpenStack LoadBalancerHealthMonitor attributes
  77             @QueryParam("id") String queryLoadBalancerHealthMonitorID,
  78             @QueryParam("tenant_id") String queryLoadBalancerHealthMonitorTenantID,
  79             // TODO "type" is being a property by the JSON parser.
  80             @QueryParam("type") String queryLoadBalancerHealthMonitorType,
  81             @QueryParam("delay") Integer queryLoadBalancerHealthMonitorDelay,
  82             @QueryParam("timeout") Integer queryLoadBalancerHealthMonitorTimeout,
  83             @QueryParam("max_retries") Integer queryLoadBalancerHealthMonitorMaxRetries,
  84             @QueryParam("http_method") String queryLoadBalancerHealthMonitorHttpMethod,
  85             @QueryParam("url_path") String queryLoadBalancerHealthMonitorUrlPath,
  86             @QueryParam("expected_codes") String queryLoadBalancerHealthMonitorExpectedCodes,
  87             @QueryParam("admin_state_up") Boolean queryLoadBalancerHealthMonitorIsAdminStateUp,
  88             @QueryParam("status") String queryLoadBalancerHealthMonitorStatus,
  89             // pagination
  90             @QueryParam("limit") String limit,
  91             @QueryParam("marker") String marker,
  92             @QueryParam("page_reverse") String pageReverse
  93             // sorting not supported
  94     ) {
  95         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces
  96                 .getINeutronLoadBalancerHealthMonitorCRUD(this);
  97         if (loadBalancerHealthMonitorInterface == null) {
  98             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
  99                     + RestMessages.SERVICEUNAVAILABLE.toString());
 100         }
 101         List<NeutronLoadBalancerHealthMonitor> allLoadBalancerHealthMonitors = loadBalancerHealthMonitorInterface.getAllNeutronLoadBalancerHealthMonitors();
 102         List<NeutronLoadBalancerHealthMonitor> ans = new ArrayList<NeutronLoadBalancerHealthMonitor>();
 103         Iterator<NeutronLoadBalancerHealthMonitor> i = allLoadBalancerHealthMonitors.iterator();
 104         while (i.hasNext()) {
 105             NeutronLoadBalancerHealthMonitor nsg = i.next();
 106             if ((queryLoadBalancerHealthMonitorID == null ||
 107                     queryLoadBalancerHealthMonitorID.equals(nsg.getLoadBalancerHealthMonitorID())) &&
 108                     (queryLoadBalancerHealthMonitorTenantID == null ||
 109                             queryLoadBalancerHealthMonitorTenantID.equals
 110                                     (nsg.getLoadBalancerHealthMonitorTenantID())) &&
 111                     (queryLoadBalancerHealthMonitorType == null ||
 112                             queryLoadBalancerHealthMonitorType.equals
 113                                     (nsg.getLoadBalancerHealthMonitorType())) &&
 114                     (queryLoadBalancerHealthMonitorDelay == null ||
 115                             queryLoadBalancerHealthMonitorDelay.equals
 116                                     (nsg.getLoadBalancerHealthMonitorDelay())) &&
 117                     (queryLoadBalancerHealthMonitorTimeout == null ||
 118                             queryLoadBalancerHealthMonitorTimeout.equals
 119                                     (nsg.getLoadBalancerHealthMonitorTimeout())) &&
 120                     (queryLoadBalancerHealthMonitorMaxRetries == null ||
 121                             queryLoadBalancerHealthMonitorMaxRetries.equals
 122                                     (nsg.getLoadBalancerHealthMonitorMaxRetries())) &&
 123                     (queryLoadBalancerHealthMonitorHttpMethod == null ||
 124                             queryLoadBalancerHealthMonitorHttpMethod.equals
 125                                     (nsg.getLoadBalancerHealthMonitorHttpMethod())) &&
 126                     (queryLoadBalancerHealthMonitorUrlPath == null ||
 127                             queryLoadBalancerHealthMonitorUrlPath.equals
 128                                     (nsg.getLoadBalancerHealthMonitorUrlPath())) &&
 129                     (queryLoadBalancerHealthMonitorExpectedCodes == null ||
 130                             queryLoadBalancerHealthMonitorExpectedCodes.equals
 131                                     (nsg.getLoadBalancerHealthMonitorExpectedCodes())) &&
 132                     (queryLoadBalancerHealthMonitorIsAdminStateUp == null ||
 133                             queryLoadBalancerHealthMonitorIsAdminStateUp.equals
 134                                     (nsg.getLoadBalancerHealthMonitorAdminStateIsUp())) &&
 135                     (queryLoadBalancerHealthMonitorStatus == null ||
 136                             queryLoadBalancerHealthMonitorStatus.equals
 137                                     (nsg.getLoadBalancerHealthMonitorStatus()))) {
 138                 if (fields.size() > 0) {
 139                     ans.add(extractFields(nsg,fields));
 140                 } else {
 141                     ans.add(nsg);
 142                 }
 143             }
 144         }
 145         return Response.status(200).entity(
 146                 new NeutronLoadBalancerHealthMonitorRequest(ans)).build();
 147     }
 148
 149     /**
 150      * Returns a specific LoadBalancerHealthMonitor */
 151
 152     @Path("{loadBalancerHealthMonitorID}")
 153     @GET
 154     @Produces({ MediaType.APPLICATION_JSON })
 155     @StatusCodes({
 156             @ResponseCode(code = 200, condition = "Operation successful"),
 157             @ResponseCode(code = 401, condition = "Unauthorized"),
 158             @ResponseCode(code = 404, condition = "Not Found"),
 159             @ResponseCode(code = 501, condition = "Not Implemented") })
 160     public Response showLoadBalancerHealthMonitor(@PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID,
 161             // return fields
 162             @QueryParam("fields") List<String> fields) {
 163         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
 164         if (loadBalancerHealthMonitorInterface == null) {
 165             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 166                     + RestMessages.SERVICEUNAVAILABLE.toString());
 167         }
 168         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
 169             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
 170         }
 171         if (fields.size() > 0) {
 172             NeutronLoadBalancerHealthMonitor ans = loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 173             return Response.status(200).entity(
 174                     new NeutronLoadBalancerHealthMonitorRequest(extractFields(ans, fields))).build();
 175         } else {
 176             return Response.status(200).entity(new NeutronLoadBalancerHealthMonitorRequest(loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID))).build();
 177         }
 178     }
 179
 180     /**
 181      * Creates new LoadBalancerHealthMonitor */
 182
 183     @POST
 184     @Produces({ MediaType.APPLICATION_JSON })
 185     @Consumes({ MediaType.APPLICATION_JSON })
 186     @StatusCodes({
 187             @ResponseCode(code = 201, condition = "Created"),
 188             @ResponseCode(code = 400, condition = "Bad Request"),
 189             @ResponseCode(code = 401, condition = "Unauthorized"),
 190             @ResponseCode(code = 403, condition = "Forbidden"),
 191             @ResponseCode(code = 404, condition = "Not Found"),
 192             @ResponseCode(code = 409, condition = "Conflict"),
 193             @ResponseCode(code = 501, condition = "Not Implemented") })
 194     public Response createLoadBalancerHealthMonitors(final NeutronLoadBalancerHealthMonitorRequest input) {
 195         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
 196         if (loadBalancerHealthMonitorInterface == null) {
 197             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 198                     + RestMessages.SERVICEUNAVAILABLE.toString());
 199         }
 200         if (input.isSingleton()) {
 201             NeutronLoadBalancerHealthMonitor singleton = input.getSingleton();
 202
 203             /*
 204              *  Verify that the LoadBalancerHealthMonitor doesn't already exist.
 205              */
 206             if (loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(singleton.getLoadBalancerHealthMonitorID())) {
 207                 throw new BadRequestException("LoadBalancerHealthMonitor UUID already exists");
 208             }
 209             loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(singleton);
 210
 211             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 212             if (instances != null) {
 213                 if (instances.length > 0) {
 214                     for (Object instance : instances) {
 215                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 216                         int status = service.canCreateNeutronLoadBalancerHealthMonitor(singleton);
 217                         if (status < 200 || status > 299) {
 218                             return Response.status(status).build();
 219                         }
 220                     }
 221                 } else {
 222                     throw new ServiceUnavailableException("No providers registered.  Please try again later");
 223                 }
 224             } else {
 225                 throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 226             }
 227             loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(singleton);
 228             if (instances != null) {
 229                 for (Object instance : instances) {
 230                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 231                     service.neutronLoadBalancerHealthMonitorCreated(singleton);
 232                 }
 233             }
 234         } else {
 235             List<NeutronLoadBalancerHealthMonitor> bulk = input.getBulk();
 236             Iterator<NeutronLoadBalancerHealthMonitor> i = bulk.iterator();
 237             HashMap<String, NeutronLoadBalancerHealthMonitor> testMap = new HashMap<String, NeutronLoadBalancerHealthMonitor>();
 238             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 239             while (i.hasNext()) {
 240                 NeutronLoadBalancerHealthMonitor test = i.next();
 241
 242                 /*
 243                  *  Verify that the firewall policy doesn't already exist
 244                  */
 245
 246                 if (loadBalancerHealthMonitorInterface
 247                         .neutronLoadBalancerHealthMonitorExists(test.getLoadBalancerHealthMonitorID())) {
 248                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already is already created");
 249                 }
 250                 if (testMap.containsKey(test.getLoadBalancerHealthMonitorID())) {
 251                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already exists");
 252                 }
 253                 if (instances != null) {
 254                     if (instances.length > 0) {
 255                         for (Object instance : instances) {
 256                             INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 257                             int status = service.canCreateNeutronLoadBalancerHealthMonitor(test);
 258                             if (status < 200 || status > 299) {
 259                                 return Response.status(status).build();
 260                             }
 261                         }
 262                     } else {
 263                         throw new ServiceUnavailableException("No providers registered.  Please try again later");
 264                     }
 265                 } else {
 266                     throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 267                 }
 268             }
 269             /*
 270              * now, each element of the bulk request can be added to the cache
 271              */
 272             i = bulk.iterator();
 273             while (i.hasNext()) {
 274                 NeutronLoadBalancerHealthMonitor test = i.next();
 275                 loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(test);
 276                 if (instances != null) {
 277                     for (Object instance : instances) {
 278                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 279                         service.neutronLoadBalancerHealthMonitorCreated(test);
 280                     }
 281                 }
 282             }
 283         }
 284         return Response.status(201).entity(input).build();
 285     }
 286
 287     /**
 288      * Updates a LoadBalancerHealthMonitor Policy
 289      */
 290     @Path("{loadBalancerHealthMonitorID}")
 291     @PUT
 292     @Produces({ MediaType.APPLICATION_JSON })
 293     @Consumes({ MediaType.APPLICATION_JSON })
 294     @StatusCodes({
 295             @ResponseCode(code = 200, condition = "Operation successful"),
 296             @ResponseCode(code = 400, condition = "Bad Request"),
 297             @ResponseCode(code = 401, condition = "Unauthorized"),
 298             @ResponseCode(code = 403, condition = "Forbidden"),
 299             @ResponseCode(code = 404, condition = "Not Found"),
 300             @ResponseCode(code = 501, condition = "Not Implemented") })
 301     public Response updateLoadBalancerHealthMonitor(
 302             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID,
 303             final NeutronLoadBalancerHealthMonitorRequest input) {
 304         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces
 305                 .getINeutronLoadBalancerHealthMonitorCRUD(this);
 306         if (loadBalancerHealthMonitorInterface == null) {
 307             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 308                     + RestMessages.SERVICEUNAVAILABLE.toString());
 309         }
 310
 311         /*
 312          * verify the LoadBalancerHealthMonitor exists and there is only one delta provided
 313          */
 314         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
 315             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
 316         }
 317         if (!input.isSingleton()) {
 318             throw new BadRequestException("Only singleton edit supported");
 319         }
 320         NeutronLoadBalancerHealthMonitor delta = input.getSingleton();
 321         NeutronLoadBalancerHealthMonitor original = loadBalancerHealthMonitorInterface
 322                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 323
 324         /*
 325          * updates restricted by Neutron
 326          */
 327         if (delta.getLoadBalancerHealthMonitorID() != null ||
 328                 delta.getLoadBalancerHealthMonitorTenantID() != null ||
 329                 delta.getLoadBalancerHealthMonitorType() != null ||
 330                 delta.getLoadBalancerHealthMonitorDelay() != null ||
 331                 delta.getLoadBalancerHealthMonitorTimeout() != null ||
 332                 delta.getLoadBalancerHealthMonitorMaxRetries() != null ||
 333                 delta.getLoadBalancerHealthMonitorHttpMethod() != null ||
 334                 delta.getLoadBalancerHealthMonitorUrlPath() != null ||
 335                 delta.getLoadBalancerHealthMonitorExpectedCodes() != null ||
 336                 delta.getLoadBalancerHealthMonitorAdminStateIsUp() != null ||
 337                 delta.getLoadBalancerHealthMonitorStatus() != null) {
 338             throw new BadRequestException("Attribute edit blocked by Neutron");
 339         }
 340
 341         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 342         if (instances != null) {
 343             if (instances.length > 0) {
 344                 for (Object instance : instances) {
 345                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 346                     int status = service.canUpdateNeutronLoadBalancerHealthMonitor(delta, original);
 347                     if (status < 200 || status > 299) {
 348                         return Response.status(status).build();
 349                     }
 350                 }
 351             } else {
 352                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
 353             }
 354         } else {
 355             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 356         }
 357
 358         /*
 359          * update the object and return it
 360          */
 361         loadBalancerHealthMonitorInterface.updateNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID, delta);
 362         NeutronLoadBalancerHealthMonitor updatedLoadBalancerHealthMonitor = loadBalancerHealthMonitorInterface
 363                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 364         if (instances != null) {
 365             for (Object instance : instances) {
 366                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 367                 service.neutronLoadBalancerHealthMonitorUpdated(updatedLoadBalancerHealthMonitor);
 368             }
 369         }
 370         return Response.status(200).entity(new NeutronLoadBalancerHealthMonitorRequest
 371                 (loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor
 372                         (loadBalancerHealthMonitorID))).build();
 373     }
 374
 375
 376
 377     /**
 378      * Deletes a LoadBalancerHealthMonitor
 379      * */
 380     @Path("{loadBalancerHealthMonitorID}")
 381     @DELETE
 382     @StatusCodes({
 383             @ResponseCode(code = 204, condition = "No Content"),
 384             @ResponseCode(code = 401, condition = "Unauthorized"),
 385             @ResponseCode(code = 404, condition = "Not Found"),
 386             @ResponseCode(code = 409, condition = "Conflict"),
 387             @ResponseCode(code = 501, condition = "Not Implemented") })
 388     public Response deleteLoadBalancerHealthMonitor(
 389             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID) {
 390         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
 391         if (loadBalancerHealthMonitorInterface == null) {
 392             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 393                     + RestMessages.SERVICEUNAVAILABLE.toString());
 394         }
 395         /*
 396          * verify the LoadBalancerHealthMonitor exists and it isn't currently in use
 397          */
 398         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
 399             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
 400         }
 401         if (loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorInUse(loadBalancerHealthMonitorID)) {
 402             return Response.status(409).build();
 403         }
 404         NeutronLoadBalancerHealthMonitor singleton = loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 405         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 406         if (instances != null) {
 407             if (instances.length > 0) {
 408                 for (Object instance : instances) {
 409                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 410                     int status = service.canDeleteNeutronLoadBalancerHealthMonitor(singleton);
 411                     if (status < 200 || status > 299) {
 412                         return Response.status(status).build();
 413                     }
 414                 }
 415             } else {
 416                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
 417             }
 418         } else {
 419             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
 420         }
 421         loadBalancerHealthMonitorInterface.removeNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 422         if (instances != null) {
 423             for (Object instance : instances) {
 424                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 425                 service.neutronLoadBalancerHealthMonitorDeleted(singleton);
 426             }
 427         }
 428         return Response.status(204).build();
 429     }
 430 }