/* * Copyright IBM Corporation, 2013. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.controller.networkconfig.neutron.northbound; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; import java.util.List; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import org.codehaus.enunciate.jaxrs.ResponseCode; import org.codehaus.enunciate.jaxrs.StatusCodes; import org.codehaus.enunciate.jaxrs.TypeHint; import org.opendaylight.controller.networkconfig.neutron.INeutronNetworkAware; import org.opendaylight.controller.networkconfig.neutron.INeutronNetworkCRUD; import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork; import org.opendaylight.controller.northbound.commons.RestMessages; import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException; import org.opendaylight.controller.sal.utils.ServiceHelper; /** * Open DOVE Northbound REST APIs for Network.
* This class provides REST APIs for managing open DOVE internals related to Networks * *
*
* Authentication scheme : HTTP Basic
* Authentication realm : opendaylight
* Transport : HTTP and HTTPS
*
* HTTPS Authentication is disabled by default. Administrator can enable it in * tomcat-server.xml after adding a proper keystore / SSL certificate from a * trusted authority.
* More info : * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration * */ @Path("/networks") public class NeutronNetworksNorthbound { private NeutronNetwork extractFields(NeutronNetwork o, List fields) { return o.extractFields(fields); } /** * Returns a list of all Networks */ @GET @Produces({ MediaType.APPLICATION_JSON }) //@TypeHint(OpenStackNetworks.class) @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"), @ResponseCode(code = 401, condition = "Unauthorized") }) public Response listNetworks( // return fields @QueryParam("fields") List fields, // note: openstack isn't clear about filtering on lists, so we aren't handling them @QueryParam("id") String queryID, @QueryParam("name") String queryName, @QueryParam("admin_state_up") String queryAdminStateUp, @QueryParam("status") String queryStatus, @QueryParam("shared") String queryShared, @QueryParam("tenant_id") String queryTenantID, @QueryParam("router_external") String queryRouterExternal, @QueryParam("provider_network_type") String queryProviderNetworkType, @QueryParam("provider_physical_network") String queryProviderPhysicalNetwork, @QueryParam("provider_segmentation_id") String queryProviderSegmentationID, // pagination @QueryParam("limit") String limit, @QueryParam("marker") String marker, @QueryParam("page_reverse") String pageReverse // sorting not supported ) { INeutronNetworkCRUD networkInterface = NeutronNBInterfaces.getIfNBNetworkCRUD("default", this); if (networkInterface == null) { throw new ServiceUnavailableException("Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString()); } List allNetworks = networkInterface.getAllNetworks(); List ans = new ArrayList(); Iterator i = allNetworks.iterator(); while (i.hasNext()) { NeutronNetwork oSN = i.next(); //match filters: TODO provider extension Boolean bAdminStateUp = null; Boolean bShared = null; Boolean bRouterExternal = null; if (queryAdminStateUp != null) bAdminStateUp = new Boolean(queryAdminStateUp); if (queryShared != null) bShared = new Boolean(queryShared); if (queryRouterExternal != null) bRouterExternal = new Boolean(queryRouterExternal); if ((queryID == null || queryID.equals(oSN.getID())) && (queryName == null || queryName.equals(oSN.getNetworkName())) && (bAdminStateUp == null || bAdminStateUp.booleanValue() == oSN.isAdminStateUp()) && (queryStatus == null || queryStatus.equals(oSN.getStatus())) && (bShared == null || bShared.booleanValue() == oSN.isShared()) && (bRouterExternal == null || bRouterExternal.booleanValue() == oSN.isRouterExternal()) && (queryTenantID == null || queryTenantID.equals(oSN.getTenantID()))) { if (fields.size() > 0) ans.add(extractFields(oSN,fields)); else ans.add(oSN); } } //TODO: apply pagination to results return Response.status(200).entity( new NeutronNetworkRequest(ans)).build(); } /** * Returns a specific Network */ @Path("{netUUID}") @GET @Produces({ MediaType.APPLICATION_JSON }) //@TypeHint(OpenStackNetworks.class) @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"), @ResponseCode(code = 401, condition = "Unauthorized"), @ResponseCode(code = 404, condition = "Not Found") }) public Response showNetwork( @PathParam("netUUID") String netUUID, // return fields @QueryParam("fields") List fields ) { INeutronNetworkCRUD networkInterface = NeutronNBInterfaces.getIfNBNetworkCRUD("default", this); if (networkInterface == null) { throw new ServiceUnavailableException("Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString()); } if (!networkInterface.networkExists(netUUID)) return Response.status(404).build(); if (fields.size() > 0) { NeutronNetwork ans = networkInterface.getNetwork(netUUID); return Response.status(200).entity( new NeutronNetworkRequest(extractFields(ans, fields))).build(); } else return Response.status(200).entity( new NeutronNetworkRequest(networkInterface.getNetwork(netUUID))).build(); } /** * Creates new Networks */ @POST @Produces({ MediaType.APPLICATION_JSON }) @Consumes({ MediaType.APPLICATION_JSON }) @TypeHint(NeutronNetwork.class) @StatusCodes({ @ResponseCode(code = 201, condition = "Created"), @ResponseCode(code = 400, condition = "Bad Request"), @ResponseCode(code = 401, condition = "Unauthorized") }) public Response createNetworks(final NeutronNetworkRequest input) { INeutronNetworkCRUD networkInterface = NeutronNBInterfaces.getIfNBNetworkCRUD("default", this); if (networkInterface == null) { throw new ServiceUnavailableException("Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString()); } if (input.isSingleton()) { NeutronNetwork singleton = input.getSingleton(); /* * network ID can't already exist */ if (networkInterface.networkExists(singleton.getID())) return Response.status(400).build(); Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; int status = service.canCreateNetwork(singleton); if (status < 200 || status > 299) return Response.status(status).build(); } } // add network to cache networkInterface.addNetwork(singleton); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; service.neutronNetworkCreated(singleton); } } } else { List bulk = input.getBulk(); Iterator i = bulk.iterator(); HashMap testMap = new HashMap(); Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null); while (i.hasNext()) { NeutronNetwork test = i.next(); /* * network ID can't already exist, nor can there be an entry for this UUID * already in this bulk request */ if (networkInterface.networkExists(test.getID())) return Response.status(400).build(); if (testMap.containsKey(test.getID())) return Response.status(400).build(); if (instances != null) { for (Object instance: instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; int status = service.canCreateNetwork(test); if (status < 200 || status > 299) return Response.status(status).build(); } } testMap.put(test.getID(),test); } // now that everything passed, add items to the cache i = bulk.iterator(); while (i.hasNext()) { NeutronNetwork test = i.next(); test.initDefaults(); networkInterface.addNetwork(test); if (instances != null) { for (Object instance: instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; service.neutronNetworkCreated(test); } } } } return Response.status(201).entity(input).build(); } /** * Updates a Network */ @Path("{netUUID}") @PUT @Produces({ MediaType.APPLICATION_JSON }) @Consumes({ MediaType.APPLICATION_JSON }) //@TypeHint(OpenStackNetworks.class) @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"), @ResponseCode(code = 400, condition = "Bad Request"), @ResponseCode(code = 403, condition = "Forbidden"), @ResponseCode(code = 404, condition = "Not Found"), }) public Response updateNetwork( @PathParam("netUUID") String netUUID, final NeutronNetworkRequest input ) { INeutronNetworkCRUD networkInterface = NeutronNBInterfaces.getIfNBNetworkCRUD("default", this); if (networkInterface == null) { throw new ServiceUnavailableException("Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString()); } /* * network has to exist and only a single delta is supported */ if (!networkInterface.networkExists(netUUID)) return Response.status(404).build(); if (!input.isSingleton()) return Response.status(400).build(); NeutronNetwork delta = input.getSingleton(); /* * transitions forbidden by Neutron */ if (delta.getID() != null || delta.getTenantID() != null || delta.getStatus() != null) return Response.status(400).build(); Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; NeutronNetwork original = networkInterface.getNetwork(netUUID); int status = service.canUpdateNetwork(delta, original); if (status < 200 || status > 299) return Response.status(status).build(); } } // update network object and return the modified object networkInterface.updateNetwork(netUUID, delta); NeutronNetwork updatedSingleton = networkInterface.getNetwork(netUUID); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; service.neutronNetworkUpdated(updatedSingleton); } } return Response.status(200).entity( new NeutronNetworkRequest(networkInterface.getNetwork(netUUID))).build(); } /** * Deletes a Network */ @Path("{netUUID}") @DELETE @StatusCodes({ @ResponseCode(code = 204, condition = "No Content"), @ResponseCode(code = 401, condition = "Unauthorized"), @ResponseCode(code = 404, condition = "Not Found"), @ResponseCode(code = 409, condition = "Network In Use") }) public Response deleteNetwork( @PathParam("netUUID") String netUUID) { INeutronNetworkCRUD networkInterface = NeutronNBInterfaces.getIfNBNetworkCRUD("default", this); if (networkInterface == null) { throw new ServiceUnavailableException("Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString()); } /* * network has to exist and not be in use before it can be removed */ if (!networkInterface.networkExists(netUUID)) return Response.status(404).build(); if (networkInterface.networkInUse(netUUID)) return Response.status(409).build(); NeutronNetwork singleton = networkInterface.getNetwork(netUUID); Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; int status = service.canDeleteNetwork(singleton); if (status < 200 || status > 299) return Response.status(status).build(); } } networkInterface.removeNetwork(netUUID); if (instances != null) { for (Object instance : instances) { INeutronNetworkAware service = (INeutronNetworkAware) instance; service.neutronNetworkDeleted(singleton); } } return Response.status(204).build(); } }