northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronLoadBalancerNorthbound.java

   1 /*
   2  * Copyright (c) 2014, 2015 Red Hat, Inc. and others.  All rights reserved.
   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.neutron.northbound.api;
  10
  11 import java.net.HttpURLConnection;
  12 import java.util.ArrayList;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import javax.ws.rs.Consumes;
  16 import javax.ws.rs.DELETE;
  17 import javax.ws.rs.GET;
  18 import javax.ws.rs.POST;
  19 import javax.ws.rs.PUT;
  20 import javax.ws.rs.Path;
  21 import javax.ws.rs.PathParam;
  22 import javax.ws.rs.Produces;
  23 import javax.ws.rs.QueryParam;
  24 import javax.ws.rs.core.MediaType;
  25 import javax.ws.rs.core.Response;
  26 import org.codehaus.enunciate.jaxrs.ResponseCode;
  27 import org.codehaus.enunciate.jaxrs.StatusCodes;
  28 import org.opendaylight.neutron.spi.INeutronLoadBalancerCRUD;
  29 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
  30 import org.opendaylight.neutron.spi.NeutronLoadBalancer;
  31
  32 /**
  33  * Neutron Northbound REST APIs for LoadBalancers.<br>
  34  * This class provides REST APIs for managing neutron LoadBalancers
  35  *
  36  * <br>
  37  * <br>
  38  * Authentication scheme : <b>HTTP Basic</b><br>
  39  * Authentication realm : <b>opendaylight</b><br>
  40  * Transport : <b>HTTP and HTTPS</b><br>
  41  * <br>
  42  * HTTPS Authentication is disabled by default. Administrator can enable it in
  43  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  44  * trusted authority.<br>
  45  * More info :
  46  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  47  *
  48  */
  49 @Path("/lbaas/loadbalancers")
  50 public class NeutronLoadBalancerNorthbound
  51         extends AbstractNeutronNorthbound<NeutronLoadBalancer, NeutronLoadBalancerRequest, INeutronLoadBalancerCRUD> {
  52
  53     private static final String RESOURCE_NAME = "LoadBalancer";
  54
  55     @Override
  56     protected String getResourceName() {
  57         return RESOURCE_NAME;
  58     }
  59
  60     @Override
  61     protected NeutronLoadBalancer extractFields(NeutronLoadBalancer o, List<String> fields) {
  62         return o.extractFields(fields);
  63     }
  64
  65     @Override
  66     protected NeutronLoadBalancerRequest newNeutronRequest(NeutronLoadBalancer o) {
  67         return new NeutronLoadBalancerRequest(o);
  68     }
  69
  70     @Override
  71     protected INeutronLoadBalancerCRUD getNeutronCRUD() {
  72         NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronLoadBalancerCRUD(this);
  73         if (answer.getLoadBalancerInterface() == null) {
  74             throw new ServiceUnavailableException(serviceUnavailable());
  75         }
  76         return answer.getLoadBalancerInterface();
  77     }
  78
  79     /**
  80      * Returns a list of all LoadBalancer */
  81     @GET
  82     @Produces({ MediaType.APPLICATION_JSON })
  83     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  84             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  85             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  86             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  87
  88     public Response listGroups(
  89             // return fields
  90             @QueryParam("fields") List<String> fields,
  91             // OpenStack LoadBalancer attributes
  92             @QueryParam("id") String queryLoadBalancerID,
  93             @QueryParam("tenant_id") String queryLoadBalancerTenantID,
  94             @QueryParam("name") String queryLoadBalancerName,
  95             @QueryParam("status") String queryLoadBalancerStatus,
  96             @QueryParam("vip_address") String queryLoadBalancerVipAddress,
  97             @QueryParam("vip_subnet") String queryLoadBalancerVipSubnet,
  98             // pagination
  99             @QueryParam("limit") String limit,
 100             @QueryParam("marker") String marker,
 101             @QueryParam("page_reverse") String pageReverse
 102     // sorting not supported
 103     ) {
 104         INeutronLoadBalancerCRUD loadBalancerInterface = getNeutronCRUD();
 105         List<NeutronLoadBalancer> allLoadBalancers = loadBalancerInterface.getAll();
 106         List<NeutronLoadBalancer> ans = new ArrayList<>();
 107         Iterator<NeutronLoadBalancer> i = allLoadBalancers.iterator();
 108         while (i.hasNext()) {
 109             NeutronLoadBalancer nsg = i.next();
 110             if ((queryLoadBalancerID == null || queryLoadBalancerID.equals(nsg.getID()))
 111                     && (queryLoadBalancerTenantID == null || queryLoadBalancerTenantID.equals(nsg.getTenantID()))
 112                     && (queryLoadBalancerName == null || queryLoadBalancerName.equals(nsg.getLoadBalancerName()))
 113                     && (queryLoadBalancerVipAddress == null
 114                             || queryLoadBalancerVipAddress.equals(nsg.getLoadBalancerVipAddress()))
 115                     && (queryLoadBalancerVipSubnet == null
 116                             || queryLoadBalancerVipSubnet.equals(nsg.getLoadBalancerVipSubnetID()))) {
 117                 if (fields.size() > 0) {
 118                     ans.add(extractFields(nsg, fields));
 119                 } else {
 120                     ans.add(nsg);
 121                 }
 122             }
 123         }
 124         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerRequest(ans)).build();
 125     }
 126
 127     /**
 128      * Returns a specific LoadBalancer */
 129
 130     @Path("{loadBalancerID}")
 131     @GET
 132     @Produces({ MediaType.APPLICATION_JSON })
 133
 134     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 135             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 136             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 137             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 138             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 139     public Response showLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID,
 140             // return fields
 141             @QueryParam("fields") List<String> fields) {
 142         return show(loadBalancerID, fields);
 143     }
 144
 145     /**
 146      * Creates new LoadBalancer */
 147
 148     @POST
 149     @Produces({ MediaType.APPLICATION_JSON })
 150     @Consumes({ MediaType.APPLICATION_JSON })
 151
 152     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 153             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 154     public Response createLoadBalancers(final NeutronLoadBalancerRequest input) {
 155         return create(input);
 156     }
 157
 158     /**
 159      * Updates a LoadBalancer Policy
 160      */
 161     @Path("{loadBalancerID}")
 162     @PUT
 163     @Produces({ MediaType.APPLICATION_JSON })
 164     @Consumes({ MediaType.APPLICATION_JSON })
 165
 166     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 167             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 168             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 169     public Response updateLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID,
 170             final NeutronLoadBalancerRequest input) {
 171         return update(loadBalancerID, input);
 172     }
 173
 174     /**
 175      * Deletes a LoadBalancer */
 176
 177     @Path("{loadBalancerID}")
 178     @DELETE
 179     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 180             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 181             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 182     public Response deleteLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID) {
 183         return delete(loadBalancerID);
 184     }
 185 }