/*
- * Copyright IBM Corporation, 2013. All rights reserved.
+ * Copyright (c) 2013, 2015 IBM Corporation and others. 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,
import java.net.HttpURLConnection;
import java.util.ArrayList;
-import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
-import java.util.Map;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import org.codehaus.enunciate.jaxrs.ResponseCode;
import org.codehaus.enunciate.jaxrs.StatusCodes;
-import org.opendaylight.neutron.spi.INeutronNetworkCRUD;
-import org.opendaylight.neutron.spi.INeutronPortAware;
import org.opendaylight.neutron.spi.INeutronPortCRUD;
-import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
import org.opendaylight.neutron.spi.NeutronCRUDInterfaces;
import org.opendaylight.neutron.spi.NeutronPort;
-import org.opendaylight.neutron.spi.NeutronSubnet;
-import org.opendaylight.neutron.spi.Neutron_IPs;
/**
* Neutron Northbound REST APIs.<br>
*/
@Path("/ports")
-public class NeutronPortsNorthbound {
+public class NeutronPortsNorthbound
+ extends AbstractNeutronNorthbound<NeutronPort, NeutronPortRequest, INeutronPortCRUD> {
- private static final int HTTP_OK_BOTTOM = 200;
- private static final int HTTP_OK_TOP = 299;
- private static final String INTERFACE_NAME = "Port CRUD Interface";
- private static final String UUID_NO_EXIST = "Port UUID does not exist.";
- private static final String UUID_EXISTS = "Port UUID already exists.";
- 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 NET_UUID_MATCH = "Network UUID must match that of subnet";
+ private static final String RESOURCE_NAME = "Port";
- private static final String MAC_REGEX="^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$";
+ @Override
+ protected String getResourceName() {
+ return RESOURCE_NAME;
+ }
- private NeutronPort extractFields(NeutronPort o, List<String> fields) {
+ @Override
+ protected NeutronPort extractFields(NeutronPort o, List<String> fields) {
return o.extractFields(fields);
}
private NeutronCRUDInterfaces getNeutronInterfaces(boolean needNetworks, boolean needSubnets) {
NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronPortCRUD(this);
if (answer.getPortInterface() == null) {
- throw new ServiceUnavailableException(INTERFACE_NAME
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException(serviceUnavailable());
}
if (needNetworks) {
answer = answer.fetchINeutronNetworkCRUD( this);
return answer;
}
+ @Override
+ protected INeutronPortCRUD getNeutronCRUD() {
+ return getNeutronInterfaces(false, false).getPortInterface();
+ }
+
+ @Override
+ protected NeutronPortRequest newNeutronRequest(NeutronPort o) {
+ return new NeutronPortRequest(o);
+ }
+
@Context
UriInfo uriInfo;
@QueryParam("id") String queryID,
@QueryParam("network_id") String queryNetworkID,
@QueryParam("name") String queryName,
- @QueryParam("admin_state_up") String queryAdminStateUp,
+ @QueryParam("admin_state_up") Boolean queryAdminStateUp,
@QueryParam("status") String queryStatus,
@QueryParam("mac_address") String queryMACAddress,
@QueryParam("device_id") String queryDeviceID,
@QueryParam("device_owner") String queryDeviceOwner,
@QueryParam("tenant_id") String queryTenantID,
+ @QueryParam("port_security_enabled") Boolean queryPortSecurityEnabled,
// linkTitle
@QueryParam("limit") Integer limit,
@QueryParam("marker") String marker,
// sorting not supported
) {
INeutronPortCRUD portInterface = getNeutronInterfaces(false, false).getPortInterface();
- List<NeutronPort> allPorts = portInterface.getAllPorts();
+ List<NeutronPort> allPorts = portInterface.getAll();
List<NeutronPort> ans = new ArrayList<NeutronPort>();
Iterator<NeutronPort> i = allPorts.iterator();
while (i.hasNext()) {
(queryMACAddress == null || queryMACAddress.equals(oSS.getMacAddress())) &&
(queryDeviceID == null || queryDeviceID.equals(oSS.getDeviceID())) &&
(queryDeviceOwner == null || queryDeviceOwner.equals(oSS.getDeviceOwner())) &&
- (queryTenantID == null || queryTenantID.equals(oSS.getTenantID()))) {
+ (queryTenantID == null || queryTenantID.equals(oSS.getTenantID())) &&
+ (queryPortSecurityEnabled == null || queryPortSecurityEnabled.equals(oSS.getPortSecurityEnabled()))) {
if (fields.size() > 0) {
ans.add(extractFields(oSS,fields));
} else {
@PathParam("portUUID") String portUUID,
// return fields
@QueryParam("fields") List<String> fields ) {
- INeutronPortCRUD portInterface = getNeutronInterfaces(false, false).getPortInterface();
- if (!portInterface.portExists(portUUID)) {
- throw new ResourceNotFoundException(UUID_NO_EXIST);
- }
- if (fields.size() > 0) {
- NeutronPort ans = portInterface.getPort(portUUID);
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronPortRequest(extractFields(ans, fields))).build();
- } else {
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronPortRequest(portInterface.getPort(portUUID))).build();
- }
+ return show(portUUID, fields);
}
/**
//@TypeHint(OpenStackPorts.class)
@StatusCodes({
@ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"),
- @ResponseCode(code = HttpURLConnection.HTTP_BAD_REQUEST, condition = "Bad Request"),
- @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_CONFLICT, condition = "Conflict"),
- @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
- @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "MAC generation failure"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
public Response createPorts(final NeutronPortRequest input) {
- NeutronCRUDInterfaces interfaces = getNeutronInterfaces(true, true);
- INeutronPortCRUD portInterface = interfaces.getPortInterface();
- INeutronNetworkCRUD networkInterface = interfaces.getNetworkInterface();
- INeutronSubnetCRUD subnetInterface = interfaces.getSubnetInterface();
- if (input.isSingleton()) {
- NeutronPort singleton = input.getSingleton();
-
- Object[] instances = NeutronUtil.getInstances(INeutronPortAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- int status = service.canCreatePort(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 the port to the cache
- portInterface.addPort(singleton);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- service.neutronPortCreated(singleton);
- }
- }
- } else {
- Object[] instances = NeutronUtil.getInstances(INeutronPortAware.class, this);
- for (NeutronPort test : input.getBulk()) {
-
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- int status = service.canCreatePort(test);
- 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);
- }
- }
+ getNeutronInterfaces(true, true); // Ensure that services for networks and subnets are loaded
+ return create(input);
+ }
- //once everything has passed, then we can add to the cache
- for (NeutronPort test : input.getBulk()) {
- portInterface.addPort(test);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- service.neutronPortCreated(test);
- }
- }
- }
+ @Override
+ protected void updateDelta(String uuid, NeutronPort delta, NeutronPort original) {
+ /*
+ * note: what we would like to get is the complete object as it
+ * is known by neutron. Until then, patch what we *do* get
+ * so that we don't lose already known information
+ */
+ if (delta.getID() == null) {
+ delta.setID(uuid);
+ }
+ if (delta.getTenantID() == null) {
+ delta.setTenantID(original.getTenantID());
+ }
+ if (delta.getNetworkUUID() == null) {
+ delta.setNetworkUUID(original.getNetworkUUID());
+ }
+ if (delta.getMacAddress() == null) {
+ delta.setMacAddress(original.getMacAddress());
+ }
+ if (delta.getFixedIPs() == null) {
+ delta.setFixedIPs(original.getFixedIPs());
}
- return Response.status(HttpURLConnection.HTTP_CREATED).entity(input).build();
}
/**
//@TypeHint(OpenStackPorts.class)
@StatusCodes({
@ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"),
- @ResponseCode(code = HttpURLConnection.HTTP_BAD_REQUEST, condition = "Bad Request"),
- @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_CONFLICT, condition = "Conflict"),
- @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"),
@ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") })
public Response updatePort(
@PathParam("portUUID") String portUUID,
NeutronPortRequest input
) {
- NeutronCRUDInterfaces interfaces = getNeutronInterfaces(false, true);
- INeutronPortCRUD portInterface = interfaces.getPortInterface();
- NeutronPort original = portInterface.getPort(portUUID);
- /*
- * note: what we get appears to not be a delta, but rather a possibly
- * complete updated object. So, that needs to be sent down to
- * folks to check
- */
-
- NeutronPort updatedObject = input.getSingleton();
- updatedObject.setID(portUUID);
-
- Object[] instances = NeutronUtil.getInstances(INeutronPortAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- int status = service.canUpdatePort(updatedObject, 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);
- }
-
// TODO: Support change of security groups
// update the port and return the modified object
- portInterface.updatePort(portUUID, updatedObject);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- service.neutronPortUpdated(updatedObject);
- }
- }
- return Response.status(HttpURLConnection.HTTP_OK).entity(
- new NeutronPortRequest(updatedObject)).build();
-
+ return update(portUUID, input);
}
/**
@DELETE
@StatusCodes({
@ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"),
- @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 deletePort(
@PathParam("portUUID") String portUUID) {
- INeutronPortCRUD portInterface = getNeutronInterfaces(false, false).getPortInterface();
-
- NeutronPort singleton = portInterface.getPort(portUUID);
- Object[] instances = NeutronUtil.getInstances(INeutronPortAware.class, this);
- if (instances != null) {
- if (instances.length > 0) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- int status = service.canDeletePort(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);
- }
- portInterface.removePort(portUUID);
- if (instances != null) {
- for (Object instance : instances) {
- INeutronPortAware service = (INeutronPortAware) instance;
- service.neutronPortDeleted(singleton);
- }
- }
- return Response.status(HttpURLConnection.HTTP_NO_CONTENT).build();
+ return delete(portUUID);
}
}