northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronLoadBalancerListenerNorthbound.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.INeutronLoadBalancerListenerCRUD;
  29 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
  30 import org.opendaylight.neutron.spi.NeutronLoadBalancerListener;
  31
  32 /**
  33  * Neutron Northbound REST APIs for LoadBalancerListener Policies.<br>
  34  * This class provides REST APIs for managing neutron LoadBalancerListener Policies
  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/listeners")
  50 public class NeutronLoadBalancerListenerNorthbound extends AbstractNeutronNorthbound<NeutronLoadBalancerListener,
  51         NeutronLoadBalancerListenerRequest, INeutronLoadBalancerListenerCRUD> {
  52
  53     private static final String RESOURCE_NAME = "LoadBalancerListener";
  54
  55     @Override
  56     protected String getResourceName() {
  57         return RESOURCE_NAME;
  58     }
  59
  60     @Override
  61     protected NeutronLoadBalancerListener extractFields(NeutronLoadBalancerListener o, List<String> fields) {
  62         return o.extractFields(fields);
  63     }
  64
  65     @Override
  66     protected NeutronLoadBalancerListenerRequest newNeutronRequest(NeutronLoadBalancerListener o) {
  67         return new NeutronLoadBalancerListenerRequest(o);
  68     }
  69
  70     @Override
  71     protected INeutronLoadBalancerListenerCRUD getNeutronCRUD() {
  72         NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronLoadBalancerListenerCRUD(this);
  73         if (answer.getLoadBalancerListenerInterface() == null) {
  74             throw new ServiceUnavailableException(serviceUnavailable());
  75         }
  76         return answer.getLoadBalancerListenerInterface();
  77     }
  78
  79     /**
  80      * Returns a list of all LoadBalancerListener */
  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 LoadBalancerListener attributes
  92             @QueryParam("id") String queryLoadBalancerListenerID,
  93             @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
  94             @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
  95             @QueryParam("name") String queryLoadBalancerListenerName,
  96             @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
  97             @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
  98             @QueryParam("admin_state_up") Boolean queryLoadBalancerListenerAdminIsUp,
  99             // pagination
 100             @QueryParam("limit") String limit,
 101             @QueryParam("marker") String marker,
 102             @QueryParam("page_reverse") String pageReverse
 103     // sorting not supported
 104     ) {
 105         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronCRUD();
 106         List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAll();
 107         List<NeutronLoadBalancerListener> ans = new ArrayList<>();
 108         Iterator<NeutronLoadBalancerListener> i = allLoadBalancerListeners.iterator();
 109         while (i.hasNext()) {
 110             NeutronLoadBalancerListener nsg = i.next();
 111             if ((queryLoadBalancerListenerID == null || queryLoadBalancerListenerID.equals(nsg.getID()))
 112                     && (queryLoadBalancerListenerDefaultPoolID == null || queryLoadBalancerListenerDefaultPoolID
 113                             .equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID()))
 114                     && (queryLoadBalancerListenerTenantID == null
 115                             || queryLoadBalancerListenerTenantID.equals(nsg.getTenantID()))
 116                     && (queryLoadBalancerListenerName == null
 117                             || queryLoadBalancerListenerName.equals(nsg.getLoadBalancerListenerName()))
 118                     && (queryLoadBalancerListenerProtocol == null
 119                             || queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol()))
 120                     && (queryLoadBalancerListenerProtocolPort == null || queryLoadBalancerListenerProtocolPort
 121                             .equals(nsg.getNeutronLoadBalancerListenerProtocolPort()))
 122                     && (queryLoadBalancerListenerAdminIsUp == null || queryLoadBalancerListenerAdminIsUp
 123                             .equals(nsg.getLoadBalancerListenerAdminStateIsUp()))) {
 124                 if (fields.size() > 0) {
 125                     ans.add(extractFields(nsg, fields));
 126                 } else {
 127                     ans.add(nsg);
 128                 }
 129             }
 130         }
 131         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerListenerRequest(ans)).build();
 132     }
 133
 134     /**
 135      * Returns a specific LoadBalancerListener */
 136
 137     @Path("{loadBalancerListenerID}")
 138     @GET
 139     @Produces({ MediaType.APPLICATION_JSON })
 140     @StatusCodes({ @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 showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
 146             // return fields
 147             @QueryParam("fields") List<String> fields) {
 148         return show(loadBalancerListenerID, fields);
 149     }
 150
 151     /**
 152      * Creates new LoadBalancerListener */
 153
 154     @POST
 155     @Produces({ MediaType.APPLICATION_JSON })
 156     @Consumes({ MediaType.APPLICATION_JSON })
 157     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 158             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 159     public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
 160         return create(input);
 161     }
 162
 163     /**
 164      * Updates a LoadBalancerListener Policy
 165      */
 166     @Path("{loadBalancerListenerID}")
 167     @PUT
 168     @Produces({ MediaType.APPLICATION_JSON })
 169     @Consumes({ MediaType.APPLICATION_JSON })
 170     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 171             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 172             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 173     public Response updateLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
 174             final NeutronLoadBalancerListenerRequest input) {
 175         return update(loadBalancerListenerID, input);
 176     }
 177
 178     /**
 179      * Deletes a LoadBalancerListener */
 180
 181     @Path("{loadBalancerListenerID}")
 182     @DELETE
 183     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 184             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 185             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 186     public Response deleteLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
 187         return delete(loadBalancerListenerID);
 188     }
 189 }