Fixed package directory issues.
[neutron.git] / northbound-api / src / main / java / org / opendaylight / neutron / northbound / api / NeutronLoadBalancerHealthMonitorNorthbound.java
1 /*
2  * Copyright (C) 2014 Red Hat, Inc.
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
9 package org.opendaylight.neutron.northbound.api;
10
11
12 import java.util.ArrayList;
13 import java.util.HashMap;
14 import java.util.Iterator;
15 import java.util.List;
16
17 import javax.ws.rs.Consumes;
18 import javax.ws.rs.DELETE;
19 import javax.ws.rs.GET;
20 import javax.ws.rs.POST;
21 import javax.ws.rs.PUT;
22 import javax.ws.rs.Path;
23 import javax.ws.rs.PathParam;
24 import javax.ws.rs.Produces;
25 import javax.ws.rs.QueryParam;
26 import javax.ws.rs.core.MediaType;
27 import javax.ws.rs.core.Response;
28
29 import org.codehaus.enunciate.jaxrs.ResponseCode;
30 import org.codehaus.enunciate.jaxrs.StatusCodes;
31 import org.opendaylight.neutron.spi.INeutronLoadBalancerHealthMonitorAware;
32 import org.opendaylight.neutron.spi.INeutronLoadBalancerHealthMonitorCRUD;
33 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
34 import org.opendaylight.neutron.spi.NeutronLoadBalancer;
35 import org.opendaylight.neutron.spi.NeutronLoadBalancerHealthMonitor;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38
39 /**
40  * Neutron Northbound REST APIs for Load Balancer HealthMonitor.<br>
41  * This class provides REST APIs for managing neutron LoadBalancerHealthMonitor
42  *
43  * <br>
44  * <br>
45  * Authentication scheme : <b>HTTP Basic</b><br>
46  * Authentication realm : <b>opendaylight</b><br>
47  * Transport : <b>HTTP and HTTPS</b><br>
48  * <br>
49  * HTTPS Authentication is disabled by default. Administrator can enable it in
50  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
51  * trusted authority.<br>
52  * More info :
53  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
54  *
55  */
56 @Path("/healthmonitors")
57 public class NeutronLoadBalancerHealthMonitorNorthbound {
58     private static final Logger logger = LoggerFactory.getLogger(NeutronLoadBalancer.class);
59
60     private NeutronLoadBalancerHealthMonitor extractFields(NeutronLoadBalancerHealthMonitor o, List<String> fields) {
61         return o.extractFields(fields);
62     }
63
64     /**
65      * Returns a list of all LoadBalancerHealthMonitor */
66     @GET
67     @Produces({ MediaType.APPLICATION_JSON })
68     @StatusCodes({
69             @ResponseCode(code = 200, condition = "Operation successful"),
70             @ResponseCode(code = 401, condition = "Unauthorized"),
71             @ResponseCode(code = 501, condition = "Not Implemented"),
72             @ResponseCode(code = 503, condition = "No providers available") })
73
74     public Response listGroups(
75             // return fields
76             @QueryParam("fields") List<String> fields,
77             // OpenStack LoadBalancerHealthMonitor attributes
78             @QueryParam("id") String queryLoadBalancerHealthMonitorID,
79             @QueryParam("tenant_id") String queryLoadBalancerHealthMonitorTenantID,
80             // TODO "type" is being a property by the JSON parser.
81             @QueryParam("type") String queryLoadBalancerHealthMonitorType,
82             @QueryParam("delay") Integer queryLoadBalancerHealthMonitorDelay,
83             @QueryParam("timeout") Integer queryLoadBalancerHealthMonitorTimeout,
84             @QueryParam("max_retries") Integer queryLoadBalancerHealthMonitorMaxRetries,
85             @QueryParam("http_method") String queryLoadBalancerHealthMonitorHttpMethod,
86             @QueryParam("url_path") String queryLoadBalancerHealthMonitorUrlPath,
87             @QueryParam("expected_codes") String queryLoadBalancerHealthMonitorExpectedCodes,
88             @QueryParam("admin_state_up") Boolean queryLoadBalancerHealthMonitorIsAdminStateUp,
89             @QueryParam("status") String queryLoadBalancerHealthMonitorStatus,
90             // pagination
91             @QueryParam("limit") String limit,
92             @QueryParam("marker") String marker,
93             @QueryParam("page_reverse") String pageReverse
94             // sorting not supported
95     ) {
96         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces
97                 .getINeutronLoadBalancerHealthMonitorCRUD(this);
98         if (loadBalancerHealthMonitorInterface == null) {
99             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
100                     + RestMessages.SERVICEUNAVAILABLE.toString());
101         }
102         List<NeutronLoadBalancerHealthMonitor> allLoadBalancerHealthMonitors = loadBalancerHealthMonitorInterface.getAllNeutronLoadBalancerHealthMonitors();
103         List<NeutronLoadBalancerHealthMonitor> ans = new ArrayList<NeutronLoadBalancerHealthMonitor>();
104         Iterator<NeutronLoadBalancerHealthMonitor> i = allLoadBalancerHealthMonitors.iterator();
105         while (i.hasNext()) {
106             NeutronLoadBalancerHealthMonitor nsg = i.next();
107             if ((queryLoadBalancerHealthMonitorID == null ||
108                     queryLoadBalancerHealthMonitorID.equals(nsg.getLoadBalancerHealthMonitorID())) &&
109                     (queryLoadBalancerHealthMonitorTenantID == null ||
110                             queryLoadBalancerHealthMonitorTenantID.equals
111                                     (nsg.getLoadBalancerHealthMonitorTenantID())) &&
112                     (queryLoadBalancerHealthMonitorType == null ||
113                             queryLoadBalancerHealthMonitorType.equals
114                                     (nsg.getLoadBalancerHealthMonitorType())) &&
115                     (queryLoadBalancerHealthMonitorDelay == null ||
116                             queryLoadBalancerHealthMonitorDelay.equals
117                                     (nsg.getLoadBalancerHealthMonitorDelay())) &&
118                     (queryLoadBalancerHealthMonitorTimeout == null ||
119                             queryLoadBalancerHealthMonitorTimeout.equals
120                                     (nsg.getLoadBalancerHealthMonitorTimeout())) &&
121                     (queryLoadBalancerHealthMonitorMaxRetries == null ||
122                             queryLoadBalancerHealthMonitorMaxRetries.equals
123                                     (nsg.getLoadBalancerHealthMonitorMaxRetries())) &&
124                     (queryLoadBalancerHealthMonitorHttpMethod == null ||
125                             queryLoadBalancerHealthMonitorHttpMethod.equals
126                                     (nsg.getLoadBalancerHealthMonitorHttpMethod())) &&
127                     (queryLoadBalancerHealthMonitorUrlPath == null ||
128                             queryLoadBalancerHealthMonitorUrlPath.equals
129                                     (nsg.getLoadBalancerHealthMonitorUrlPath())) &&
130                     (queryLoadBalancerHealthMonitorExpectedCodes == null ||
131                             queryLoadBalancerHealthMonitorExpectedCodes.equals
132                                     (nsg.getLoadBalancerHealthMonitorExpectedCodes())) &&
133                     (queryLoadBalancerHealthMonitorIsAdminStateUp == null ||
134                             queryLoadBalancerHealthMonitorIsAdminStateUp.equals
135                                     (nsg.getLoadBalancerHealthMonitorAdminStateIsUp())) &&
136                     (queryLoadBalancerHealthMonitorStatus == null ||
137                             queryLoadBalancerHealthMonitorStatus.equals
138                                     (nsg.getLoadBalancerHealthMonitorStatus()))) {
139                 if (fields.size() > 0) {
140                     ans.add(extractFields(nsg,fields));
141                 } else {
142                     ans.add(nsg);
143                 }
144             }
145         }
146         return Response.status(200).entity(
147                 new NeutronLoadBalancerHealthMonitorRequest(ans)).build();
148     }
149
150     /**
151      * Returns a specific LoadBalancerHealthMonitor */
152
153     @Path("{loadBalancerHealthMonitorID}")
154     @GET
155     @Produces({ MediaType.APPLICATION_JSON })
156     @StatusCodes({
157             @ResponseCode(code = 200, condition = "Operation successful"),
158             @ResponseCode(code = 401, condition = "Unauthorized"),
159             @ResponseCode(code = 404, condition = "Not Found"),
160             @ResponseCode(code = 501, condition = "Not Implemented"),
161             @ResponseCode(code = 503, condition = "No providers available") })
162     public Response showLoadBalancerHealthMonitor(@PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID,
163             // return fields
164             @QueryParam("fields") List<String> fields) {
165         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
166         if (loadBalancerHealthMonitorInterface == null) {
167             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
168                     + RestMessages.SERVICEUNAVAILABLE.toString());
169         }
170         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
171             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
172         }
173         if (fields.size() > 0) {
174             NeutronLoadBalancerHealthMonitor ans = loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
175             return Response.status(200).entity(
176                     new NeutronLoadBalancerHealthMonitorRequest(extractFields(ans, fields))).build();
177         } else {
178             return Response.status(200).entity(new NeutronLoadBalancerHealthMonitorRequest(loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID))).build();
179         }
180     }
181
182     /**
183      * Creates new LoadBalancerHealthMonitor */
184
185     @POST
186     @Produces({ MediaType.APPLICATION_JSON })
187     @Consumes({ MediaType.APPLICATION_JSON })
188     @StatusCodes({
189             @ResponseCode(code = 201, condition = "Created"),
190             @ResponseCode(code = 400, condition = "Bad Request"),
191             @ResponseCode(code = 401, condition = "Unauthorized"),
192             @ResponseCode(code = 403, condition = "Forbidden"),
193             @ResponseCode(code = 404, condition = "Not Found"),
194             @ResponseCode(code = 409, condition = "Conflict"),
195             @ResponseCode(code = 501, condition = "Not Implemented"),
196             @ResponseCode(code = 503, condition = "No providers available") })
197     public Response createLoadBalancerHealthMonitors(final NeutronLoadBalancerHealthMonitorRequest input) {
198         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
199         if (loadBalancerHealthMonitorInterface == null) {
200             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
201                     + RestMessages.SERVICEUNAVAILABLE.toString());
202         }
203         if (input.isSingleton()) {
204             NeutronLoadBalancerHealthMonitor singleton = input.getSingleton();
205
206             /*
207              *  Verify that the LoadBalancerHealthMonitor doesn't already exist.
208              */
209             if (loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(singleton.getLoadBalancerHealthMonitorID())) {
210                 throw new BadRequestException("LoadBalancerHealthMonitor UUID already exists");
211             }
212             loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(singleton);
213
214             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
215             if (instances != null) {
216                 if (instances.length > 0) {
217                     for (Object instance : instances) {
218                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
219                         int status = service.canCreateNeutronLoadBalancerHealthMonitor(singleton);
220                         if (status < 200 || status > 299) {
221                             return Response.status(status).build();
222                         }
223                     }
224                 } else {
225                     throw new ServiceUnavailableException("No providers registered.  Please try again later");
226                 }
227             } else {
228                 throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
229             }
230             loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(singleton);
231             if (instances != null) {
232                 for (Object instance : instances) {
233                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
234                     service.neutronLoadBalancerHealthMonitorCreated(singleton);
235                 }
236             }
237         } else {
238             List<NeutronLoadBalancerHealthMonitor> bulk = input.getBulk();
239             Iterator<NeutronLoadBalancerHealthMonitor> i = bulk.iterator();
240             HashMap<String, NeutronLoadBalancerHealthMonitor> testMap = new HashMap<String, NeutronLoadBalancerHealthMonitor>();
241             Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
242             while (i.hasNext()) {
243                 NeutronLoadBalancerHealthMonitor test = i.next();
244
245                 /*
246                  *  Verify that the firewall policy doesn't already exist
247                  */
248
249                 if (loadBalancerHealthMonitorInterface
250                         .neutronLoadBalancerHealthMonitorExists(test.getLoadBalancerHealthMonitorID())) {
251                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already is already created");
252                 }
253                 if (testMap.containsKey(test.getLoadBalancerHealthMonitorID())) {
254                     throw new BadRequestException("LoadBalancerHealthMonitor UUID already exists");
255                 }
256                 if (instances != null) {
257                     if (instances.length > 0) {
258                         for (Object instance : instances) {
259                             INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
260                             int status = service.canCreateNeutronLoadBalancerHealthMonitor(test);
261                             if (status < 200 || status > 299) {
262                                 return Response.status(status).build();
263                             }
264                         }
265                     } else {
266                         throw new ServiceUnavailableException("No providers registered.  Please try again later");
267                     }
268                 } else {
269                     throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
270                 }
271             }
272             /*
273              * now, each element of the bulk request can be added to the cache
274              */
275             i = bulk.iterator();
276             while (i.hasNext()) {
277                 NeutronLoadBalancerHealthMonitor test = i.next();
278                 loadBalancerHealthMonitorInterface.addNeutronLoadBalancerHealthMonitor(test);
279                 if (instances != null) {
280                     for (Object instance : instances) {
281                         INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
282                         service.neutronLoadBalancerHealthMonitorCreated(test);
283                     }
284                 }
285             }
286         }
287         return Response.status(201).entity(input).build();
288     }
289
290     /**
291      * Updates a LoadBalancerHealthMonitor Policy
292      */
293     @Path("{loadBalancerHealthMonitorID}")
294     @PUT
295     @Produces({ MediaType.APPLICATION_JSON })
296     @Consumes({ MediaType.APPLICATION_JSON })
297     @StatusCodes({
298             @ResponseCode(code = 200, condition = "Operation successful"),
299             @ResponseCode(code = 400, condition = "Bad Request"),
300             @ResponseCode(code = 401, condition = "Unauthorized"),
301             @ResponseCode(code = 403, condition = "Forbidden"),
302             @ResponseCode(code = 404, condition = "Not Found"),
303             @ResponseCode(code = 501, condition = "Not Implemented"),
304             @ResponseCode(code = 503, condition = "No providers available") })
305     public Response updateLoadBalancerHealthMonitor(
306             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID,
307             final NeutronLoadBalancerHealthMonitorRequest input) {
308         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces
309                 .getINeutronLoadBalancerHealthMonitorCRUD(this);
310         if (loadBalancerHealthMonitorInterface == null) {
311             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
312                     + RestMessages.SERVICEUNAVAILABLE.toString());
313         }
314
315         /*
316          * verify the LoadBalancerHealthMonitor exists and there is only one delta provided
317          */
318         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
319             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
320         }
321         if (!input.isSingleton()) {
322             throw new BadRequestException("Only singleton edit supported");
323         }
324         NeutronLoadBalancerHealthMonitor delta = input.getSingleton();
325         NeutronLoadBalancerHealthMonitor original = loadBalancerHealthMonitorInterface
326                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
327
328         /*
329          * updates restricted by Neutron
330          */
331         if (delta.getLoadBalancerHealthMonitorID() != null ||
332                 delta.getLoadBalancerHealthMonitorTenantID() != null ||
333                 delta.getLoadBalancerHealthMonitorType() != null ||
334                 delta.getLoadBalancerHealthMonitorDelay() != null ||
335                 delta.getLoadBalancerHealthMonitorTimeout() != null ||
336                 delta.getLoadBalancerHealthMonitorMaxRetries() != null ||
337                 delta.getLoadBalancerHealthMonitorHttpMethod() != null ||
338                 delta.getLoadBalancerHealthMonitorUrlPath() != null ||
339                 delta.getLoadBalancerHealthMonitorExpectedCodes() != null ||
340                 delta.getLoadBalancerHealthMonitorAdminStateIsUp() != null ||
341                 delta.getLoadBalancerHealthMonitorStatus() != null) {
342             throw new BadRequestException("Attribute edit blocked by Neutron");
343         }
344
345         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
346         if (instances != null) {
347             if (instances.length > 0) {
348                 for (Object instance : instances) {
349                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
350                     int status = service.canUpdateNeutronLoadBalancerHealthMonitor(delta, original);
351                     if (status < 200 || status > 299) {
352                         return Response.status(status).build();
353                     }
354                 }
355             } else {
356                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
357             }
358         } else {
359             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
360         }
361
362         /*
363          * update the object and return it
364          */
365         loadBalancerHealthMonitorInterface.updateNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID, delta);
366         NeutronLoadBalancerHealthMonitor updatedLoadBalancerHealthMonitor = loadBalancerHealthMonitorInterface
367                 .getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
368         if (instances != null) {
369             for (Object instance : instances) {
370                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
371                 service.neutronLoadBalancerHealthMonitorUpdated(updatedLoadBalancerHealthMonitor);
372             }
373         }
374         return Response.status(200).entity(new NeutronLoadBalancerHealthMonitorRequest
375                 (loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor
376                         (loadBalancerHealthMonitorID))).build();
377     }
378
379
380
381     /**
382      * Deletes a LoadBalancerHealthMonitor
383      * */
384     @Path("{loadBalancerHealthMonitorID}")
385     @DELETE
386     @StatusCodes({
387             @ResponseCode(code = 204, condition = "No Content"),
388             @ResponseCode(code = 401, condition = "Unauthorized"),
389             @ResponseCode(code = 404, condition = "Not Found"),
390             @ResponseCode(code = 409, condition = "Conflict"),
391             @ResponseCode(code = 501, condition = "Not Implemented"),
392             @ResponseCode(code = 503, condition = "No providers available") })
393     public Response deleteLoadBalancerHealthMonitor(
394             @PathParam("loadBalancerHealthMonitorID") String loadBalancerHealthMonitorID) {
395         INeutronLoadBalancerHealthMonitorCRUD loadBalancerHealthMonitorInterface = NeutronCRUDInterfaces.getINeutronLoadBalancerHealthMonitorCRUD(this);
396         if (loadBalancerHealthMonitorInterface == null) {
397             throw new ServiceUnavailableException("LoadBalancerHealthMonitor CRUD Interface "
398                     + RestMessages.SERVICEUNAVAILABLE.toString());
399         }
400         /*
401          * verify the LoadBalancerHealthMonitor exists and it isn't currently in use
402          */
403         if (!loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorExists(loadBalancerHealthMonitorID)) {
404             throw new ResourceNotFoundException("LoadBalancerHealthMonitor UUID does not exist.");
405         }
406         if (loadBalancerHealthMonitorInterface.neutronLoadBalancerHealthMonitorInUse(loadBalancerHealthMonitorID)) {
407             return Response.status(409).build();
408         }
409         NeutronLoadBalancerHealthMonitor singleton = loadBalancerHealthMonitorInterface.getNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
410         Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerHealthMonitorAware.class, this);
411         if (instances != null) {
412             if (instances.length > 0) {
413                 for (Object instance : instances) {
414                     INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
415                     int status = service.canDeleteNeutronLoadBalancerHealthMonitor(singleton);
416                     if (status < 200 || status > 299) {
417                         return Response.status(status).build();
418                     }
419                 }
420             } else {
421                 throw new ServiceUnavailableException("No providers registered.  Please try again later");
422             }
423         } else {
424             throw new ServiceUnavailableException("Couldn't get providers list.  Please try again later");
425         }
426         loadBalancerHealthMonitorInterface.removeNeutronLoadBalancerHealthMonitor(loadBalancerHealthMonitorID);
427         if (instances != null) {
428             for (Object instance : instances) {
429                 INeutronLoadBalancerHealthMonitorAware service = (INeutronLoadBalancerHealthMonitorAware) instance;
430                 service.neutronLoadBalancerHealthMonitorDeleted(singleton);
431             }
432         }
433         return Response.status(204).build();
434     }
435 }