package org.opendaylight.neutron.northbound.api;
import java.net.HttpURLConnection;
-
import java.util.ArrayList;
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.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.opendaylight.neutron.spi.INeutronNetworkCRUD;
-import org.opendaylight.neutron.spi.INeutronPortCRUD;
-import org.opendaylight.neutron.spi.INeutronRouterAware;
import org.opendaylight.neutron.spi.INeutronRouterCRUD;
-import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
import org.opendaylight.neutron.spi.NeutronRouter;
import org.opendaylight.neutron.spi.NeutronRouter_Interface;
-
/**
* Neutron Northbound REST APIs.<br>
* This class provides REST APIs for managing neutron routers
*/
@Path("/routers")
-public class NeutronRoutersNorthbound {
+public final class NeutronRoutersNorthbound
+ extends AbstractNeutronNorthbound<NeutronRouter, NeutronRouterRequest, INeutronRouterCRUD> {
static final String ROUTER_INTERFACE_STR = "network:router_interface";
static final String ROUTER_GATEWAY_STR = "network:router_gateway";
- private static final int HTTP_OK_BOTTOM = 200;
- private static final int HTTP_OK_TOP = 299;
- private static final String INTERFACE_NAME = "Router CRUD Interface";
- private static final String UUID_NO_EXIST = "Router UUID does not exist.";
- private static final String NO_PROVIDERS = "No providers registered. Please try again later";
- private static final String NO_PROVIDER_LIST = "Couldn't get providers list. Please try again later";
+ private static final String RESOURCE_NAME = "Router";
- private NeutronRouter extractFields(NeutronRouter o, List<String> fields) {
- return o.extractFields(fields);
+ @Override
+ protected String getResourceName() {
+ return RESOURCE_NAME;
}
private NeutronCRUDInterfaces getNeutronInterfaces(boolean flag) {
NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronRouterCRUD(this);
if (answer.getRouterInterface() == null) {
- throw new ServiceUnavailableException(INTERFACE_NAME
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException(serviceUnavailable());
}
if (flag) {
answer = answer.fetchINeutronNetworkCRUD(this);
if (answer.getNetworkInterface() == null) {
- throw new ServiceUnavailableException("Network CRUD Interface "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException(
+ "Network CRUD Interface " + RestMessages.SERVICEUNAVAILABLE.toString());
}
}
return answer;
}
- private NeutronCRUDInterfaces getAttachInterfaces() {
- NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronRouterCRUD(this);
- if (answer.getRouterInterface() == null) {
- throw new ServiceUnavailableException(INTERFACE_NAME
- + RestMessages.SERVICEUNAVAILABLE.toString());
- }
- answer = answer.fetchINeutronPortCRUD(this).fetchINeutronSubnetCRUD(this);
- if (answer.getPortInterface() == null) {
- throw new ServiceUnavailableException("Port CRUD Interface "
- + RestMessages.SERVICEUNAVAILABLE.toString());
- }
- if (answer.getSubnetInterface() == null) {
- throw new ServiceUnavailableException("Subnet CRUD Interface "
- + RestMessages.SERVICEUNAVAILABLE.toString());
- }
- return answer;
+ @Override
+ protected INeutronRouterCRUD getNeutronCRUD() {
+ return getNeutronInterfaces(false).getRouterInterface();
}
/**
@GET
@Produces({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouters.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
@ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
// 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("admin_state_up") Boolean queryAdminStateUp,
@QueryParam("status") String queryStatus,
@QueryParam("tenant_id") String queryTenantID,
@QueryParam("external_gateway_info") String queryExternalGatewayInfo,
@QueryParam("limit") String limit,
@QueryParam("marker") String marker,
@QueryParam("page_reverse") String pageReverse
- // sorting not supported
- ) {
+ // sorting not supported
+ ) {
INeutronRouterCRUD routerInterface = getNeutronInterfaces(false).getRouterInterface();
if (routerInterface == null) {
- throw new ServiceUnavailableException(INTERFACE_NAME
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException(serviceUnavailable());
}
- List<NeutronRouter> allRouters = routerInterface.getAllRouters();
- List<NeutronRouter> ans = new ArrayList<NeutronRouter>();
+ List<NeutronRouter> allRouters = routerInterface.getAll();
+ List<NeutronRouter> ans = new ArrayList<>();
Iterator<NeutronRouter> i = allRouters.iterator();
while (i.hasNext()) {
NeutronRouter oSS = i.next();
- if ((queryID == null || queryID.equals(oSS.getID())) &&
- (queryName == null || queryName.equals(oSS.getName())) &&
- (queryAdminStateUp == null || queryAdminStateUp.equals(oSS.getAdminStateUp())) &&
- (queryStatus == null || queryStatus.equals(oSS.getStatus())) &&
- (queryExternalGatewayInfo == null || queryExternalGatewayInfo.equals(oSS.getExternalGatewayInfo())) &&
- (queryTenantID == null || queryTenantID.equals(oSS.getTenantID()))) {
+ if ((queryID == null || queryID.equals(oSS.getID()))
+ && (queryName == null || queryName.equals(oSS.getName()))
+ && (queryAdminStateUp == null || queryAdminStateUp.equals(oSS.getAdminStateUp()))
+ && (queryStatus == null || queryStatus.equals(oSS.getStatus()))
+ && (queryExternalGatewayInfo == null
+ || queryExternalGatewayInfo.equals(oSS.getExternalGatewayInfo()))
+ && (queryTenantID == null || queryTenantID.equals(oSS.getTenantID()))) {
if (fields.size() > 0) {
- ans.add(extractFields(oSS,fields));
+ ans.add(oSS.extractFields(fields));
} else {
ans.add(oSS);
}
}
}
//TODO: apply pagination to results
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronRouterRequest(ans)).build();
+ return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronRouterRequest(ans)).build();
}
/**
@GET
@Produces({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouters.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"),
@ResponseCode(code = HttpURLConnection.HTTP_FORBIDDEN, condition = "Forbidden"),
@ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
@ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
- public Response showRouter(
- @PathParam("routerUUID") String routerUUID,
+ public Response showRouter(@PathParam("routerUUID") String routerUUID,
// return fields
@QueryParam("fields") List<String> fields) {
- INeutronRouterCRUD routerInterface = getNeutronInterfaces(false).getRouterInterface();
- if (routerInterface == null) {
- throw new ServiceUnavailableException(INTERFACE_NAME
- + RestMessages.SERVICEUNAVAILABLE.toString());
- }
- if (!routerInterface.routerExists(routerUUID)) {
- throw new ResourceNotFoundException(UUID_NO_EXIST);
- }
- if (fields.size() > 0) {
- NeutronRouter ans = routerInterface.getRouter(routerUUID);
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronRouterRequest(extractFields(ans, fields))).build();
- } else {
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronRouterRequest(routerInterface.getRouter(routerUUID))).build();
- }
+ return show(routerUUID, fields);
}
/**
@Produces({ MediaType.APPLICATION_JSON })
@Consumes({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouters.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
public Response createRouters(final NeutronRouterRequest input) {
- NeutronCRUDInterfaces interfaces = getNeutronInterfaces(true);
- INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
- if (input.isSingleton()) {
- NeutronRouter singleton = input.getSingleton();
-
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- int status = service.canCreateRouter(singleton);
- if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
- return Response.status(status).build();
- }
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDERS);
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDER_LIST);
- }
-
- /*
- * add router to the cache
- */
- routerInterface.addRouter(singleton);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- service.neutronRouterCreated(singleton);
- }
- }
- } else {
+ getNeutronInterfaces(true); // ensure that network service is loaded
+ return create(input);
+ }
- /*
- * only singleton router creates supported
- */
- throw new BadRequestException("Only singleton router creates supported");
- }
- return Response.status(HttpURLConnection.HTTP_CREATED).entity(input).build();
+ @Override
+ protected void updateDelta(String uuid, NeutronRouter delta, NeutronRouter original) {
+ delta.setID(uuid);
+ delta.setTenantID(original.getTenantID());
}
/**
@Produces({ MediaType.APPLICATION_JSON })
@Consumes({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouters.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
+ @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
- public Response updateRouter(
- @PathParam("routerUUID") String routerUUID,
- NeutronRouterRequest input
- ) {
- NeutronCRUDInterfaces interfaces = getNeutronInterfaces(true);
- INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
- INeutronNetworkCRUD networkInterface = interfaces.getNetworkInterface();
-
- NeutronRouter updatedRouter = input.getSingleton();
- NeutronRouter original = routerInterface.getRouter(routerUUID);
- updatedRouter.setID(routerUUID);
- updatedRouter.setTenantID(original.getTenantID());
-
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- int status = service.canUpdateRouter(updatedRouter, original);
- if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
- return Response.status(status).build();
- }
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDERS);
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDER_LIST);
- }
-
- /*
- * update the router entry and return the modified object
- */
- routerInterface.updateRouter(routerUUID, updatedRouter);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- service.neutronRouterUpdated(updatedRouter);
- }
- }
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronRouterRequest(routerInterface.getRouter(routerUUID))).build();
-
+ public Response updateRouter(@PathParam("routerUUID") String routerUUID, NeutronRouterRequest input) {
+ getNeutronInterfaces(true); // ensure that network service is loaded
+ return update(routerUUID, input);
}
/**
@Path("{routerUUID}")
@DELETE
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
+ @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
- public Response deleteRouter(
- @PathParam("routerUUID") String routerUUID) {
- INeutronRouterCRUD routerInterface = getNeutronInterfaces(false).getRouterInterface();
-
- NeutronRouter singleton = routerInterface.getRouter(routerUUID);
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- int status = service.canDeleteRouter(singleton);
- if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
- return Response.status(status).build();
- }
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDERS);
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDER_LIST);
- }
- routerInterface.removeRouter(routerUUID);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- service.neutronRouterDeleted(singleton);
- }
- }
- return Response.status(HttpURLConnection.HTTP_NO_CONTENT).build();
+ public Response deleteRouter(@PathParam("routerUUID") String routerUUID) {
+ return delete(routerUUID);
}
/**
@Produces({ MediaType.APPLICATION_JSON })
@Consumes({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouterInterfaces.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
- @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
- public Response addRouterInterface(
- @PathParam("routerUUID") String routerUUID,
- NeutronRouter_Interface input
- ) {
- NeutronCRUDInterfaces interfaces = getAttachInterfaces();
- INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
-
- NeutronRouter target = routerInterface.getRouter(routerUUID);
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- int status = service.canAttachInterface(target, input);
- if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
- return Response.status(status).build();
- }
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDERS);
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDER_LIST);
- }
-
- target.addInterface(input.getPortUUID(), input);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- service.neutronRouterInterfaceAttached(target, input);
- }
- }
-
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful") })
+ public Response addRouterInterface(@PathParam("routerUUID") String routerUUID, NeutronRouter_Interface input) {
+ // Do nothing. Keep this interface for compatibility
return Response.status(HttpURLConnection.HTTP_OK).entity(input).build();
}
-
- private int checkDownstreamDetach(NeutronRouter target, NeutronRouter_Interface input) {
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- int status = service.canDetachInterface(target, input);
- if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) {
- return status;
- }
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDERS);
- }
- } else {
- throw new ServiceUnavailableException(NO_PROVIDER_LIST);
- }
- return HTTP_OK_BOTTOM;
- }
-
- /**
- * Removes an interface to a router */
-
@Path("{routerUUID}/remove_router_interface")
@PUT
@Produces({ MediaType.APPLICATION_JSON })
@Consumes({ MediaType.APPLICATION_JSON })
//@TypeHint(OpenStackRouterInterfaces.class)
- @StatusCodes({
- @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
- @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
- public Response removeRouterInterface(
- @PathParam("routerUUID") String routerUUID,
- NeutronRouter_Interface input
- ) {
- NeutronCRUDInterfaces interfaces = getAttachInterfaces();
- INeutronRouterCRUD routerInterface = interfaces.getRouterInterface();
- Object[] instances = NeutronUtil.getInstances(INeutronRouterAware.class, this);
-
- NeutronRouter target = routerInterface.getRouter(routerUUID);
- input.setID(target.getID());
- input.setTenantID(target.getTenantID());
- int status = checkDownstreamDetach(target, input);
- if (status != HTTP_OK_BOTTOM) {
- return Response.status(status).build();
- }
- target.removeInterface(input.getPortUUID());
- for (Object instance : instances) {
- INeutronRouterAware service = (INeutronRouterAware) instance;
- service.neutronRouterInterfaceDetached(target, input);
- }
+ @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful") })
+ public Response removeRouterInterface(@PathParam("routerUUID") String routerUUID, NeutronRouter_Interface input) {
+ // Do nothing. Keep this interface for compatibility
return Response.status(HttpURLConnection.HTTP_OK).entity(input).build();
}
}
Code Review / neutron.git / blobdiff