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.INeutronFirewallAware;
15 import org.opendaylight.controller.networkconfig.neutron.INeutronFirewallCRUD;
16 import org.opendaylight.controller.networkconfig.neutron.INeutronFirewallRuleCRUD;
17 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
18 import org.opendaylight.controller.networkconfig.neutron.NeutronFirewall;
20 import javax.ws.rs.Consumes;
21 import javax.ws.rs.DELETE;
22 import javax.ws.rs.GET;
23 import javax.ws.rs.POST;
24 import javax.ws.rs.PUT;
25 import javax.ws.rs.Path;
26 import javax.ws.rs.PathParam;
27 import javax.ws.rs.Produces;
28 import javax.ws.rs.QueryParam;
29 import javax.ws.rs.core.MediaType;
30 import javax.ws.rs.core.Response;
31 import java.util.ArrayList;
32 import java.util.HashMap;
33 import java.util.Iterator;
34 import java.util.List;
37 * Neutron Northbound REST APIs for Firewall.<br>
38 * This class provides REST APIs for managing neutron Firewall
42 * Authentication scheme : <b>HTTP Basic</b><br>
43 * Authentication realm : <b>opendaylight</b><br>
44 * Transport : <b>HTTP and HTTPS</b><br>
46 * HTTPS Authentication is disabled by default. Administrator can enable it in
47 * tomcat-server.xml after adding a proper keystore / SSL certificate from a
48 * trusted authority.<br>
50 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
53 @Path("/fw/firewalls")
54 public class NeutronFirewallNorthbound {
56 private NeutronFirewall extractFields(NeutronFirewall o, List<String> fields) {
57 return o.extractFields(fields);
61 * Returns a list of all Firewalls */
63 @Produces({ MediaType.APPLICATION_JSON })
65 @ResponseCode(code = 200, condition = "Operation successful"),
66 @ResponseCode(code = 401, condition = "Unauthorized"),
67 @ResponseCode(code = 501, condition = "Not Implemented") })
69 public Response listGroups(
71 @QueryParam("fields") List<String> fields,
72 // OpenStack firewall attributes
73 @QueryParam("id") String queryFirewallUUID,
74 @QueryParam("tenant_id") String queryFirewallTenantID,
75 @QueryParam("name") String queryFirewallName,
76 @QueryParam("description") String queryFirewallDescription,
77 @QueryParam("shared") Boolean queryFirewallAdminStateIsUp,
78 @QueryParam("status") String queryFirewallStatus,
79 @QueryParam("shared") Boolean queryFirewallIsShared,
80 @QueryParam("firewall_policy_id") String queryFirewallPolicyID,
82 @QueryParam("limit") String limit,
83 @QueryParam("marker") String marker,
84 @QueryParam("page_reverse") String pageReverse
85 // sorting not supported
87 INeutronFirewallCRUD firewallInterface = NeutronCRUDInterfaces.getINeutronFirewallCRUD(this);
88 INeutronFirewallRuleCRUD firewallRuleInterface = NeutronCRUDInterfaces.getINeutronFirewallRuleCRUD(this);
90 if (firewallInterface == null) {
91 throw new ServiceUnavailableException("Firewall CRUD Interface "
92 + RestMessages.SERVICEUNAVAILABLE.toString());
94 List<NeutronFirewall> allFirewalls = firewallInterface.getAllNeutronFirewalls();
95 List<NeutronFirewall> ans = new ArrayList<NeutronFirewall>();
96 Iterator<NeutronFirewall> i = allFirewalls.iterator();
98 NeutronFirewall nsg = i.next();
99 if ((queryFirewallUUID == null ||
100 queryFirewallUUID.equals(nsg.getFirewallUUID())) &&
101 (queryFirewallTenantID == null ||
102 queryFirewallTenantID.equals(nsg.getFirewallTenantID())) &&
103 (queryFirewallName == null ||
104 queryFirewallName.equals(nsg.getFirewallName())) &&
105 (queryFirewallDescription == null ||
106 queryFirewallDescription.equals(nsg.getFirewallDescription())) &&
107 (queryFirewallAdminStateIsUp == null ||
108 queryFirewallAdminStateIsUp.equals(nsg.getFirewallAdminStateIsUp())) &&
109 (queryFirewallStatus == null ||
110 queryFirewallStatus.equals(nsg.getFirewallStatus())) &&
111 (queryFirewallIsShared == null ||
112 queryFirewallIsShared.equals(nsg.getFirewallIsShared())) &&
113 (queryFirewallPolicyID == null ||
114 queryFirewallPolicyID.equals(nsg.getFirewallPolicyID()))) {
115 if (fields.size() > 0) {
116 ans.add(extractFields(nsg,fields));
122 //TODO: apply pagination to results
123 return Response.status(200).entity(
124 new NeutronFirewallRequest(ans)).build();
128 * Returns a specific Firewall */
130 @Path("{firewallUUID}")
132 @Produces({ MediaType.APPLICATION_JSON })
134 @ResponseCode(code = 200, condition = "Operation successful"),
135 @ResponseCode(code = 401, condition = "Unauthorized"),
136 @ResponseCode(code = 404, condition = "Not Found"),
137 @ResponseCode(code = 501, condition = "Not Implemented") })
138 public Response showFirewall(@PathParam("firewallUUID") String firewallUUID,
140 @QueryParam("fields") List<String> fields) {
141 INeutronFirewallCRUD firewallInterface = NeutronCRUDInterfaces.getINeutronFirewallCRUD(this);
142 if (firewallInterface == null) {
143 throw new ServiceUnavailableException("Firewall CRUD Interface "
144 + RestMessages.SERVICEUNAVAILABLE.toString());
146 if (!firewallInterface.neutronFirewallExists(firewallUUID)) {
147 throw new ResourceNotFoundException("Firewall UUID does not exist.");
149 if (fields.size() > 0) {
150 NeutronFirewall ans = firewallInterface.getNeutronFirewall(firewallUUID);
151 return Response.status(200).entity(
152 new NeutronFirewallRequest(extractFields(ans, fields))).build();
154 return Response.status(200).entity(new NeutronFirewallRequest(firewallInterface.getNeutronFirewall(firewallUUID))).build();
159 * Creates new Firewall */
162 @Produces({ MediaType.APPLICATION_JSON })
163 @Consumes({ MediaType.APPLICATION_JSON })
165 @ResponseCode(code = 201, condition = "Created"),
166 @ResponseCode(code = 400, condition = "Bad Request"),
167 @ResponseCode(code = 401, condition = "Unauthorized"),
168 @ResponseCode(code = 403, condition = "Forbidden"),
169 @ResponseCode(code = 404, condition = "Not Found"),
170 @ResponseCode(code = 409, condition = "Conflict"),
171 @ResponseCode(code = 501, condition = "Not Implemented") })
172 public Response createFirewalls(final NeutronFirewallRequest input) {
173 INeutronFirewallCRUD firewallInterface = NeutronCRUDInterfaces.getINeutronFirewallCRUD(this);
174 if (firewallInterface == null) {
175 throw new ServiceUnavailableException("Firewall CRUD Interface "
176 + RestMessages.SERVICEUNAVAILABLE.toString());
178 if (input.isSingleton()) {
179 NeutronFirewall singleton = input.getSingleton();
182 * Verify that the Firewall doesn't already exist.
184 if (firewallInterface.neutronFirewallExists(singleton.getFirewallUUID())) {
185 throw new BadRequestException("Firewall UUID already exists");
187 firewallInterface.addNeutronFirewall(singleton);
188 Object[] instances = NeutronUtil.getInstances(INeutronFirewallAware.class, this);
189 if (instances != null) {
190 for (Object instance : instances) {
191 INeutronFirewallAware service = (INeutronFirewallAware) instance;
192 int status = service.canCreateNeutronFirewall(singleton);
193 if (status < 200 || status > 299) {
194 return Response.status(status).build();
198 firewallInterface.addNeutronFirewall(singleton);
199 if (instances != null) {
200 for (Object instance : instances) {
201 INeutronFirewallAware service = (INeutronFirewallAware) instance;
202 service.neutronFirewallCreated(singleton);
206 List<NeutronFirewall> bulk = input.getBulk();
207 Iterator<NeutronFirewall> i = bulk.iterator();
208 HashMap<String, NeutronFirewall> testMap = new HashMap<String, NeutronFirewall>();
209 Object[] instances = NeutronUtil.getInstances(INeutronFirewallAware.class, this);
210 while (i.hasNext()) {
211 NeutronFirewall test = i.next();
214 * Verify that the secruity group doesn't already exist
216 if (firewallInterface.neutronFirewallExists(test.getFirewallUUID())) {
217 throw new BadRequestException("Firewall UUID already is already created");
219 if (testMap.containsKey(test.getFirewallUUID())) {
220 throw new BadRequestException("Firewall UUID already exists");
222 if (instances != null) {
223 for (Object instance : instances) {
224 INeutronFirewallAware service = (INeutronFirewallAware) instance;
225 int status = service.canCreateNeutronFirewall(test);
226 if (status < 200 || status > 299) {
227 return Response.status(status).build();
234 * now, each element of the bulk request can be added to the cache
237 while (i.hasNext()) {
238 NeutronFirewall test = i.next();
239 firewallInterface.addNeutronFirewall(test);
240 if (instances != null) {
241 for (Object instance : instances) {
242 INeutronFirewallAware service = (INeutronFirewallAware) instance;
243 service.neutronFirewallCreated(test);
248 return Response.status(201).entity(input).build();
252 * Updates a Firewall */
254 @Path("{firewallUUID}")
256 @Produces({ MediaType.APPLICATION_JSON })
257 @Consumes({ MediaType.APPLICATION_JSON })
259 @ResponseCode(code = 200, condition = "Operation successful"),
260 @ResponseCode(code = 400, condition = "Bad Request"),
261 @ResponseCode(code = 401, condition = "Unauthorized"),
262 @ResponseCode(code = 403, condition = "Forbidden"),
263 @ResponseCode(code = 404, condition = "Not Found"),
264 @ResponseCode(code = 501, condition = "Not Implemented") })
265 public Response updateFirewall(
266 @PathParam("firewallUUID") String firewallUUID, final NeutronFirewallRequest input) {
267 INeutronFirewallCRUD firewallInterface = NeutronCRUDInterfaces.getINeutronFirewallCRUD(this);
268 if (firewallInterface == null) {
269 throw new ServiceUnavailableException("Firewall CRUD Interface "
270 + RestMessages.SERVICEUNAVAILABLE.toString());
274 * verify the Firewall exists and there is only one delta provided
276 if (!firewallInterface.neutronFirewallExists(firewallUUID)) {
277 throw new ResourceNotFoundException("Firewall UUID does not exist.");
279 if (!input.isSingleton()) {
280 throw new BadRequestException("Only singleton edit supported");
282 NeutronFirewall delta = input.getSingleton();
283 NeutronFirewall original = firewallInterface.getNeutronFirewall(firewallUUID);
286 * updates restricted by Neutron
288 if (delta.getFirewallUUID() != null ||
289 delta.getFirewallTenantID() != null ||
290 delta.getFirewallName() != null ||
291 delta.getFirewallDescription() != null ||
292 delta.getFirewallAdminStateIsUp() != null ||
293 delta.getFirewallStatus() != null ||
294 delta.getFirewallIsShared() != null ||
295 delta.getFirewallPolicyID() != null) {
296 throw new BadRequestException("Attribute edit blocked by Neutron");
299 Object[] instances = NeutronUtil.getInstances(INeutronFirewallAware.class, this);
300 if (instances != null) {
301 for (Object instance : instances) {
302 INeutronFirewallAware service = (INeutronFirewallAware) instance;
303 int status = service.canUpdateNeutronFirewall(delta, original);
304 if (status < 200 || status > 299) {
305 return Response.status(status).build();
311 * update the object and return it
313 firewallInterface.updateNeutronFirewall(firewallUUID, delta);
314 NeutronFirewall updatedFirewall = firewallInterface.getNeutronFirewall(firewallUUID);
315 if (instances != null) {
316 for (Object instance : instances) {
317 INeutronFirewallAware service = (INeutronFirewallAware) instance;
318 service.neutronFirewallUpdated(updatedFirewall);
321 return Response.status(200).entity(new NeutronFirewallRequest(firewallInterface.getNeutronFirewall(firewallUUID))).build();
325 * Deletes a Firewall */
327 @Path("{firewallUUID}")
330 @ResponseCode(code = 204, condition = "No Content"),
331 @ResponseCode(code = 401, condition = "Unauthorized"),
332 @ResponseCode(code = 404, condition = "Not Found"),
333 @ResponseCode(code = 409, condition = "Conflict"),
334 @ResponseCode(code = 501, condition = "Not Implemented") })
335 public Response deleteFirewall(
336 @PathParam("firewallUUID") String firewallUUID) {
337 INeutronFirewallCRUD firewallInterface = NeutronCRUDInterfaces.getINeutronFirewallCRUD(this);
338 if (firewallInterface == null) {
339 throw new ServiceUnavailableException("Firewall CRUD Interface "
340 + RestMessages.SERVICEUNAVAILABLE.toString());
344 * verify the Firewall exists and it isn't currently in use
346 if (!firewallInterface.neutronFirewallExists(firewallUUID)) {
347 throw new ResourceNotFoundException("Firewall UUID does not exist.");
349 if (firewallInterface.neutronFirewallInUse(firewallUUID)) {
350 return Response.status(409).build();
352 NeutronFirewall singleton = firewallInterface.getNeutronFirewall(firewallUUID);
353 Object[] instances = NeutronUtil.getInstances(INeutronFirewallAware.class, this);
354 if (instances != null) {
355 for (Object instance : instances) {
356 INeutronFirewallAware service = (INeutronFirewallAware) instance;
357 int status = service.canDeleteNeutronFirewall(singleton);
358 if (status < 200 || status > 299) {
359 return Response.status(status).build();
365 * remove it and return 204 status
367 firewallInterface.removeNeutronFirewall(firewallUUID);
368 if (instances != null) {
369 for (Object instance : instances) {
370 INeutronFirewallAware service = (INeutronFirewallAware) instance;
371 service.neutronFirewallDeleted(singleton);
374 return Response.status(204).build();