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