2 * Copyright (C) 2014 SDN Hub, LLC.
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
8 * Authors : Srini Seetharaman
11 package org.opendaylight.controller.networkconfig.neutron.northbound;
14 import org.codehaus.enunciate.jaxrs.ResponseCode;
15 import org.codehaus.enunciate.jaxrs.StatusCodes;
16 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolAware;
17 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolCRUD;
18 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
19 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPool;
20 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPoolMember;
21 import org.opendaylight.controller.northbound.commons.RestMessages;
22 import org.opendaylight.controller.northbound.commons.exception.BadRequestException;
23 import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
24 import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException;
25 import org.opendaylight.controller.sal.utils.ServiceHelper;
27 import javax.ws.rs.Consumes;
28 import javax.ws.rs.DELETE;
29 import javax.ws.rs.GET;
30 import javax.ws.rs.POST;
31 import javax.ws.rs.PUT;
32 import javax.ws.rs.Path;
33 import javax.ws.rs.PathParam;
34 import javax.ws.rs.Produces;
35 import javax.ws.rs.QueryParam;
36 import javax.ws.rs.core.MediaType;
37 import javax.ws.rs.core.Response;
39 import java.util.ArrayList;
40 import java.util.HashMap;
41 import java.util.Iterator;
42 import java.util.List;
45 * Neutron Northbound REST APIs for LoadBalancerPool Policies.<br>
46 * This class provides REST APIs for managing neutron LoadBalancerPool Policies
50 * Authentication scheme : <b>HTTP Basic</b><br>
51 * Authentication realm : <b>opendaylight</b><br>
52 * Transport : <b>HTTP and HTTPS</b><br>
54 * HTTPS Authentication is disabled by default. Administrator can enable it in
55 * tomcat-server.xml after adding a proper keystore / SSL certificate from a
56 * trusted authority.<br>
58 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
63 * For now, the LB pool member data is maintained with the INeutronLoadBalancerPoolCRUD,
64 * and not duplicated within the INeutronLoadBalancerPoolMemberCRUD's cache.
68 public class NeutronLoadBalancerPoolNorthbound {
70 private NeutronLoadBalancerPool extractFields(NeutronLoadBalancerPool o, List<String> fields) {
71 return o.extractFields(fields);
75 * Returns a list of all LoadBalancerPool
78 @Produces({ MediaType.APPLICATION_JSON })
80 @ResponseCode(code = 200, condition = "Operation successful"),
81 @ResponseCode(code = 401, condition = "Unauthorized"),
82 @ResponseCode(code = 501, condition = "Not Implemented") })
84 public Response listGroups(
86 @QueryParam("fields") List<String> fields,
87 // OpenStack LoadBalancerPool attributes
88 @QueryParam("id") String queryLoadBalancerPoolID,
89 @QueryParam("tenant_id") String queryLoadBalancerPoolTenantID,
90 @QueryParam("name") String queryLoadBalancerPoolName,
91 @QueryParam("description") String queryLoadBalancerDescription,
92 @QueryParam("protocol") String queryLoadBalancerProtocol,
93 @QueryParam("lb_algorithm") String queryLoadBalancerPoolLbAlgorithm,
94 @QueryParam("healthmonitor_id") String queryLoadBalancerPoolHealthMonitorID,
95 @QueryParam("admin_state_up") String queryLoadBalancerIsAdminStateUp,
96 @QueryParam("status") String queryLoadBalancerPoolStatus,
97 @QueryParam("members") List<NeutronLoadBalancerPoolMember> queryLoadBalancerPoolMembers,
99 @QueryParam("limit") String limit,
100 @QueryParam("marker") String marker,
101 @QueryParam("page_reverse") String pageReverse
102 // sorting not supported
104 INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
105 if (loadBalancerPoolInterface == null) {
106 throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
107 + RestMessages.SERVICEUNAVAILABLE.toString());
109 List<NeutronLoadBalancerPool> allLoadBalancerPools = loadBalancerPoolInterface.getAllNeutronLoadBalancerPools();
110 List<NeutronLoadBalancerPool> ans = new ArrayList<NeutronLoadBalancerPool>();
111 Iterator<NeutronLoadBalancerPool> i = allLoadBalancerPools.iterator();
112 while (i.hasNext()) {
113 NeutronLoadBalancerPool nsg = i.next();
114 if ((queryLoadBalancerPoolID == null ||
115 queryLoadBalancerPoolID.equals(nsg.getLoadBalancerPoolID())) &&
116 (queryLoadBalancerPoolTenantID == null ||
117 queryLoadBalancerPoolTenantID.equals(nsg.getLoadBalancerPoolTenantID())) &&
118 (queryLoadBalancerPoolName == null ||
119 queryLoadBalancerPoolName.equals(nsg.getLoadBalancerPoolName())) &&
120 (queryLoadBalancerDescription == null ||
121 queryLoadBalancerDescription.equals(nsg.getLoadBalancerPoolDescription())) &&
122 (queryLoadBalancerPoolLbAlgorithm == null ||
123 queryLoadBalancerPoolLbAlgorithm.equals(nsg.getLoadBalancerPoolLbAlgorithm())) &&
124 (queryLoadBalancerPoolHealthMonitorID == null ||
125 queryLoadBalancerPoolHealthMonitorID.equals(nsg.getNeutronLoadBalancerPoolHealthMonitorID())) &&
126 (queryLoadBalancerIsAdminStateUp == null ||
127 queryLoadBalancerIsAdminStateUp.equals(nsg.getLoadBalancerPoolAdminIsStateIsUp())) &&
128 (queryLoadBalancerPoolStatus == null ||
129 queryLoadBalancerPoolStatus.equals(nsg.getLoadBalancerPoolStatus())) &&
130 (queryLoadBalancerPoolMembers.size() == 0 ||
131 queryLoadBalancerPoolMembers.equals(nsg.getLoadBalancerPoolMembers()))) {
132 if (fields.size() > 0) {
133 ans.add(extractFields(nsg,fields));
139 return Response.status(200).entity(
140 new NeutronLoadBalancerPoolRequest(ans)).build();
144 * Returns a specific LoadBalancerPool */
146 @Path("{loadBalancerPoolID}")
148 @Produces({ MediaType.APPLICATION_JSON })
150 @ResponseCode(code = 200, condition = "Operation successful"),
151 @ResponseCode(code = 401, condition = "Unauthorized"),
152 @ResponseCode(code = 404, condition = "Not Found"),
153 @ResponseCode(code = 501, condition = "Not Implemented") })
154 public Response showLoadBalancerPool(@PathParam("loadBalancerPoolID") String loadBalancerPoolID,
156 @QueryParam("fields") List<String> fields) {
157 INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
158 if (loadBalancerPoolInterface == null) {
159 throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
160 + RestMessages.SERVICEUNAVAILABLE.toString());
162 if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) {
163 throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
165 if (fields.size() > 0) {
166 NeutronLoadBalancerPool ans = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
167 return Response.status(200).entity(
168 new NeutronLoadBalancerPoolRequest(extractFields(ans, fields))).build();
170 return Response.status(200).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build();
175 * Creates new LoadBalancerPool */
178 @Produces({ MediaType.APPLICATION_JSON })
179 @Consumes({ MediaType.APPLICATION_JSON })
181 @ResponseCode(code = 201, condition = "Created"),
182 @ResponseCode(code = 400, condition = "Bad Request"),
183 @ResponseCode(code = 401, condition = "Unauthorized"),
184 @ResponseCode(code = 403, condition = "Forbidden"),
185 @ResponseCode(code = 404, condition = "Not Found"),
186 @ResponseCode(code = 409, condition = "Conflict"),
187 @ResponseCode(code = 501, condition = "Not Implemented") })
188 public Response createLoadBalancerPools(final NeutronLoadBalancerPoolRequest input) {
189 INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
190 if (loadBalancerPoolInterface == null) {
191 throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
192 + RestMessages.SERVICEUNAVAILABLE.toString());
194 if (input.isSingleton()) {
195 NeutronLoadBalancerPool singleton = input.getSingleton();
198 * Verify that the LoadBalancerPool doesn't already exist.
200 if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(singleton.getLoadBalancerPoolID())) {
201 throw new BadRequestException("LoadBalancerPool UUID already exists");
203 loadBalancerPoolInterface.addNeutronLoadBalancerPool(singleton);
205 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
206 if (instances != null) {
207 for (Object instance : instances) {
208 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
209 int status = service.canCreateNeutronLoadBalancerPool(singleton);
210 if (status < 200 || status > 299) {
211 return Response.status(status).build();
215 loadBalancerPoolInterface.addNeutronLoadBalancerPool(singleton);
216 if (instances != null) {
217 for (Object instance : instances) {
218 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
219 service.neutronLoadBalancerPoolCreated(singleton);
223 List<NeutronLoadBalancerPool> bulk = input.getBulk();
224 Iterator<NeutronLoadBalancerPool> i = bulk.iterator();
225 HashMap<String, NeutronLoadBalancerPool> testMap = new HashMap<String, NeutronLoadBalancerPool>();
226 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
227 while (i.hasNext()) {
228 NeutronLoadBalancerPool test = i.next();
231 * Verify that the loadBalancerPool doesn't already exist
234 if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(test.getLoadBalancerPoolID())) {
235 throw new BadRequestException("Load Balancer Pool UUID already is already created");
237 if (testMap.containsKey(test.getLoadBalancerPoolID())) {
238 throw new BadRequestException("Load Balancer Pool UUID already exists");
240 if (instances != null) {
241 for (Object instance : instances) {
242 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
243 int status = service.canCreateNeutronLoadBalancerPool(test);
244 if (status < 200 || status > 299) {
245 return Response.status(status).build();
251 * now, each element of the bulk request can be added to the cache
254 while (i.hasNext()) {
255 NeutronLoadBalancerPool test = i.next();
256 loadBalancerPoolInterface.addNeutronLoadBalancerPool(test);
257 if (instances != null) {
258 for (Object instance : instances) {
259 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
260 service.neutronLoadBalancerPoolCreated(test);
265 return Response.status(201).entity(input).build();
269 * Updates a LoadBalancerPool Policy
271 @Path("{loadBalancerPoolID}")
273 @Produces({ MediaType.APPLICATION_JSON })
274 @Consumes({ MediaType.APPLICATION_JSON })
276 @ResponseCode(code = 200, condition = "Operation successful"),
277 @ResponseCode(code = 400, condition = "Bad Request"),
278 @ResponseCode(code = 401, condition = "Unauthorized"),
279 @ResponseCode(code = 403, condition = "Forbidden"),
280 @ResponseCode(code = 404, condition = "Not Found"),
281 @ResponseCode(code = 501, condition = "Not Implemented") })
282 public Response updateLoadBalancerPool(
283 @PathParam("loadBalancerPoolID") String loadBalancerPoolID, final NeutronLoadBalancerPoolRequest input) {
284 INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
285 if (loadBalancerPoolInterface == null) {
286 throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
287 + RestMessages.SERVICEUNAVAILABLE.toString());
291 * verify the LoadBalancerPool exists and there is only one delta provided
293 if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) {
294 throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
296 if (!input.isSingleton()) {
297 throw new BadRequestException("Only singleton edit supported");
299 NeutronLoadBalancerPool delta = input.getSingleton();
300 NeutronLoadBalancerPool original = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
303 * updates restricted by Neutron
305 if (delta.getLoadBalancerPoolID() != null ||
306 delta.getLoadBalancerPoolTenantID() != null ||
307 delta.getLoadBalancerPoolName() != null ||
308 delta.getLoadBalancerPoolDescription() != null ||
309 delta.getLoadBalancerPoolProtocol() != null ||
310 delta.getLoadBalancerPoolLbAlgorithm() != null ||
311 delta.getNeutronLoadBalancerPoolHealthMonitorID() != null ||
312 delta.getLoadBalancerPoolAdminIsStateIsUp() != null ||
313 delta.getLoadBalancerPoolStatus() != null ||
314 delta.getLoadBalancerPoolMembers() != null) {
315 throw new BadRequestException("Attribute edit blocked by Neutron");
318 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
319 if (instances != null) {
320 for (Object instance : instances) {
321 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
322 int status = service.canUpdateNeutronLoadBalancerPool(delta, original);
323 if (status < 200 || status > 299) {
324 return Response.status(status).build();
330 * update the object and return it
332 loadBalancerPoolInterface.updateNeutronLoadBalancerPool(loadBalancerPoolID, delta);
333 NeutronLoadBalancerPool updatedLoadBalancerPool = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID);
334 if (instances != null) {
335 for (Object instance : instances) {
336 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
337 service.neutronLoadBalancerPoolUpdated(updatedLoadBalancerPool);
340 return Response.status(200).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build();
344 * Deletes a LoadBalancerPool
347 @Path("{loadBalancerPoolUUID}")
350 @ResponseCode(code = 204, condition = "No Content"),
351 @ResponseCode(code = 401, condition = "Unauthorized"),
352 @ResponseCode(code = 404, condition = "Not Found"),
353 @ResponseCode(code = 409, condition = "Conflict"),
354 @ResponseCode(code = 501, condition = "Not Implemented") })
355 public Response deleteLoadBalancerPool(
356 @PathParam("loadBalancerPoolUUID") String loadBalancerPoolUUID) {
357 INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerPoolCRUD(this);
358 if (loadBalancerPoolInterface == null) {
359 throw new ServiceUnavailableException("LoadBalancerPool CRUD Interface "
360 + RestMessages.SERVICEUNAVAILABLE.toString());
364 * verify the LoadBalancerPool exists and it isn't currently in use
366 if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolUUID)) {
367 throw new ResourceNotFoundException("LoadBalancerPool UUID does not exist.");
369 if (loadBalancerPoolInterface.neutronLoadBalancerPoolInUse(loadBalancerPoolUUID)) {
370 return Response.status(409).build();
372 NeutronLoadBalancerPool singleton = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolUUID);
373 Object[] instances = ServiceHelper.getGlobalInstances(INeutronLoadBalancerPoolAware.class, this, null);
374 if (instances != null) {
375 for (Object instance : instances) {
376 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
377 int status = service.canDeleteNeutronLoadBalancerPool(singleton);
378 if (status < 200 || status > 299) {
379 return Response.status(status).build();
385 * remove it and return 204 status
387 loadBalancerPoolInterface.removeNeutronLoadBalancerPool(loadBalancerPoolUUID);
388 if (instances != null) {
389 for (Object instance : instances) {
390 INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance;
391 service.neutronLoadBalancerPoolDeleted(singleton);
394 return Response.status(204).build();