2 * Copyright (C) 2014 Red Hat, Inc.
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.controller.networkconfig.neutron.northbound;
12 import org.codehaus.enunciate.jaxrs.ResponseCode;
13 import org.codehaus.enunciate.jaxrs.StatusCodes;
14 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerListenerAware;
15 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerListenerCRUD;
16 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
17 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerListener;
18 import org.opendaylight.controller.northbound.commons.RestMessages;
19 import org.opendaylight.controller.northbound.commons.exception.BadRequestException;
20 import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
21 import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException;
22 import org.opendaylight.controller.sal.utils.ServiceHelper;
24 import javax.ws.rs.Consumes;
25 import javax.ws.rs.DELETE;
26 import javax.ws.rs.GET;
27 import javax.ws.rs.POST;
28 import javax.ws.rs.PUT;
29 import javax.ws.rs.Path;
30 import javax.ws.rs.PathParam;
31 import javax.ws.rs.Produces;
32 import javax.ws.rs.QueryParam;
33 import javax.ws.rs.core.MediaType;
34 import javax.ws.rs.core.Response;
35 import java.util.ArrayList;
36 import java.util.HashMap;
37 import java.util.Iterator;
38 import java.util.List;
41 * Neutron Northbound REST APIs for LoadBalancerListener Policies.<br>
42 * This class provides REST APIs for managing neutron LoadBalancerListener Policies
46 * Authentication scheme : <b>HTTP Basic</b><br>
47 * Authentication realm : <b>opendaylight</b><br>
48 * Transport : <b>HTTP and HTTPS</b><br>
50 * HTTPS Authentication is disabled by default. Administrator can enable it in
51 * tomcat-server.xml after adding a proper keystore / SSL certificate from a
52 * trusted authority.<br>
54 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
58 public class NeutronLoadBalancerListenerNorthbound {
60 private NeutronLoadBalancerListener extractFields(NeutronLoadBalancerListener o, List<String> fields) {
61 return o.extractFields(fields);
65 * Returns a list of all LoadBalancerListener */
67 @Produces({ MediaType.APPLICATION_JSON })
69 @ResponseCode(code = 200, condition = "Operation successful"),
70 @ResponseCode(code = 401, condition = "Unauthorized"),
71 @ResponseCode(code = 501, condition = "Not Implemented") })
73 public Response listGroups(
75 @QueryParam("fields") List<String> fields,
76 // OpenStack LoadBalancerListener attributes
77 @QueryParam("id") String queryLoadBalancerListenerID,
78 @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID,
79 @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID,
80 @QueryParam("name") String queryLoadBalancerListenerName,
81 @QueryParam("description") String queryLoadBalancerListenerDescription,
82 @QueryParam("shared") String queryLoadBalancerListenerIsShared,
83 @QueryParam("protocol") String queryLoadBalancerListenerProtocol,
84 @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort,
85 @QueryParam("load_balancer_id") String queryLoadBalancerListenerLoadBalancerID,
86 @QueryParam("admin_state_up") String queryLoadBalancerListenerAdminIsUp,
87 @QueryParam("status") String queryLoadBalancerListenerStatus,
89 @QueryParam("limit") String limit,
90 @QueryParam("marker") String marker,
91 @QueryParam("page_reverse") String pageReverse
92 // sorting not supported
94 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
95 // INeutronLoadBalancerListenerRuleCRUD firewallRuleInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerRuleCRUD(this);
97 if (loadBalancerListenerInterface == null) {
98 throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
99 + RestMessages.SERVICEUNAVAILABLE.toString());
101 List<NeutronLoadBalancerListener> allLoadBalancerListeners = loadBalancerListenerInterface.getAllNeutronLoadBalancerListeners();
102 // List<NeutronLoadBalancerListenerRule> allLoadBalancerListenerRules = firewallRuleInterface.getAllNeutronLoadBalancerListenerRules();
103 List<NeutronLoadBalancerListener> ans = new ArrayList<NeutronLoadBalancerListener>();
104 // List<NeutronLoadBalancerListenerRule> rules = new ArrayList<NeutronLoadBalancerListenerRule>();
105 Iterator<NeutronLoadBalancerListener> i = allLoadBalancerListeners.iterator();
106 while (i.hasNext()) {
107 NeutronLoadBalancerListener nsg = i.next();
108 if ((queryLoadBalancerListenerID == null ||
109 queryLoadBalancerListenerID.equals(nsg.getLoadBalancerListenerID())) &&
110 (queryLoadBalancerListenerDefaultPoolID == null ||
111 queryLoadBalancerListenerDefaultPoolID.equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID())) &&
112 (queryLoadBalancerListenerTenantID == null ||
113 queryLoadBalancerListenerTenantID.equals(nsg.getLoadBalancerListenerTenantID())) &&
114 (queryLoadBalancerListenerName == null ||
115 queryLoadBalancerListenerName.equals(nsg.getLoadBalancerListenerName())) &&
116 (queryLoadBalancerListenerDescription == null ||
117 queryLoadBalancerListenerDescription.equals(nsg.getLoadBalancerListenerDescription())) &&
118 (queryLoadBalancerListenerIsShared == null ||
119 queryLoadBalancerListenerIsShared.equals(nsg.getLoadBalancerListenerIsShared())) &&
120 (queryLoadBalancerListenerProtocol == null ||
121 queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol())) &&
122 (queryLoadBalancerListenerProtocolPort == null ||
123 queryLoadBalancerListenerProtocolPort.equals(nsg.getNeutronLoadBalancerListenerProtocolPort())) &&
124 (queryLoadBalancerListenerLoadBalancerID == null ||
125 queryLoadBalancerListenerLoadBalancerID.equals(nsg.getNeutronLoadBalancerListenerLoadBalancerID())) &&
126 (queryLoadBalancerListenerAdminIsUp == null ||
127 queryLoadBalancerListenerAdminIsUp.equals(nsg.getLoadBalancerListenerAdminStateIsUp())) &&
128 (queryLoadBalancerListenerStatus == null ||
129 queryLoadBalancerListenerStatus.equals(nsg.getLoadBalancerListenerStatus()))) {
130 if (fields.size() > 0) {
131 ans.add(extractFields(nsg,fields));
137 return Response.status(200).entity(
138 new NeutronLoadBalancerListenerRequest(ans)).build();
142 * Returns a specific LoadBalancerListener */
144 @Path("{loadBalancerListenerID}")
146 @Produces({ MediaType.APPLICATION_JSON })
148 @ResponseCode(code = 200, condition = "Operation successful"),
149 @ResponseCode(code = 401, condition = "Unauthorized"),
150 @ResponseCode(code = 404, condition = "Not Found"),
151 @ResponseCode(code = 501, condition = "Not Implemented") })
152 public Response showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID,
154 @QueryParam("fields") List<String> fields) {
155 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
156 if (loadBalancerListenerInterface == null) {
157 throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
158 + RestMessages.SERVICEUNAVAILABLE.toString());
160 if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
161 throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
163 if (fields.size() > 0) {
164 NeutronLoadBalancerListener ans = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
165 return Response.status(200).entity(
166 new NeutronLoadBalancerListenerRequest(extractFields(ans, fields))).build();
168 return Response.status(200).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build();
173 * Creates new LoadBalancerListener */
176 @Produces({ MediaType.APPLICATION_JSON })
177 @Consumes({ MediaType.APPLICATION_JSON })
179 @ResponseCode(code = 201, condition = "Created"),
180 @ResponseCode(code = 400, condition = "Bad Request"),
181 @ResponseCode(code = 401, condition = "Unauthorized"),
182 @ResponseCode(code = 403, condition = "Forbidden"),
183 @ResponseCode(code = 404, condition = "Not Found"),
184 @ResponseCode(code = 409, condition = "Conflict"),
185 @ResponseCode(code = 501, condition = "Not Implemented") })
186 public Response createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) {
187 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
188 if (loadBalancerListenerInterface == null) {
189 throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
190 + RestMessages.SERVICEUNAVAILABLE.toString());
192 if (input.isSingleton()) {
193 NeutronLoadBalancerListener singleton = input.getSingleton();
196 * Verify that the LoadBalancerListener doesn't already exist.
198 if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(singleton.getLoadBalancerListenerID())) {
199 throw new BadRequestException("LoadBalancerListener UUID already exists");
201 loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton);
203 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerListenerAware.class, this, null);
204 if (instances != null) {
205 for (Object instance : instances) {
206 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
207 int status = service.canCreateNeutronLoadBalancerListener(singleton);
208 if (status < 200 || status > 299) {
209 return Response.status(status).build();
213 loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton);
214 if (instances != null) {
215 for (Object instance : instances) {
216 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
217 service.neutronLoadBalancerListenerCreated(singleton);
221 List<NeutronLoadBalancerListener> bulk = input.getBulk();
222 Iterator<NeutronLoadBalancerListener> i = bulk.iterator();
223 HashMap<String, NeutronLoadBalancerListener> testMap = new HashMap<String, NeutronLoadBalancerListener>();
224 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerListenerAware.class, this, null);
225 while (i.hasNext()) {
226 NeutronLoadBalancerListener test = i.next();
229 * Verify that the firewall policy doesn't already exist
232 if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(test.getLoadBalancerListenerID())) {
233 throw new BadRequestException("LoadBalancerListener UUID already is already created");
235 if (testMap.containsKey(test.getLoadBalancerListenerID())) {
236 throw new BadRequestException("LoadBalancerListener UUID already exists");
238 if (instances != null) {
239 for (Object instance : instances) {
240 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
241 int status = service.canCreateNeutronLoadBalancerListener(test);
242 if (status < 200 || status > 299) {
243 return Response.status(status).build();
249 * now, each element of the bulk request can be added to the cache
252 while (i.hasNext()) {
253 NeutronLoadBalancerListener test = i.next();
254 loadBalancerListenerInterface.addNeutronLoadBalancerListener(test);
255 if (instances != null) {
256 for (Object instance : instances) {
257 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
258 service.neutronLoadBalancerListenerCreated(test);
263 return Response.status(201).entity(input).build();
267 * Updates a LoadBalancerListener Policy
269 @Path("{loadBalancerListenerID}")
271 @Produces({ MediaType.APPLICATION_JSON })
272 @Consumes({ MediaType.APPLICATION_JSON })
274 @ResponseCode(code = 200, condition = "Operation successful"),
275 @ResponseCode(code = 400, condition = "Bad Request"),
276 @ResponseCode(code = 401, condition = "Unauthorized"),
277 @ResponseCode(code = 403, condition = "Forbidden"),
278 @ResponseCode(code = 404, condition = "Not Found"),
279 @ResponseCode(code = 501, condition = "Not Implemented") })
280 public Response updateLoadBalancerListener(
281 @PathParam("loadBalancerListenerID") String loadBalancerListenerID, final NeutronLoadBalancerListenerRequest input) {
282 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
283 if (loadBalancerListenerInterface == null) {
284 throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
285 + RestMessages.SERVICEUNAVAILABLE.toString());
289 * verify the LoadBalancerListener exists and there is only one delta provided
291 if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
292 throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
294 if (!input.isSingleton()) {
295 throw new BadRequestException("Only singleton edit supported");
297 NeutronLoadBalancerListener delta = input.getSingleton();
298 NeutronLoadBalancerListener original = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
301 * updates restricted by Neutron
303 if (delta.getLoadBalancerListenerID() != null ||
304 delta.getNeutronLoadBalancerListenerDefaultPoolID() != null ||
305 delta.getLoadBalancerListenerTenantID() != null ||
306 delta.getLoadBalancerListenerName() != null ||
307 delta.getLoadBalancerListenerDescription() != null ||
308 delta.getLoadBalancerListenerIsShared() != null ||
309 delta.getNeutronLoadBalancerListenerProtocol() != null ||
310 delta.getNeutronLoadBalancerListenerProtocolPort() != null ||
311 delta.getNeutronLoadBalancerListenerLoadBalancerID() != null ||
312 delta.getLoadBalancerListenerAdminStateIsUp() != null ||
313 delta.getLoadBalancerListenerStatus() != null) {
314 throw new BadRequestException("Attribute edit blocked by Neutron");
317 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerListenerAware.class, this, null);
318 if (instances != null) {
319 for (Object instance : instances) {
320 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
321 int status = service.canUpdateNeutronLoadBalancerListener(delta, original);
322 if (status < 200 || status > 299) {
323 return Response.status(status).build();
329 * update the object and return it
331 loadBalancerListenerInterface.updateNeutronLoadBalancerListener(loadBalancerListenerID, delta);
332 NeutronLoadBalancerListener updatedLoadBalancerListener = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
333 if (instances != null) {
334 for (Object instance : instances) {
335 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
336 service.neutronLoadBalancerListenerUpdated(updatedLoadBalancerListener);
339 return Response.status(200).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build();
343 * Deletes a LoadBalancerListener */
345 @Path("{loadBalancerListenerID}")
348 @ResponseCode(code = 204, condition = "No Content"),
349 @ResponseCode(code = 401, condition = "Unauthorized"),
350 @ResponseCode(code = 404, condition = "Not Found"),
351 @ResponseCode(code = 409, condition = "Conflict"),
352 @ResponseCode(code = 501, condition = "Not Implemented") })
353 public Response deleteLoadBalancerListener(
354 @PathParam("loadBalancerListenerID") String loadBalancerListenerID) {
355 INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerListenerCRUD(this);
356 if (loadBalancerListenerInterface == null) {
357 throw new ServiceUnavailableException("LoadBalancerListener CRUD Interface "
358 + RestMessages.SERVICEUNAVAILABLE.toString());
362 * verify the LoadBalancerListener exists and it isn't currently in use
364 if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) {
365 throw new ResourceNotFoundException("LoadBalancerListener UUID does not exist.");
367 if (loadBalancerListenerInterface.neutronLoadBalancerListenerInUse(loadBalancerListenerID)) {
368 return Response.status(409).build();
370 NeutronLoadBalancerListener singleton = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID);
371 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerListenerAware.class, this, null);
372 if (instances != null) {
373 for (Object instance : instances) {
374 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
375 int status = service.canDeleteNeutronLoadBalancerListener(singleton);
376 if (status < 200 || status > 299) {
377 return Response.status(status).build();
382 loadBalancerListenerInterface.removeNeutronLoadBalancerListener(loadBalancerListenerID);
383 if (instances != null) {
384 for (Object instance : instances) {
385 INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance;
386 service.neutronLoadBalancerListenerDeleted(singleton);
389 return Response.status(204).build();