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({
  84             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  85             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  86             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  87             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  88
  89     public Response listGroups(
  90             // return fields
  91             @QueryParam("fields") List<String> fields,
  92             // OpenStack LoadBalancer attributes
  93             @QueryParam("id") String queryLoadBalancerID,
  94             @QueryParam("tenant_id") String queryLoadBalancerTenantID,
  95             @QueryParam("name") String queryLoadBalancerName,
  96             @QueryParam("status") String queryLoadBalancerStatus,
  97             @QueryParam("vip_address") String queryLoadBalancerVipAddress,
  98             @QueryParam("vip_subnet") String queryLoadBalancerVipSubnet,
  99             // pagination
 100             @QueryParam("limit") String limit,
 101             @QueryParam("marker") String marker,
 102             @QueryParam("page_reverse") String pageReverse
 103             // sorting not supported
 104     ) {
 105         INeutronLoadBalancerCRUD loadBalancerInterface = getNeutronCRUD();
 106         List<NeutronLoadBalancer> allLoadBalancers = loadBalancerInterface.getAll();
 107         List<NeutronLoadBalancer> ans = new ArrayList<NeutronLoadBalancer>();
 108         Iterator<NeutronLoadBalancer> i = allLoadBalancers.iterator();
 109         while (i.hasNext()) {
 110             NeutronLoadBalancer nsg = i.next();
 111             if ((queryLoadBalancerID == null ||
 112                     queryLoadBalancerID.equals(nsg.getID())) &&
 113                     (queryLoadBalancerTenantID == null ||
 114                             queryLoadBalancerTenantID.equals(nsg.getTenantID())) &&
 115                     (queryLoadBalancerName == null ||
 116                             queryLoadBalancerName.equals(nsg.getLoadBalancerName())) &&
 117                     (queryLoadBalancerVipAddress == null ||
 118                             queryLoadBalancerVipAddress.equals(nsg.getLoadBalancerVipAddress())) &&
 119                     (queryLoadBalancerVipSubnet == null ||
 120                             queryLoadBalancerVipSubnet.equals(nsg.getLoadBalancerVipSubnetID()))) {
 121                 if (fields.size() > 0) {
 122                     ans.add(extractFields(nsg,fields));
 123                 } else {
 124                     ans.add(nsg);
 125                 }
 126             }
 127         }
 128         return Response.status(HttpURLConnection.HTTP_OK).entity(
 129                 new NeutronLoadBalancerRequest(ans)).build();
 130     }
 131
 132     /**
 133      * Returns a specific LoadBalancer */
 134
 135     @Path("{loadBalancerID}")
 136     @GET
 137     @Produces({ MediaType.APPLICATION_JSON })
 138
 139     @StatusCodes({
 140             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 141             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 142             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 143             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 144             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 145     public Response showLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID,
 146             // return fields
 147             @QueryParam("fields") List<String> fields) {
 148         return show(loadBalancerID, fields);
 149     }
 150
 151     /**
 152      * Creates new LoadBalancer */
 153
 154     @POST
 155     @Produces({ MediaType.APPLICATION_JSON })
 156     @Consumes({ MediaType.APPLICATION_JSON })
 157
 158     @StatusCodes({
 159             @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 160             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 161     public Response createLoadBalancers(final NeutronLoadBalancerRequest input) {
 162         return create(input);
 163     }
 164
 165     /**
 166      * Updates a LoadBalancer Policy
 167      */
 168     @Path("{loadBalancerID}")
 169     @PUT
 170     @Produces({ MediaType.APPLICATION_JSON })
 171     @Consumes({ MediaType.APPLICATION_JSON })
 172
 173     @StatusCodes({
 174             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 175             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 176             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 177     public Response updateLoadBalancer(
 178             @PathParam("loadBalancerID") String loadBalancerID, final NeutronLoadBalancerRequest input) {
 179         return update(loadBalancerID, input);
 180     }
 181
 182     /**
 183      * Deletes a LoadBalancer */
 184
 185     @Path("{loadBalancerID}")
 186     @DELETE
 187     @StatusCodes({
 188             @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 189             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 190             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 191     public Response deleteLoadBalancer(
 192             @PathParam("loadBalancerID") String loadBalancerID) {
 193         return delete(loadBalancerID);
 194     }
 195 }