remove irrelevant old JavaDoc from a long bygone era in northbound.api
[neutron.git] / 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 package org.opendaylight.neutron.northbound.api;
9
10 import java.net.HttpURLConnection;
11 import java.util.ArrayList;
12 import java.util.List;
13 import javax.ws.rs.Consumes;
14 import javax.ws.rs.DELETE;
15 import javax.ws.rs.GET;
16 import javax.ws.rs.POST;
17 import javax.ws.rs.PUT;
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.INeutronLoadBalancerCRUD;
27 import org.opendaylight.neutron.spi.NeutronLoadBalancer;
28
29 /**
30  * Neutron Northbound REST APIs for LoadBalancers.<br>
31  */
32 @Path("/lbaas/loadbalancers")
33 public final class NeutronLoadBalancerNorthbound
34         extends AbstractNeutronNorthbound<NeutronLoadBalancer, NeutronLoadBalancerRequest, INeutronLoadBalancerCRUD> {
35
36     private static final String RESOURCE_NAME = "LoadBalancer";
37
38     @Override
39     protected String getResourceName() {
40         return RESOURCE_NAME;
41     }
42
43     /**
44      * Returns a list of all LoadBalancer.
45      */
46     @GET
47     @Produces({ MediaType.APPLICATION_JSON })
48     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
49             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
50             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
51             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
52     public Response listGroups(
53             // return fields
54             @QueryParam("fields") List<String> fields,
55             // OpenStack LoadBalancer attributes
56             @QueryParam("id") String queryLoadBalancerID,
57             @QueryParam("tenant_id") String queryLoadBalancerTenantID,
58             @QueryParam("name") String queryLoadBalancerName,
59             @QueryParam("status") String queryLoadBalancerStatus,
60             @QueryParam("vip_address") String queryLoadBalancerVipAddress,
61             @QueryParam("vip_subnet") String queryLoadBalancerVipSubnet,
62             // pagination
63             @QueryParam("limit") String limit,
64             @QueryParam("marker") String marker,
65             @QueryParam("page_reverse") String pageReverse
66     // sorting not supported
67     ) {
68         INeutronLoadBalancerCRUD loadBalancerInterface = getNeutronCRUD();
69         List<NeutronLoadBalancer> allLoadBalancers = loadBalancerInterface.getAll();
70         List<NeutronLoadBalancer> ans = new ArrayList<>();
71         for (NeutronLoadBalancer nsg : allLoadBalancers) {
72             if ((queryLoadBalancerID == null || queryLoadBalancerID.equals(nsg.getID()))
73                     && (queryLoadBalancerTenantID == null || queryLoadBalancerTenantID.equals(nsg.getTenantID()))
74                     && (queryLoadBalancerName == null || queryLoadBalancerName.equals(nsg.getName()))
75                     && (queryLoadBalancerVipAddress == null
76                             || queryLoadBalancerVipAddress.equals(nsg.getLoadBalancerVipAddress()))
77                     && (queryLoadBalancerVipSubnet == null
78                             || queryLoadBalancerVipSubnet.equals(nsg.getLoadBalancerVipSubnetID()))) {
79                 if (fields.size() > 0) {
80                     ans.add(nsg.extractFields(fields));
81                 } else {
82                     ans.add(nsg);
83                 }
84             }
85         }
86         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerRequest(ans)).build();
87     }
88
89     /**
90      * Returns a specific LoadBalancer.
91      */
92     @Path("{loadBalancerID}")
93     @GET
94     @Produces({ MediaType.APPLICATION_JSON })
95     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
96             @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
97             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
98             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
99             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
100     public Response showLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID,
101             // return fields
102             @QueryParam("fields") List<String> fields) {
103         return show(loadBalancerID, fields);
104     }
105
106     /**
107      * Creates new LoadBalancer.
108      */
109     @POST
110     @Produces({ MediaType.APPLICATION_JSON })
111     @Consumes({ MediaType.APPLICATION_JSON })
112     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
113             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
114     public Response createLoadBalancers(final NeutronLoadBalancerRequest input) {
115         return create(input);
116     }
117
118     /**
119      * Updates a LoadBalancer Policy.
120      */
121     @Path("{loadBalancerID}")
122     @PUT
123     @Produces({ MediaType.APPLICATION_JSON })
124     @Consumes({ MediaType.APPLICATION_JSON })
125     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
126             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
127             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
128     public Response updateLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID,
129             final NeutronLoadBalancerRequest input) {
130         return update(loadBalancerID, input);
131     }
132
133     /**
134      * Deletes a LoadBalancer.
135      */
136     @Path("{loadBalancerID}")
137     @DELETE
138     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
139             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
140             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
141     public Response deleteLoadBalancer(@PathParam("loadBalancerID") String loadBalancerID) {
142         return delete(loadBalancerID);
143     }
144 }