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
10 package org.opendaylight.controller.networkconfig.neutron.northbound;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.Iterator;
16 import java.util.List;
18 import javax.ws.rs.Consumes;
19 import javax.ws.rs.DELETE;
20 import javax.ws.rs.GET;
21 import javax.ws.rs.POST;
22 import javax.ws.rs.PUT;
23 import javax.ws.rs.Path;
24 import javax.ws.rs.PathParam;
25 import javax.ws.rs.Produces;
26 import javax.ws.rs.QueryParam;
27 import javax.ws.rs.core.MediaType;
28 import javax.ws.rs.core.Response;
30 import org.codehaus.enunciate.jaxrs.ResponseCode;
31 import org.codehaus.enunciate.jaxrs.StatusCodes;
32 import org.opendaylight.controller.networkconfig.neutron.INeutronSecurityGroupAware;
33 import org.opendaylight.controller.networkconfig.neutron.INeutronSecurityGroupCRUD;
34 import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
35 import org.opendaylight.controller.networkconfig.neutron.NeutronSecurityGroup;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * Neutron Northbound REST APIs for Security Group.<br>
41 * This class provides REST APIs for managing neutron Security Group
45 * Authentication scheme : <b>HTTP Basic</b><br>
46 * Authentication realm : <b>opendaylight</b><br>
47 * Transport : <b>HTTP and HTTPS</b><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>
53 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
55 @Path ("/security-groups")
56 public class NeutronSecurityGroupsNorthbound {
57 static final Logger logger = LoggerFactory.getLogger(NeutronSecurityGroupsNorthbound.class);
59 private NeutronSecurityGroup extractFields(NeutronSecurityGroup o, List<String> fields) {
60 return o.extractFields(fields);
64 * Returns a list of all Security Groups
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 security group attributes
77 @QueryParam ("id") String querySecurityGroupUUID,
78 @QueryParam ("name") String querySecurityGroupName,
79 @QueryParam ("description") String querySecurityDescription,
80 @QueryParam ("tenant_id") String querySecurityTenantID,
81 @QueryParam ("limit") String limit,
82 @QueryParam ("marker") String marker,
83 @QueryParam ("page_reverse") String pageReverse
85 INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
87 if (securityGroupInterface == null) {
88 throw new ServiceUnavailableException("Security Group CRUD Interface "
89 + RestMessages.SERVICEUNAVAILABLE.toString());
91 List<NeutronSecurityGroup> allSecurityGroups = securityGroupInterface.getAllNeutronSecurityGroups();
92 List<NeutronSecurityGroup> ans = new ArrayList<NeutronSecurityGroup>();
93 Iterator<NeutronSecurityGroup> i = allSecurityGroups.iterator();
95 NeutronSecurityGroup nsg = i.next();
96 if ((querySecurityGroupUUID == null ||
97 querySecurityGroupUUID.equals(nsg.getSecurityGroupUUID())) &&
98 (querySecurityGroupName == null ||
99 querySecurityGroupName.equals(nsg.getSecurityGroupName())) &&
100 (querySecurityDescription == null ||
101 querySecurityDescription.equals(nsg.getSecurityGroupDescription())) &&
102 (querySecurityTenantID == null ||
103 querySecurityTenantID.equals(nsg.getSecurityGroupTenantID()))) {
104 if (fields.size() > 0) {
105 ans.add(extractFields(nsg, fields));
111 return Response.status(200).entity(
112 new NeutronSecurityGroupRequest(ans)).build();
116 * Returns a specific Security Group
119 @Path ("{securityGroupUUID}")
121 @Produces ({MediaType.APPLICATION_JSON})
123 @ResponseCode (code = 200, condition = "Operation successful"),
124 @ResponseCode (code = 401, condition = "Unauthorized"),
125 @ResponseCode (code = 404, condition = "Not Found"),
126 @ResponseCode (code = 501, condition = "Not Implemented")})
127 public Response showSecurityGroup(@PathParam ("securityGroupUUID") String securityGroupUUID,
129 @QueryParam ("fields") List<String> fields) {
130 INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
131 if (securityGroupInterface == null) {
132 throw new ServiceUnavailableException("Security Group CRUD Interface "
133 + RestMessages.SERVICEUNAVAILABLE.toString());
135 if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
136 throw new ResourceNotFoundException("Security Group UUID does not exist.");
138 if (!fields.isEmpty()) {
139 NeutronSecurityGroup ans = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
140 return Response.status(200).entity(
141 new NeutronSecurityGroupRequest(extractFields(ans, fields))).build();
143 return Response.status(200).entity(new NeutronSecurityGroupRequest(securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID))).build();
148 * Creates new Security Group
152 @Produces ({MediaType.APPLICATION_JSON})
153 @Consumes ({MediaType.APPLICATION_JSON})
155 @ResponseCode (code = 201, condition = "Created"),
156 @ResponseCode (code = 400, condition = "Bad Request"),
157 @ResponseCode (code = 401, condition = "Unauthorized"),
158 @ResponseCode (code = 403, condition = "Forbidden"),
159 @ResponseCode (code = 404, condition = "Not Found"),
160 @ResponseCode (code = 409, condition = "Conflict"),
161 @ResponseCode (code = 501, condition = "Not Implemented")})
162 public Response createSecurityGroups(final NeutronSecurityGroupRequest input) {
163 INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
164 if (securityGroupInterface == null) {
165 throw new ServiceUnavailableException("Security Group CRUD Interface "
166 + RestMessages.SERVICEUNAVAILABLE.toString());
169 if (input.isSingleton()) {
170 NeutronSecurityGroup singleton = input.getSingleton();
173 * Verify that the Security Group doesn't already exist.
175 if (securityGroupInterface.neutronSecurityGroupExists(singleton.getSecurityGroupUUID())) {
176 throw new BadRequestException("Security Group UUID already exists");
179 Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
180 if (instances != null) {
181 if (instances.length > 0) {
182 for (Object instance : instances) {
183 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
184 int status = service.canCreateNeutronSecurityGroup(singleton);
185 if (status < 200 || status > 299) {
186 return Response.status(status).build();
190 throw new ServiceUnavailableException("No providers registered. Please try again later");
193 throw new ServiceUnavailableException("Couldn't get providers list. Please try again later");
195 // Add to Neutron cache
196 securityGroupInterface.addNeutronSecurityGroup(singleton);
197 if (instances != null) {
198 for (Object instance : instances) {
199 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
200 service.neutronSecurityGroupCreated(singleton);
204 List<NeutronSecurityGroup> bulk = input.getBulk();
205 Iterator<NeutronSecurityGroup> i = bulk.iterator();
206 HashMap<String, NeutronSecurityGroup> testMap = new HashMap<String, NeutronSecurityGroup>();
207 Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
208 while (i.hasNext()) {
209 NeutronSecurityGroup test = i.next();
212 * Verify that the security group doesn't already exist
215 if (securityGroupInterface.neutronSecurityGroupExists(test.getSecurityGroupUUID())) {
216 throw new BadRequestException("Security Group UUID already is already created");
218 if (instances != null) {
219 if (instances.length > 0) {
220 for (Object instance : instances) {
221 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
222 int status = service.canCreateNeutronSecurityGroup(test);
223 if ((status < 200) || (status > 299)) return Response.status(status).build();
226 throw new BadRequestException("No providers registered. Please try again later");
229 throw new ServiceUnavailableException("Couldn't get providers list. Please try again later");
234 * now, each element of the bulk request can be added to the cache
237 while (i.hasNext()) {
238 NeutronSecurityGroup test = i.next();
239 securityGroupInterface.addNeutronSecurityGroup(test);
240 if (instances != null) {
241 for (Object instance : instances) {
242 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
243 service.neutronSecurityGroupCreated(test);
248 return Response.status(201).entity(input).build();
252 * Updates a Security Group
255 @Path ("{securityGroupUUID}")
257 @Produces ({MediaType.APPLICATION_JSON})
258 @Consumes ({MediaType.APPLICATION_JSON})
260 @ResponseCode (code = 200, condition = "Operation successful"),
261 @ResponseCode (code = 400, condition = "Bad Request"),
262 @ResponseCode (code = 401, condition = "Unauthorized"),
263 @ResponseCode (code = 403, condition = "Forbidden"),
264 @ResponseCode (code = 404, condition = "Not Found"),
265 @ResponseCode (code = 501, condition = "Not Implemented")})
266 public Response updateSecurityGroup(
267 @PathParam ("securityGroupUUID") String securityGroupUUID, final NeutronSecurityGroupRequest input) {
268 INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
269 if (securityGroupInterface == null) {
270 throw new ServiceUnavailableException("Security Group CRUD Interface "
271 + RestMessages.SERVICEUNAVAILABLE.toString());
275 * verify the Security Group exists and there is only one delta provided
277 if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
278 throw new ResourceNotFoundException("Security Group UUID does not exist.");
280 if (!input.isSingleton()) {
281 throw new BadRequestException("Only singleton edit supported");
283 NeutronSecurityGroup delta = input.getSingleton();
284 NeutronSecurityGroup original = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
286 if (delta.getSecurityGroupUUID() != null ||
287 delta.getSecurityGroupTenantID() != null ||
288 delta.getSecurityGroupName() != null ||
289 delta.getSecurityGroupDescription() != null) {
290 throw new BadRequestException("Attribute edit blocked by Neutron");
293 Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
294 if (instances != null) {
295 if (instances.length > 0) {
296 for (Object instance : instances) {
297 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
298 int status = service.canUpdateNeutronSecurityGroup(delta, original);
299 if (status < 200 || status > 299) {
300 return Response.status(status).build();
304 throw new ServiceUnavailableException("No providers registered. Please try again later");
307 throw new ServiceUnavailableException("Couldn't get providers list. Please try again later");
311 * update the object and return it
313 securityGroupInterface.updateNeutronSecurityGroup(securityGroupUUID, delta);
314 NeutronSecurityGroup updatedSecurityGroup = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
315 if (instances != null) {
316 for (Object instance : instances) {
317 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
318 service.neutronSecurityGroupUpdated(updatedSecurityGroup);
321 return Response.status(200).entity(new NeutronSecurityGroupRequest(securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID))).build();
325 * Deletes a Security Group
328 @Path ("{securityGroupUUID}")
331 @ResponseCode (code = 204, condition = "No Content"),
332 @ResponseCode (code = 401, condition = "Unauthorized"),
333 @ResponseCode (code = 404, condition = "Not Found"),
334 @ResponseCode (code = 409, condition = "Conflict"),
335 @ResponseCode (code = 501, condition = "Not Implemented")})
336 public Response deleteSecurityGroup(
337 @PathParam ("securityGroupUUID") String securityGroupUUID) {
338 INeutronSecurityGroupCRUD securityGroupInterface = NeutronCRUDInterfaces.getINeutronSecurityGroupCRUD(this);
339 if (securityGroupInterface == null) {
340 throw new ServiceUnavailableException("Security Group CRUD Interface "
341 + RestMessages.SERVICEUNAVAILABLE.toString());
345 * verify the Security Group exists and it isn't currently in use
347 if (!securityGroupInterface.neutronSecurityGroupExists(securityGroupUUID)) {
348 throw new ResourceNotFoundException("Security Group UUID does not exist.");
350 if (securityGroupInterface.neutronSecurityGroupInUse(securityGroupUUID)) {
351 return Response.status(409).build();
353 NeutronSecurityGroup singleton = securityGroupInterface.getNeutronSecurityGroup(securityGroupUUID);
354 Object[] instances = NeutronUtil.getInstances(INeutronSecurityGroupAware.class, this);
355 if (instances != null) {
356 if (instances.length > 0) {
357 for (Object instance : instances) {
358 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
359 int status = service.canDeleteNeutronSecurityGroup(singleton);
360 if ((status < 200) || (status > 299)) {
361 return Response.status(status).build();
365 throw new ServiceUnavailableException("No providers registered. Please try again later");
368 throw new ServiceUnavailableException("Couldn't get providers list. Please try again later");
372 * remove it and return 204 status
374 securityGroupInterface.removeNeutronSecurityGroup(securityGroupUUID);
375 if (instances != null) {
376 for (Object instance : instances) {
377 INeutronSecurityGroupAware service = (INeutronSecurityGroupAware) instance;
378 service.neutronSecurityGroupDeleted(singleton);
381 return Response.status(204).build();