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                 for (Object instance : instances) {
 214                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 215                     int status = service.canCreateNeutronLoadBalancerHealthMonitor(singleton);
 216                     if (status < 200 || status > 299) {
 217                         return Response.status(status).build();
 218                     }
 219                 }
 220             }
 221             loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(singleton);
 222             if (instances != null) {
 223                 for (Object instance : instances) {
 224                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 225                     service.neutronLoadBalancerHealthMonitorCreated(singleton);
 226                 }
 227             }
 228         } else {
 229             List<NeutronLoadBalancerHealthMonitor> bulk = input.getBulk();
 230             Iterator<NeutronLoadBalancerHealthMonitor> i = bulk.iterator();
 231             HashMap<String, NeutronLoadBalancerHealthMonitor> testMap = new HashMap<String, NeutronLoadBalancerHealthMonitor>();
 232             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 233             while (i.hasNext()) {
 234                 NeutronLoadBalancerHealthMonitor test = i.next();
 235
 236                 /*
 237                  *  Verify that the firewall policy doesn't already exist
 238                  */
 239
 240                 if (loadBalancerHealthMonitorInterface
 241                         .neutronLoadBalancerHealthMonitorExists(test.getLoadBalancerHealthMonitorID())) {
 242                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already is already created");
 243                 }
 244                 if (testMap.containsKey(test.getLoadBalancerHealthMonitorID())) {
 245                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already exists");
 246                 }
 247                 if (instances != null) {
 248                     for (Object instance : instances) {
 249                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 250                         int status = service.canCreateNeutronLoadBalancerHealthMonitor(test);
 251                         if (status < 200 || status > 299) {
 252                             return Response.status(status).build();
 253                         }
 254                     }
 255                 }
 256             }
 257             /*
 258              * now, each element of the bulk request can be added to the cache
 259              */
 260             i = bulk.iterator();
 261             while (i.hasNext()) {
 262                 NeutronLoadBalancerHealthMonitor test = i.next();
 263                 loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(test);
 264                 if (instances != null) {
 265                     for (Object instance : instances) {
 266                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 267                         service.neutronLoadBalancerHealthMonitorCreated(test);
 268                     }
 269                 }
 270             }
 271         }
 272         return Response.status(201).entity(input).build();
 273     }
 274
 275     /**
 276      * Updates a LoadBalancerHealthMonitor Policy
 277      */
 278     @Path("{loadBalancerHealthMonitorID}")
 279     @PUT
 280     @Produces({ MediaType.APPLICATION_JSON })
 281     @Consumes({ MediaType.APPLICATION_JSON })
 282     @StatusCodes({
 283             @ResponseCode(code = 200, condition = "Operation successful"),
 284             @ResponseCode(code = 400, condition = "Bad Request"),
 285             @ResponseCode(code = 401, condition = "Unauthorized"),
 286             @ResponseCode(code = 403, condition = "Forbidden"),
 287             @ResponseCode(code = 404, condition = "Not Found"),
 288             @ResponseCode(code = 501, condition = "Not Implemented") })
 289     public Response updateLoadBalancerHealthMonitor(
 290             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID,
 291             final NeutronLoadBalancerHealthMonitorRequest input) {
 292         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces
 293                 .getINeutronLoadBalancerHealthMonitorCRUD(this);
 294         if (loadBalancerHealthMonitorInterface == null) {
 295             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 296                     + RestMessages.SERVICEUNAVAILABLE.toString());
 297         }
 298
 299         /*
 300          * verify the LoadBalancerHealthMonitor exists and there is only one delta provided
 301          */
 302         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
 303             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
 304         }
 305         if (!input.isSingleton()) {
 306             throw new BadRequestException("Only singleton edit supported");
 307         }
 308         NeutronLoadBalancerHealthMonitor delta = input.getSingleton();
 309         NeutronLoadBalancerHealthMonitor original = loadBalancerHealthMonitorInterface
 310                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 311
 312         /*
 313          * updates restricted by Neutron
 314          */
 315         if (delta.getLoadBalancerHealthMonitorID() != null ||
 316                 delta.getLoadBalancerHealthMonitorTenantID() != null ||
 317                 delta.getLoadBalancerHealthMonitorType() != null ||
 318                 delta.getLoadBalancerHealthMonitorDelay() != null ||
 319                 delta.getLoadBalancerHealthMonitorTimeout() != null ||
 320                 delta.getLoadBalancerHealthMonitorMaxRetries() != null ||
 321                 delta.getLoadBalancerHealthMonitorHttpMethod() != null ||
 322                 delta.getLoadBalancerHealthMonitorUrlPath() != null ||
 323                 delta.getLoadBalancerHealthMonitorExpectedCodes() != null ||
 324                 delta.getLoadBalancerHealthMonitorAdminStateIsUp() != null ||
 325                 delta.getLoadBalancerHealthMonitorStatus() != null) {
 326             throw new BadRequestException("Attribute edit blocked by Neutron");
 327         }
 328
 329         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 330         if (instances != null) {
 331             for (Object instance : instances) {
 332                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 333                 int status = service.canUpdateNeutronLoadBalancerHealthMonitor(delta, original);
 334                 if (status < 200 || status > 299) {
 335                     return Response.status(status).build();
 336                 }
 337             }
 338         }
 339
 340         /*
 341          * update the object and return it
 342          */
 343         loadBalancerHealthMonitorInterface.updateNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID, delta);
 344         NeutronLoadBalancerHealthMonitor updatedLoadBalancerHealthMonitor = loadBalancerHealthMonitorInterface
 345                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 346         if (instances != null) {
 347             for (Object instance : instances) {
 348                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 349                 service.neutronLoadBalancerHealthMonitorUpdated(updatedLoadBalancerHealthMonitor);
 350             }
 351         }
 352         return Response.status(200).entity(new NeutronLoadBalancerHealthMonitorRequest
 353                 (loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor
 354                         (loadBalancerHealthMonitorID))).build();
 355     }
 356
 357
 358
 359     /**
 360      * Deletes a LoadBalancerHealthMonitor
 361      * */
 362     @Path("{loadBalancerHealthMonitorID}")
 363     @DELETE
 364     @StatusCodes({
 365             @ResponseCode(code = 204, condition = "No Content"),
 366             @ResponseCode(code = 401, condition = "Unauthorized"),
 367             @ResponseCode(code = 404, condition = "Not Found"),
 368             @ResponseCode(code = 409, condition = "Conflict"),
 369             @ResponseCode(code = 501, condition = "Not Implemented") })
 370     public Response deleteLoadBalancerHealthMonitor(
 371             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID) {
 372         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
 373         if (loadBalancerHealthMonitorInterface == null) {
 374             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
 375                     + RestMessages.SERVICEUNAVAILABLE.toString());
 376         }
 377         /*
 378          * verify the LoadBalancerHealthMonitor exists and it isn't currently in use
 379          */
 380         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
 381             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
 382         }
 383         if (loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorInUse(loadBalancerHealthMonitorID)) {
 384             return Response.status(409).build();
 385         }
 386         NeutronLoadBalancerHealthMonitor singleton = loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 387         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
 388         if (instances != null) {
 389             for (Object instance : instances) {
 390                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 391                 int status = service.canDeleteNeutronLoadBalancerHealthMonitor(singleton);
 392                 if (status < 200 || status > 299) {
 393                     return Response.status(status).build();
 394                 }
 395             }
 396         }
 397         loadBalancerHealthMonitorInterface.removeNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
 398         if (instances != null) {
 399             for (Object instance : instances) {
 400                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
 401                 service.neutronLoadBalancerHealthMonitorDeleted(singleton);
 402             }
 403         }
 404         return Response.status(204).build();
 405     }
 406 }