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

   1 /*
   2  * Copyright (c) 2015 IBM Corporation 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.Path;
  19 import javax.ws.rs.PathParam;
  20 import javax.ws.rs.Produces;
  21 import javax.ws.rs.QueryParam;
  22 import javax.ws.rs.core.MediaType;
  23 import javax.ws.rs.core.Response;
  24 import org.codehaus.enunciate.jaxrs.ResponseCode;
  25 import org.codehaus.enunciate.jaxrs.StatusCodes;
  26 import org.opendaylight.neutron.spi.INeutronMeteringLabelCRUD;
  27 import org.opendaylight.neutron.spi.NeutronMeteringLabel;
  28
  29 /**
  30  * Neutron Northbound REST APIs for Metering Lables.<br>
  31  * This class provides REST APIs for managing neutron metering labels
  32  *
  33  * <br>
  34  * <br>
  35  * Authentication scheme : <b>HTTP Basic</b><br>
  36  * Authentication realm : <b>opendaylight</b><br>
  37  * Transport : <b>HTTP and HTTPS</b><br>
  38  * <br>
  39  * HTTPS Authentication is disabled by default. Administrator can enable it in
  40  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  41  * trusted authority.<br>
  42  * More info :
  43  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  44  *
  45  */
  46
  47 @Path("/metering/metering-labels")
  48 public final class NeutronMeteringLabelsNorthbound extends
  49         AbstractNeutronNorthbound<NeutronMeteringLabel, NeutronMeteringLabelRequest, INeutronMeteringLabelCRUD> {
  50     private static final String RESOURCE_NAME = "Metering Label";
  51
  52     @Override
  53     protected String getResourceName() {
  54         return RESOURCE_NAME;
  55     }
  56
  57     /**
  58      * Returns a list of all metering labels.
  59      */
  60
  61     @GET
  62     @Produces({ MediaType.APPLICATION_JSON })
  63     //@TypeHint(OpenStackNetworks.class)
  64     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
  65             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
  66             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
  67             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
  68     public Response listMeteringLabels(
  69             // return fields
  70             @QueryParam("fields") List<String> fields,
  71             // filter fields
  72             @QueryParam("id") String queryID,
  73             @QueryParam("name") String queryName,
  74             @QueryParam("tenant_id") String queryTenantID
  75     // pagination and sorting are TODO
  76     ) {
  77         INeutronMeteringLabelCRUD labelInterface = getNeutronCRUD();
  78         List<NeutronMeteringLabel> allNeutronMeteringLabel = labelInterface.getAll();
  79         List<NeutronMeteringLabel> ans = new ArrayList<>();
  80         for (NeutronMeteringLabel label : allNeutronMeteringLabel) {
  81             if ((queryID == null || queryID.equals(label.getID()))
  82                     && (queryName == null || queryName.equals(label.getName()))
  83                     && (queryTenantID == null || queryTenantID.equals(label.getTenantID()))) {
  84                 if (fields.size() > 0) {
  85                     ans.add(label.extractFields(fields));
  86                 } else {
  87                     ans.add(label);
  88                 }
  89             }
  90         }
  91         //TODO: apply pagination to results
  92         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronMeteringLabelRequest(ans)).build();
  93     }
  94
  95     /**
  96      * Returns a specific metering label.
  97      */
  98
  99     @Path("{labelUUID}")
 100     @GET
 101     @Produces({ MediaType.APPLICATION_JSON })
 102     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
 103             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
 104             @ResponseCode(code = HttpURLConnection.HTTP_FORBIDDEN, condition = "Forbidden"),
 105             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 106             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
 107             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 108     public Response showMeteringLabel(@PathParam("labelUUID") String labelUUID,
 109             // return fields
 110             @QueryParam("fields") List<String> fields) {
 111         return show(labelUUID, fields);
 112     }
 113
 114     /**
 115      * Creates new metering label.
 116      */
 117     @POST
 118     @Produces({ MediaType.APPLICATION_JSON })
 119     @Consumes({ MediaType.APPLICATION_JSON })
 120     //@TypeHint(NeutronNetwork.class)
 121     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
 122             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 123     public Response createMeteringLabel(final NeutronMeteringLabelRequest input) {
 124         return create(input);
 125     }
 126
 127     /**
 128      * Deletes a Metering Label.
 129      */
 130
 131     @Path("{labelUUID}")
 132     @DELETE
 133     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
 134             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
 135             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
 136     public Response deleteMeteringLabel(@PathParam("labelUUID") String labelUUID) {
 137         return delete(labelUUID);
 138     }
 139 }