2 * Copyright (c) 2014, 2015 Red Hat, Inc. and others. All rights reserved.
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
9 package org.opendaylight.neutron.northbound.api;
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.PUT;
19 import javax.ws.rs.Path;
20 import javax.ws.rs.PathParam;
21 import javax.ws.rs.Produces;
22 import javax.ws.rs.QueryParam;
23 import javax.ws.rs.core.MediaType;
24 import javax.ws.rs.core.Response;
25 import org.codehaus.enunciate.jaxrs.ResponseCode;
26 import org.codehaus.enunciate.jaxrs.StatusCodes;
27 import org.opendaylight.neutron.spi.INeutronLoadBalancerListenerCRUD;
28 import org.opendaylight.neutron.spi.NeutronLoadBalancerListener;
31 * Neutron Northbound REST APIs for LoadBalancerListener Policies.<br>
32 * This class provides REST APIs for managing neutron LoadBalancerListener Policies
36 * Authentication scheme : <b>HTTP Basic</b><br>
37 * Authentication realm : <b>opendaylight</b><br>
38 * Transport : <b>HTTP and HTTPS</b><br>
40 * HTTPS Authentication is disabled by default. Administrator can enable it in
41 * tomcat-server.xml after adding a proper keystore / SSL certificate from a
42 * trusted authority.<br>
44 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
47 @Path("/lbaas/listeners")
48 public final class NeutronLoadBalancerListenerNorthbound extends AbstractNeutronNorthbound<NeutronLoadBalancerListener,
49 NeutronLoadBalancerListenerRequest, INeutronLoadBalancerListenerCRUD> {
51 private static final String RESOURCE_NAME = "LoadBalancerListener";
54 protected String getResourceName() {
59 * Returns a list of all LoadBalancerListener.
62 @Produces({ MediaType.APPLICATION_JSON })
63 @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
64 @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
65 @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
66 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
68 public Response listGroups(
70 @QueryParam("fields") List<String> fields,
71 // OpenStack LoadBalancerListener attributes
72 @QueryParam("id") String queryLoadBalancerListenerID,
73 @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
74 @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
75 @QueryParam("name") String queryLoadBalancerListenerName,
76 @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
77 @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
78 @QueryParam("admin_state_up") Boolean queryLoadBalancerListenerAdminIsUp,
80 @QueryParam("limit") String limit,
81 @QueryParam("marker") String marker,
82 @QueryParam("page_reverse") String pageReverse
83 // sorting not supported
85 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronCRUD();
86 List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAll();
87 List<NeutronLoadBalancerListener> ans = new ArrayList<>();
88 for (NeutronLoadBalancerListener nsg : allLoadBalancerListeners) {
89 if ((queryLoadBalancerListenerID == null || queryLoadBalancerListenerID.equals(nsg.getID()))
90 && (queryLoadBalancerListenerDefaultPoolID == null || queryLoadBalancerListenerDefaultPoolID
91 .equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID()))
92 && (queryLoadBalancerListenerTenantID == null
93 || queryLoadBalancerListenerTenantID.equals(nsg.getTenantID()))
94 && (queryLoadBalancerListenerName == null
95 || queryLoadBalancerListenerName.equals(nsg.getName()))
96 && (queryLoadBalancerListenerProtocol == null
97 || queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol()))
98 && (queryLoadBalancerListenerProtocolPort == null || queryLoadBalancerListenerProtocolPort
99 .equals(nsg.getNeutronLoadBalancerListenerProtocolPort()))
100 && (queryLoadBalancerListenerAdminIsUp == null || queryLoadBalancerListenerAdminIsUp
101 .equals(nsg.getLoadBalancerListenerAdminStateIsUp()))) {
102 if (fields.size() > 0) {
103 ans.add(nsg.extractFields(fields));
109 return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerListenerRequest(ans)).build();
113 * Returns a specific LoadBalancerListener.
116 @Path("{loadBalancerListenerID}")
118 @Produces({ MediaType.APPLICATION_JSON })
119 @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
120 @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
121 @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
122 @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
123 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
124 public Response showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
126 @QueryParam("fields") List<String> fields) {
127 return show(loadBalancerListenerID, fields);
131 * Creates new LoadBalancerListener.
135 @Produces({ MediaType.APPLICATION_JSON })
136 @Consumes({ MediaType.APPLICATION_JSON })
137 @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
138 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
139 public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
140 return create(input);
144 * Updates a LoadBalancerListener Policy.
146 @Path("{loadBalancerListenerID}")
148 @Produces({ MediaType.APPLICATION_JSON })
149 @Consumes({ MediaType.APPLICATION_JSON })
150 @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
151 @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
152 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
153 public Response updateLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
154 final NeutronLoadBalancerListenerRequest input) {
155 return update(loadBalancerListenerID, input);
159 * Deletes a LoadBalancerListener.
162 @Path("{loadBalancerListenerID}")
164 @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
165 @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
166 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
167 public Response deleteLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
168 return delete(loadBalancerListenerID);