package org.opendaylight.controller.networkconfig.neutron.northbound;
import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
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.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.UriInfo;
import javax.ws.rs.core.Response;
import org.codehaus.enunciate.jaxrs.ResponseCode;
import org.opendaylight.controller.networkconfig.neutron.NeutronCRUDInterfaces;
import org.opendaylight.controller.networkconfig.neutron.NeutronNetwork;
import org.opendaylight.controller.northbound.commons.RestMessages;
+import org.opendaylight.controller.northbound.commons.exception.BadRequestException;
+import org.opendaylight.controller.northbound.commons.exception.ResourceConflictException;
+import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException;
import org.opendaylight.controller.sal.utils.ServiceHelper;
/**
- * Open DOVE Northbound REST APIs for Network.<br>
- * This class provides REST APIs for managing open DOVE internals related to Networks
+ * Neutron Northbound REST APIs for Network.<br>
+ * This class provides REST APIs for managing neutron Networks
*
* <br>
* <br>
@Path("/networks")
public class NeutronNetworksNorthbound {
+ @Context
+ UriInfo uriInfo;
+
private NeutronNetwork extractFields(NeutronNetwork o, List<String> fields) {
return o.extractFields(fields);
}
@Produces({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackNetworks.class)
@StatusCodes({
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 401, condition = "Unauthorized") })
+ @ResponseCode(code = 200, condition = "Operation successful"),
+ @ResponseCode(code = 401, condition = "Unauthorized")})
public Response listNetworks(
// return fields
@QueryParam("fields") List<String> fields,
@QueryParam("provider_physical_network") String queryProviderPhysicalNetwork,
@QueryParam("provider_segmentation_id") String queryProviderSegmentationID,
// pagination
- @QueryParam("limit") String limit,
+ @QueryParam("limit") Integer limit,
@QueryParam("marker") String marker,
- @QueryParam("page_reverse") String pageReverse
+ @DefaultValue("false") @QueryParam("page_reverse") Boolean pageReverse
// sorting not supported
- ) {
+ ) {
INeutronNetworkCRUD networkInterface = NeutronCRUDInterfaces.getINeutronNetworkCRUD( this);
if (networkInterface == null) {
throw new ServiceUnavailableException("Network CRUD Interface "
Boolean bAdminStateUp = null;
Boolean bShared = null;
Boolean bRouterExternal = null;
- if (queryAdminStateUp != null)
+ if (queryAdminStateUp != null) {
bAdminStateUp = Boolean.valueOf(queryAdminStateUp);
- if (queryShared != null)
+ }
+ if (queryShared != null) {
bShared = Boolean.valueOf(queryShared);
- if (queryRouterExternal != null)
+ }
+ if (queryRouterExternal != null) {
bRouterExternal = Boolean.valueOf(queryRouterExternal);
+ }
if ((queryID == null || queryID.equals(oSN.getID())) &&
(queryName == null || queryName.equals(oSN.getNetworkName())) &&
(bAdminStateUp == null || bAdminStateUp.booleanValue() == oSN.isAdminStateUp()) &&
(bShared == null || bShared.booleanValue() == oSN.isShared()) &&
(bRouterExternal == null || bRouterExternal.booleanValue() == oSN.isRouterExternal()) &&
(queryTenantID == null || queryTenantID.equals(oSN.getTenantID()))) {
- if (fields.size() > 0)
+ if (fields.size() > 0) {
ans.add(extractFields(oSN,fields));
- else
+ } else {
ans.add(oSN);
+ }
+ }
+ }
+
+ Comparator<NeutronNetwork> neutronNetworkComparator = new Comparator<NeutronNetwork>() {
+ @Override
+ public int compare(NeutronNetwork o1, NeutronNetwork o2) {
+ return o1.getID().compareTo(o2.getID());
+ }
+ };
+
+ Collections.sort(ans, neutronNetworkComparator);
+
+ if (limit != null && ans.size() > 1) {
+ List<NeutronPageLink> links = new ArrayList<>();
+ Integer startPos = null;
+ String startMarker;
+ String endMarker;
+ Boolean firstPage = false;
+ Boolean lastPage = false;
+
+ if (marker == null) {
+ startPos = 0;
+ }
+
+ else {
+
+ NeutronNetwork markerNetwork = new NeutronNetwork();
+ markerNetwork.setNetworkUUID(marker);
+
+ startPos = Collections.binarySearch(ans, markerNetwork, neutronNetworkComparator);
+
+ if (!pageReverse){
+ startPos = startPos + 1;
+ }
+ else {
+ startPos = startPos - limit;
+ }
+
+ }
+
+ if (startPos == null) {
+ throw new ResourceNotFoundException("UUID for marker:" + marker + " could not be found");
+ }
+
+ if (startPos == 0){
+ firstPage = true;
+ }
+
+ if (startPos + limit >= ans.size()) {
+ ans = ans.subList(startPos, ans.size());
+ startMarker = ans.get(0).getID();
+ endMarker = ans.get(ans.size() - 1).getID();
+ lastPage = true;
+ }
+ else if (startPos < 0) {
+ if (startPos + limit > 0) {
+ ans = ans.subList(0, startPos + limit);
+ startMarker = ans.get(0).getID();
+ endMarker = ans.get(ans.size() - 1).getID();
+ firstPage = true;
+ }
+ else {
+ throw new BadRequestException("Requested page is out of bounds. Please check the supplied limit and marker");
+ }
}
+ else {
+ ans = ans.subList(startPos, startPos + limit);
+ startMarker = ans.get(0).getID();
+ endMarker = ans.get(limit-1).getID();
+ }
+
+ if (!lastPage) {
+ NeutronPageLink next = new NeutronPageLink();
+ next.setRef("next");
+ next.setHref(uriInfo.getAbsolutePath().toString() + "?limit=" + limit.toString() + "&marker=" + endMarker);
+ links.add(next);
+ }
+
+ if (!firstPage) {
+ NeutronPageLink previous = new NeutronPageLink();
+ previous.setRef("previous");
+ previous.setHref(uriInfo.getAbsolutePath().toString() + "?limit=" + limit.toString() + "&marker=" + startMarker + "&page_reverse=True");
+ links.add(previous);
+ }
+
+ return Response.status(200).entity(new PaginatedNeutronNetworkRequest(ans, links)).build();
}
- //TODO: apply pagination to results
- return Response.status(200).entity(
- new NeutronNetworkRequest(ans)).build();
+
+ return Response.status(200).entity(new NeutronNetworkRequest(ans)).build();
+
}
/**
@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") })
+ @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
throw new ServiceUnavailableException("Network CRUD Interface "
+ RestMessages.SERVICEUNAVAILABLE.toString());
}
- if (!networkInterface.networkExists(netUUID))
- return Response.status(404).build();
+ if (!networkInterface.networkExists(netUUID)) {
+ throw new ResourceNotFoundException("network UUID does not exist.");
+ }
if (fields.size() > 0) {
NeutronNetwork ans = networkInterface.getNetwork(netUUID);
return Response.status(200).entity(
new NeutronNetworkRequest(extractFields(ans, fields))).build();
- } else
+ } else {
return Response.status(200).entity(
new NeutronNetworkRequest(networkInterface.getNetwork(netUUID))).build();
+ }
}
/**
@Consumes({ MediaType.APPLICATION_JSON })
@TypeHint(NeutronNetwork.class)
@StatusCodes({
- @ResponseCode(code = 201, condition = "Created"),
- @ResponseCode(code = 400, condition = "Bad Request"),
- @ResponseCode(code = 401, condition = "Unauthorized") })
+ @ResponseCode(code = 201, condition = "Created"),
+ @ResponseCode(code = 400, condition = "Bad Request"),
+ @ResponseCode(code = 401, condition = "Unauthorized") })
public Response createNetworks(final NeutronNetworkRequest input) {
INeutronNetworkCRUD networkInterface = NeutronCRUDInterfaces.getINeutronNetworkCRUD( this);
if (networkInterface == null) {
/*
* network ID can't already exist
*/
- if (networkInterface.networkExists(singleton.getID()))
- return Response.status(400).build();
+ if (networkInterface.networkExists(singleton.getID())) {
+ throw new BadRequestException("network UUID already exists");
+ }
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)
+ if (status < 200 || status > 299) {
return Response.status(status).build();
+ }
}
}
// add network to cache
+ singleton.initDefaults();
networkInterface.addNetwork(singleton);
if (instances != null) {
for (Object instance : instances) {
* 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 (networkInterface.networkExists(test.getID())) {
+ throw new BadRequestException("network UUID already exists");
+ }
+ if (testMap.containsKey(test.getID())) {
+ throw new BadRequestException("network UUID already exists");
+ }
if (instances != null) {
for (Object instance: instances) {
INeutronNetworkAware service = (INeutronNetworkAware) instance;
int status = service.canCreateNetwork(test);
- if (status < 200 || status > 299)
+ if (status < 200 || status > 299) {
return Response.status(status).build();
+ }
}
}
testMap.put(test.getID(),test);
@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"), })
+ @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
) {
/*
* 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();
+ if (!networkInterface.networkExists(netUUID)) {
+ throw new ResourceNotFoundException("network UUID does not exist.");
+ }
+ if (!input.isSingleton()) {
+ throw new BadRequestException("only singleton edits supported");
+ }
NeutronNetwork delta = input.getSingleton();
/*
* transitions forbidden by Neutron
*/
if (delta.getID() != null || delta.getTenantID() != null ||
- delta.getStatus() != null)
- return Response.status(400).build();
+ delta.getStatus() != null) {
+ throw new BadRequestException("attribute edit blocked by Neutron");
+ }
Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null);
if (instances != null) {
INeutronNetworkAware service = (INeutronNetworkAware) instance;
NeutronNetwork original = networkInterface.getNetwork(netUUID);
int status = service.canUpdateNetwork(delta, original);
- if (status < 200 || status > 299)
+ 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();
+ 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();
}
/**
@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") })
+ @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 = NeutronCRUDInterfaces.getINeutronNetworkCRUD( this);
/*
* 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();
+ if (!networkInterface.networkExists(netUUID)) {
+ throw new ResourceNotFoundException("network UUID does not exist.");
+ }
+ if (networkInterface.networkInUse(netUUID)) {
+ throw new ResourceConflictException("Network ID in use");
+ }
NeutronNetwork singleton = networkInterface.getNetwork(netUUID);
Object[] instances = ServiceHelper.getGlobalInstances(INeutronNetworkAware.class, this, null);
for (Object instance : instances) {
INeutronNetworkAware service = (INeutronNetworkAware) instance;
int status = service.canDeleteNetwork(singleton);
- if (status < 200 || status > 299)
+ if (status < 200 || status > 299) {
return Response.status(status).build();
+ }
}
}
networkInterface.removeNetwork(netUUID);
Code Review / controller.git / blobdiff