remove irrelevant old JavaDoc from a long bygone era in northbound.api
[neutron.git] / 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 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.INeutronLoadBalancerListenerCRUD;
27 import org.opendaylight.neutron.spi.NeutronLoadBalancerListener;
28
29 /**
30  * Neutron Northbound REST APIs for LoadBalancerListener Policies.
31  */
32 @Path("/lbaas/listeners")
33 public final class NeutronLoadBalancerListenerNorthbound extends AbstractNeutronNorthbound<NeutronLoadBalancerListener,
34         NeutronLoadBalancerListenerRequest, INeutronLoadBalancerListenerCRUD> {
35
36     private static final String RESOURCE_NAME = "LoadBalancerListener";
37
38     @Override
39     protected String getResourceName() {
40         return RESOURCE_NAME;
41     }
42
43     /**
44      * Returns a list of all LoadBalancerListener.
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 LoadBalancerListener attributes
56             @QueryParam("id") String queryLoadBalancerListenerID,
57             @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
58             @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
59             @QueryParam("name") String queryLoadBalancerListenerName,
60             @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
61             @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
62             @QueryParam("admin_state_up") Boolean queryLoadBalancerListenerAdminIsUp,
63             // pagination
64             @QueryParam("limit") String limit,
65             @QueryParam("marker") String marker,
66             @QueryParam("page_reverse") String pageReverse
67     // sorting not supported
68     ) {
69         INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronCRUD();
70         List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAll();
71         List<NeutronLoadBalancerListener> ans = new ArrayList<>();
72         for (NeutronLoadBalancerListener nsg : allLoadBalancerListeners) {
73             if ((queryLoadBalancerListenerID == null || queryLoadBalancerListenerID.equals(nsg.getID()))
74                     && (queryLoadBalancerListenerDefaultPoolID == null || queryLoadBalancerListenerDefaultPoolID
75                             .equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID()))
76                     && (queryLoadBalancerListenerTenantID == null
77                             || queryLoadBalancerListenerTenantID.equals(nsg.getTenantID()))
78                     && (queryLoadBalancerListenerName == null
79                             || queryLoadBalancerListenerName.equals(nsg.getName()))
80                     && (queryLoadBalancerListenerProtocol == null
81                             || queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol()))
82                     && (queryLoadBalancerListenerProtocolPort == null || queryLoadBalancerListenerProtocolPort
83                             .equals(nsg.getNeutronLoadBalancerListenerProtocolPort()))
84                     && (queryLoadBalancerListenerAdminIsUp == null || queryLoadBalancerListenerAdminIsUp
85                             .equals(nsg.getLoadBalancerListenerAdminStateIsUp()))) {
86                 if (fields.size() > 0) {
87                     ans.add(nsg.extractFields(fields));
88                 } else {
89                     ans.add(nsg);
90                 }
91             }
92         }
93         return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerListenerRequest(ans)).build();
94     }
95
96     /**
97      * Returns a specific LoadBalancerListener.
98      */
99     @Path("{loadBalancerListenerID}")
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_NOT_FOUND, condition = "Not Found"),
105             @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
106             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
107     public Response showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
108             // return fields
109             @QueryParam("fields") List<String> fields) {
110         return show(loadBalancerListenerID, fields);
111     }
112
113     /**
114      * Creates new LoadBalancerListener.
115      */
116     @POST
117     @Produces({ MediaType.APPLICATION_JSON })
118     @Consumes({ MediaType.APPLICATION_JSON })
119     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
120             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
121     public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
122         return create(input);
123     }
124
125     /**
126      * Updates a LoadBalancerListener Policy.
127      */
128     @Path("{loadBalancerListenerID}")
129     @PUT
130     @Produces({ MediaType.APPLICATION_JSON })
131     @Consumes({ MediaType.APPLICATION_JSON })
132     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
133             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
134             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
135     public Response updateLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
136             final NeutronLoadBalancerListenerRequest input) {
137         return update(loadBalancerListenerID, input);
138     }
139
140     /**
141      * Deletes a LoadBalancerListener.
142      */
143     @Path("{loadBalancerListenerID}")
144     @DELETE
145     @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
146             @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
147             @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
148     public Response deleteLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
149         return delete(loadBalancerListenerID);
150     }
151 }