2 * Copyright (c) 2013, 2015 IBM Corporation and others. All rights reserved.
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.neutron.northbound.api;
11 import java.net.HttpURLConnection;
13 import java.util.ArrayList;
14 import java.util.Iterator;
15 import java.util.List;
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;
29 import org.codehaus.enunciate.jaxrs.ResponseCode;
30 import org.codehaus.enunciate.jaxrs.StatusCodes;
31 import org.opendaylight.neutron.spi.INeutronNetworkCRUD;
32 import org.opendaylight.neutron.spi.INeutronPortCRUD;
33 import org.opendaylight.neutron.spi.INeutronRouterAware;
34 import org.opendaylight.neutron.spi.INeutronRouterCRUD;
35 import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
36 import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
37 import org.opendaylight.neutron.spi.NeutronRouter;
38 import org.opendaylight.neutron.spi.NeutronRouter_Interface;
42 * Neutron Northbound REST APIs.<br>
43 * This class provides REST APIs for managing neutron routers
47 * Authentication scheme : <b>HTTP Basic</b><br>
48 * Authentication realm : <b>opendaylight</b><br>
49 * Transport : <b>HTTP and HTTPS</b><br>
51 * HTTPS Authentication is disabled by default. Administrator can enable it in
52 * tomcat-server.xml after adding a proper keystore / SSL certificate from a
53 * trusted authority.<br>
55 * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
60 public class NeutronRoutersNorthbound
61 extends AbstractNeutronNorthboundIAware<NeutronRouter, NeutronRouterRequest, INeutronRouterCRUD, INeutronRouterAware> {
62 static final String ROUTER_INTERFACE_STR = "network:router_interface";
63 static final String ROUTER_GATEWAY_STR = "network:router_gateway";
64 private static final String RESOURCE_NAME = "Router";
67 protected String getResourceName() {
72 protected NeutronRouter extractFields(NeutronRouter o, List<String> fields) {
73 return o.extractFields(fields);
76 private NeutronCRUDInterfaces getNeutronInterfaces(boolean flag) {
77 NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronRouterCRUD(this);
78 if (answer.getRouterInterface() == null) {
79 throw new ServiceUnavailableException(serviceUnavailable());
82 answer = answer.fetchINeutronNetworkCRUD(this);
83 if (answer.getNetworkInterface() == null) {
84 throw new ServiceUnavailableException("Network CRUD Interface "
85 + RestMessages.SERVICEUNAVAILABLE.toString());
92 protected INeutronRouterCRUD getNeutronCRUD() {
93 return getNeutronInterfaces(false).getRouterInterface();
96 private NeutronCRUDInterfaces getAttachInterfaces() {
97 NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronRouterCRUD(this);
98 if (answer.getRouterInterface() == null) {
99 throw new ServiceUnavailableException(serviceUnavailable());
101 answer = answer.fetchINeutronPortCRUD(this).fetchINeutronSubnetCRUD(this);
102 if (answer.getPortInterface() == null) {
103 throw new ServiceUnavailableException("Port CRUD Interface "
104 + RestMessages.SERVICEUNAVAILABLE.toString());
106 if (answer.getSubnetInterface() == null) {
107 throw new ServiceUnavailableException("Subnet CRUD Interface "
108 + RestMessages.SERVICEUNAVAILABLE.toString());
114 protected NeutronRouterRequest newNeutronRequest(NeutronRouter o) {
115 return new NeutronRouterRequest(o);
119 protected Object[] getInstances() {
120 return NeutronUtil.getInstances(INeutronRouterAware.class, this);
124 protected int canCreate(Object instance, NeutronRouter singleton) {
125 INeutronRouterAware service = (INeutronRouterAware) instance;
126 return service.canCreateRouter(singleton);
130 protected void created(Object instance, NeutronRouter singleton) {
131 INeutronRouterAware service = (INeutronRouterAware) instance;
132 service.neutronRouterCreated(singleton);
136 protected int canUpdate(Object instance, NeutronRouter delta, NeutronRouter original) {
137 INeutronRouterAware service = (INeutronRouterAware) instance;
138 return service.canUpdateRouter(delta, original);
142 protected void updated(Object instance, NeutronRouter updated) {
143 INeutronRouterAware service = (INeutronRouterAware) instance;
144 service.neutronRouterUpdated(updated);
148 protected int canDelete(Object instance, NeutronRouter singleton) {
149 INeutronRouterAware service = (INeutronRouterAware) instance;
150 return service.canDeleteRouter(singleton);
154 protected void deleted(Object instance, NeutronRouter singleton) {
155 INeutronRouterAware service = (INeutronRouterAware) instance;
156 service.neutronRouterDeleted(singleton);
160 * Returns a list of all Routers */
163 @Produces({ MediaType.APPLICATION_JSON })
164 //@TypeHint(OpenStackRouters.class)
166 @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
167 @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
168 @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
169 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
170 public Response listRouters(
172 @QueryParam("fields") List<String> fields,
173 // note: openstack isn't clear about filtering on lists, so we aren't handling them
174 @QueryParam("id") String queryID,
175 @QueryParam("name") String queryName,
176 @QueryParam("admin_state_up") String queryAdminStateUp,
177 @QueryParam("status") String queryStatus,
178 @QueryParam("tenant_id") String queryTenantID,
179 @QueryParam("external_gateway_info") String queryExternalGatewayInfo,
181 @QueryParam("limit") String limit,
182 @QueryParam("marker") String marker,
183 @QueryParam("page_reverse") String pageReverse
184 // sorting not supported
186 INeutronRouterCRUD routerInterface = getNeutronInterfaces(false).getRouterInterface();
187 if (routerInterface == null) {
188 throw new ServiceUnavailableException(serviceUnavailable());
190 List<NeutronRouter> allRouters = routerInterface.getAllRouters();
191 List<NeutronRouter> ans = new ArrayList<NeutronRouter>();
192 Iterator<NeutronRouter> i = allRouters.iterator();
193 while (i.hasNext()) {
194 NeutronRouter oSS = i.next();
195 if ((queryID == null || queryID.equals(oSS.getID())) &&
196 (queryName == null || queryName.equals(oSS.getName())) &&
197 (queryAdminStateUp == null || queryAdminStateUp.equals(oSS.getAdminStateUp())) &&
198 (queryStatus == null || queryStatus.equals(oSS.getStatus())) &&
199 (queryExternalGatewayInfo == null || queryExternalGatewayInfo.equals(oSS.getExternalGatewayInfo())) &&
200 (queryTenantID == null || queryTenantID.equals(oSS.getTenantID()))) {
201 if (fields.size() > 0) {
202 ans.add(extractFields(oSS,fields));
208 //TODO: apply pagination to results
209 return Response.status(HttpURLConnection.HTTP_OK).entity(
210 new NeutronRouterRequest(ans)).build();
214 * Returns a specific Router */
216 @Path("{routerUUID}")
218 @Produces({ MediaType.APPLICATION_JSON })
219 //@TypeHint(OpenStackRouters.class)
221 @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
222 @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
223 @ResponseCode(code = HttpURLConnection.HTTP_FORBIDDEN, condition = "Forbidden"),
224 @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
225 @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
226 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
227 public Response showRouter(
228 @PathParam("routerUUID") String routerUUID,
230 @QueryParam("fields") List<String> fields) {
231 return show(routerUUID, fields);
235 * Creates new Routers */
238 @Produces({ MediaType.APPLICATION_JSON })
239 @Consumes({ MediaType.APPLICATION_JSON })
240 //@TypeHint(OpenStackRouters.class)
242 @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
243 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
244 public Response createRouters(final NeutronRouterRequest input) {
245 getNeutronInterfaces(true); // ensure that network service is loaded
246 return create(input);
250 protected void updateDelta(String uuid, NeutronRouter delta, NeutronRouter original) {
252 delta.setTenantID(original.getTenantID());
256 * Updates a Router */
258 @Path("{routerUUID}")
260 @Produces({ MediaType.APPLICATION_JSON })
261 @Consumes({ MediaType.APPLICATION_JSON })
262 //@TypeHint(OpenStackRouters.class)
264 @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
265 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
266 public Response updateRouter(
267 @PathParam("routerUUID") String routerUUID,
268 NeutronRouterRequest input
270 getNeutronInterfaces(true); // ensure that network service is loaded
271 return update(routerUUID, input);
275 * Deletes a Router */
277 @Path("{routerUUID}")
280 @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
281 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
282 public Response deleteRouter(
283 @PathParam("routerUUID") String routerUUID) {
284 return delete(routerUUID);
288 * Adds an interface to a router */
290 @Path("{routerUUID}/add_router_interface")
292 @Produces({ MediaType.APPLICATION_JSON })
293 @Consumes({ MediaType.APPLICATION_JSON })
294 //@TypeHint(OpenStackRouterInterfaces.class)
296 @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
297 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
298 public Response addRouterInterface(
299 @PathParam("routerUUID") String routerUUID,
300 NeutronRouter_Interface input
302 NeutronCRUDInterfaces interfaces = getAttachInterfaces();
303 INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
305 NeutronRouter target = routerInterface.getRouter(routerUUID);
306 Object[] instances = getInstances();
307 if (instances != null) {
308 for (Object instance : instances) {
309 INeutronRouterAware service = (INeutronRouterAware) instance;
310 int status = service.canAttachInterface(target, input);
311 if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
312 return Response.status(status).build();
317 target.addInterface(input.getPortUUID(), input);
318 if (instances != null) {
319 for (Object instance : instances) {
320 INeutronRouterAware service = (INeutronRouterAware) instance;
321 service.neutronRouterInterfaceAttached(target, input);
325 return Response.status(HttpURLConnection.HTTP_OK).entity(input).build();
329 private int checkDownstreamDetach(NeutronRouter target, NeutronRouter_Interface input) {
330 Object[] instances = getInstances();
331 if (instances != null) {
332 for (Object instance : instances) {
333 INeutronRouterAware service = (INeutronRouterAware) instance;
334 int status = service.canDetachInterface(target, input);
335 if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
340 return HTTP_OK_BOTTOM;
344 * Removes an interface to a router */
346 @Path("{routerUUID}/remove_router_interface")
348 @Produces({ MediaType.APPLICATION_JSON })
349 @Consumes({ MediaType.APPLICATION_JSON })
350 //@TypeHint(OpenStackRouterInterfaces.class)
352 @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
353 @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
354 public Response removeRouterInterface(
355 @PathParam("routerUUID") String routerUUID,
356 NeutronRouter_Interface input
358 NeutronCRUDInterfaces interfaces = getAttachInterfaces();
359 INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
360 Object[] instances = getInstances();
362 NeutronRouter target = routerInterface.getRouter(routerUUID);
363 input.setID(target.getID());
364 input.setTenantID(target.getTenantID());
365 int status = checkDownstreamDetach(target, input);
366 if (status != HTTP_OK_BOTTOM) {
367 return Response.status(status).build();
369 target.removeInterface(input.getPortUUID());
370 if (instances != null) {
371 for (Object instance : instances) {
372 INeutronRouterAware service = (INeutronRouterAware) instance;
373 service.neutronRouterInterfaceDetached(target, input);
376 return Response.status(HttpURLConnection.HTTP_OK).entity(input).build();