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
  13 import java.util.ArrayList;
  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.neutron.spi.INeutronLoadBalancerListenerCRUD;
  32 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
  33 import org.opendaylight.neutron.spi.NeutronLoadBalancerListener;
  34
  35 /**
  36  * Neutron Northbound REST APIs for LoadBalancerListener Policies.<br>
  37  * This class provides REST APIs for managing neutron LoadBalancerListener Policies
  38  *
  39  * <br>
  40  * <br>
  41  * Authentication scheme : <b>HTTP Basic</b><br>
  42  * Authentication realm : <b>opendaylight</b><br>
  43  * Transport : <b>HTTP and HTTPS</b><br>
  44  * <br>
  45  * HTTPS Authentication is disabled by default. Administrator can enable it in
  46  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  47  * trusted authority.<br>
  48  * More info :
  49  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  50  *
  51  */
  52 @Path("/lbaas/listeners")
  53 public class NeutronLoadBalancerListenerNorthbound
  54     extends AbstractNeutronNorthbound<NeutronLoadBalancerListener, NeutronLoadBalancerListenerRequest, INeutronLoadBalancerListenerCRUD> {
  55
  56     private static final String RESOURCE_NAME = "LoadBalancerListener";
  57
  58     @Override
  59     protected String getResourceName() {
  60         return RESOURCE_NAME;
  61     }
  62
  63     @Override
  64     protected NeutronLoadBalancerListener extractFields(NeutronLoadBalancerListener o, List<String> fields) {
  65         return o.extractFields(fields);
  66     }
  67
  68     @Override
  69     protected NeutronLoadBalancerListenerRequest newNeutronRequest(NeutronLoadBalancerListener o) {
  70         return new NeutronLoadBalancerListenerRequest(o);
  71     }
  72
  73     @Override
  74     protected INeutronLoadBalancerListenerCRUD getNeutronCRUD() {
  75         NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronLoadBalancerListenerCRUD(this);
  76         if (answer.getLoadBalancerListenerInterface() == null) {
  77             throw new ServiceUnavailableException(serviceUnavailable());
  78         }
  79         return answer.getLoadBalancerListenerInterface();
  80     }
  81
  82     /**
  83      * Returns a list of all LoadBalancerListener */
  84     @GET
  85     @Produces({ MediaType.APPLICATION_JSON })
  86     @StatusCodes({
  87             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  88             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  89             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  90             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  91
  92     public Response listGroups(
  93             // return fields
  94             @QueryParam("fields") List<String> fields,
  95             // OpenStack LoadBalancerListener attributes
  96             @QueryParam("id") String queryLoadBalancerListenerID,
  97             @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
  98             @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
  99             @QueryParam("name") String queryLoadBalancerListenerName,
 100             @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
 101             @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
 102             @QueryParam("admin_state_up") Boolean queryLoadBalancerListenerAdminIsUp,
 103             // pagination
 104             @QueryParam("limit") String limit,
 105             @QueryParam("marker") String marker,
 106             @QueryParam("page_reverse") String pageReverse
 107             // sorting not supported
 108     ) {
 109         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronCRUD();
 110         List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAll();
 111         List<NeutronLoadBalancerListener> ans = new ArrayList<NeutronLoadBalancerListener>();
 112         Iterator<NeutronLoadBalancerListener> i = allLoadBalancerListeners.iterator();
 113         while (i.hasNext()) {
 114             NeutronLoadBalancerListener nsg = i.next();
 115             if ((queryLoadBalancerListenerID == null ||
 116                     queryLoadBalancerListenerID.equals(nsg.getID())) &&
 117                     (queryLoadBalancerListenerDefaultPoolID == null ||
 118                             queryLoadBalancerListenerDefaultPoolID.equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID())) &&
 119                     (queryLoadBalancerListenerTenantID == null ||
 120                             queryLoadBalancerListenerTenantID.equals(nsg.getTenantID())) &&
 121                     (queryLoadBalancerListenerName == null ||
 122                             queryLoadBalancerListenerName.equals(nsg.getLoadBalancerListenerName())) &&
 123                     (queryLoadBalancerListenerProtocol == null ||
 124                             queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol())) &&
 125                     (queryLoadBalancerListenerProtocolPort == null ||
 126                             queryLoadBalancerListenerProtocolPort.equals(nsg.getNeutronLoadBalancerListenerProtocolPort())) &&
 127                     (queryLoadBalancerListenerAdminIsUp == null ||
 128                             queryLoadBalancerListenerAdminIsUp.equals(nsg.getLoadBalancerListenerAdminStateIsUp()))) {
 129                 if (fields.size() > 0) {
 130                     ans.add(extractFields(nsg,fields));
 131                 } else {
 132                     ans.add(nsg);
 133                 }
 134             }
 135         }
 136         return Response.status(HttpURLConnection.HTTP_OK).entity(
 137                 new NeutronLoadBalancerListenerRequest(ans)).build();
 138     }
 139
 140     /**
 141      * Returns a specific LoadBalancerListener */
 142
 143     @Path("{loadBalancerListenerID}")
 144     @GET
 145     @Produces({ MediaType.APPLICATION_JSON })
 146     @StatusCodes({
 147             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 148             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 149             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 150             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 151             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 152     public Response showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
 153             // return fields
 154             @QueryParam("fields") List<String> fields) {
 155         return show(loadBalancerListenerID, fields);
 156     }
 157
 158     /**
 159      * Creates new LoadBalancerListener */
 160
 161     @POST
 162     @Produces({ MediaType.APPLICATION_JSON })
 163     @Consumes({ MediaType.APPLICATION_JSON })
 164     @StatusCodes({
 165             @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 166             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 167     public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
 168         return create(input);
 169     }
 170
 171     /**
 172      * Updates a LoadBalancerListener Policy
 173      */
 174     @Path("{loadBalancerListenerID}")
 175     @PUT
 176     @Produces({ MediaType.APPLICATION_JSON })
 177     @Consumes({ MediaType.APPLICATION_JSON })
 178     @StatusCodes({
 179             @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 180             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 181             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 182     public Response updateLoadBalancerListener(
 183             @PathParam("loadBalancerListenerID") String loadBalancerListenerID, final NeutronLoadBalancerListenerRequest input) {
 184         return update(loadBalancerListenerID, input);
 185     }
 186
 187     /**
 188      * Deletes a LoadBalancerListener */
 189
 190     @Path("{loadBalancerListenerID}")
 191     @DELETE
 192     @StatusCodes({
 193             @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 194             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 195             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 196     public Response deleteLoadBalancerListener(
 197             @PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
 198         return delete(loadBalancerListenerID);
 199     }
 200 }