();
@@ -126,17 +117,14 @@ public class FlowProgrammerNorthbound {
flows.add(flow);
}
} else {
- ISwitchManager sm = (ISwitchManager) ServiceHelper.getInstance(
- ISwitchManager.class, containerName, this);
+ ISwitchManager sm = (ISwitchManager) ServiceHelper.getInstance(ISwitchManager.class, containerName, this);
if (sm == null) {
- throw new ServiceUnavailableException("Switch Manager "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Switch Manager " + RestMessages.SERVICEUNAVAILABLE.toString());
}
if (!sm.getNodes().contains(node)) {
- throw new ResourceNotFoundException(node.toString() + " : "
- + RestMessages.NONODE.toString());
+ throw new ResourceNotFoundException(node.toString() + " : " + RestMessages.NONODE.toString());
}
for (FlowConfig flow : frm.getStaticFlows(node)) {
@@ -153,12 +141,12 @@ public class FlowProgrammerNorthbound {
* Name of the Container (Eg. 'default')
* @return List of flows configured on a given container
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default
*
* Response in XML:
* <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -188,22 +176,17 @@ public class FlowProgrammerNorthbound {
@GET
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(FlowConfigs.class)
- @StatusCodes({
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The containerName is not found"),
- @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
- public FlowConfigs getStaticFlows(
- @PathParam("containerName") String containerName) {
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.READ, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
- }
-
- List flowConfigs = getStaticFlowsInternal(containerName,
- null);
+ @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The containerName is not found"),
+ @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
+ public FlowConfigs getStaticFlows(@PathParam("containerName") String containerName) {
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
+ }
+
+ List flowConfigs = getStaticFlowsInternal(containerName, null);
return new FlowConfigs(flowConfigs);
}
@@ -218,12 +201,12 @@ public class FlowProgrammerNorthbound {
* Node Identifier (Eg. '00:00:00:00:00:00:00:01')
* @return List of flows configured on a Node in a container
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default/node/OF/00:00:00:00:00:00:00:01
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default/node/OF/00:00:00:00:00:00:00:01
*
* Response in XML:
* <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -253,25 +236,19 @@ public class FlowProgrammerNorthbound {
@GET
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(FlowConfigs.class)
- @StatusCodes({
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The containerName or nodeId is not found"),
- @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
- public FlowConfigs getStaticFlows(
- @PathParam("containerName") String containerName,
- @PathParam("nodeType") String nodeType,
- @PathParam("nodeId") String nodeId) {
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.READ, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
+ @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The containerName or nodeId is not found"),
+ @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
+ public FlowConfigs getStaticFlows(@PathParam("containerName") String containerName,
+ @PathParam("nodeType") String nodeType, @PathParam("nodeId") String nodeId) {
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
}
Node node = Node.fromString(nodeType, nodeId);
if (node == null) {
- throw new ResourceNotFoundException(nodeId + " : "
- + RestMessages.NONODE.toString());
+ throw new ResourceNotFoundException(nodeId + " : " + RestMessages.NONODE.toString());
}
List flows = getStaticFlowsInternal(containerName, node);
return new FlowConfigs(flows);
@@ -291,12 +268,12 @@ public class FlowProgrammerNorthbound {
* Human-readable name for the configured flow (Eg. 'Flow1')
* @return Flow configuration matching the name and nodeId on a Container
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default/node/OF/00:00:00:00:00:00:00:01/static-flow/flow1
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default/node/OF/00:00:00:00:00:00:00:01/staticFlow/flow1
*
* Response in XML:
* <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -320,30 +297,24 @@ public class FlowProgrammerNorthbound {
*
*
*/
- @Path("/{containerName}/node/{nodeType}/{nodeId}/static-flow/{name}")
+ @Path("/{containerName}/node/{nodeType}/{nodeId}/staticFlow/{name}")
@GET
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(FlowConfig.class)
- @StatusCodes({
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The containerName or NodeId or Configuration name is not found"),
- @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
- public FlowConfig getStaticFlow(
- @PathParam("containerName") String containerName,
- @PathParam("nodeType") String nodeType,
- @PathParam("nodeId") String nodeId, @PathParam("name") String name) {
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.READ, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
+ @StatusCodes({ @ResponseCode(code = 200, condition = "Operation successful"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The containerName or NodeId or Configuration name is not found"),
+ @ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
+ public FlowConfig getStaticFlow(@PathParam("containerName") String containerName,
+ @PathParam("nodeType") String nodeType, @PathParam("nodeId") String nodeId, @PathParam("name") String name) {
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
}
IForwardingRulesManager frm = getForwardingRulesManagerService(containerName);
if (frm == null) {
- throw new ServiceUnavailableException("Flow Programmer "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Flow Programmer " + RestMessages.SERVICEUNAVAILABLE.toString());
}
Node node = handleNodeAvailability(containerName, nodeType, nodeId);
@@ -357,7 +328,8 @@ public class FlowProgrammerNorthbound {
}
/**
- * Add a flow configuration
+ * Add a flow configuration. If a flow by the given name already exists,
+ * this method will respond with a non-successful status response.
*
* @param containerName
* Name of the Container (Eg. 'default')
@@ -371,12 +343,12 @@ public class FlowProgrammerNorthbound {
* Flow Configuration in JSON or XML format
* @return Response as dictated by the HTTP Response Status code
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default/node/OF/00:00:00:00:00:00:00:01/static-flow/flow1
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default/node/OF/00:00:00:00:00:00:00:01/staticFlow/flow1
*
* Request in XML:
* <flowConfig>
@@ -400,54 +372,53 @@ public class FlowProgrammerNorthbound {
*
*/
- @Path("/{containerName}/node/{nodeType}/{nodeId}/static-flow/{name}")
+ @Path("/{containerName}/node/{nodeType}/{nodeId}/staticFlow/{name}")
@PUT
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@StatusCodes({
- @ResponseCode(code = 201, condition = "Flow Config processed successfully"),
- @ResponseCode(code = 400, condition = "Failed to create Static Flow entry due to invalid flow configuration"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The Container Name or nodeId is not found"),
- @ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active"),
- @ResponseCode(code = 409, condition = "Failed to create Static Flow entry due to Conflicting Name or configuration"),
- @ResponseCode(code = 500, condition = "Failed to create Static Flow entry. Failure Reason included in HTTP Error response"),
- @ResponseCode(code = 503, condition = "One or more of Controller services are unavailable") })
- public Response addFlow(
- @PathParam(value = "containerName") String containerName,
- @PathParam(value = "name") String name,
- @PathParam("nodeType") String nodeType,
- @PathParam(value = "nodeId") String nodeId,
- @TypeHint(FlowConfig.class) JAXBElement flowConfig) {
-
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.WRITE, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
- }
- handleResourceCongruence(name, flowConfig.getValue().getName());
- handleResourceCongruence(nodeId, flowConfig.getValue().getNode().getNodeIDString());
+ @ResponseCode(code = 201, condition = "Flow Config processed successfully"),
+ @ResponseCode(code = 400, condition = "Failed to create Static Flow entry due to invalid flow configuration"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The Container Name or nodeId is not found"),
+ @ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active"),
+ @ResponseCode(code = 409, condition = "Failed to create Static Flow entry due to Conflicting Name or configuration"),
+ @ResponseCode(code = 500, condition = "Failed to create Static Flow entry. Failure Reason included in HTTP Error response"),
+ @ResponseCode(code = 503, condition = "One or more of Controller services are unavailable") })
+ public Response addFlow(@PathParam(value = "containerName") String containerName,
+ @PathParam(value = "name") String name, @PathParam("nodeType") String nodeType,
+ @PathParam(value = "nodeId") String nodeId, @TypeHint(FlowConfig.class) FlowConfig flowConfig) {
+
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
+ }
+
+ if (flowConfig.getNode() == null) {
+ return Response.status(Response.Status.BAD_REQUEST).entity("Invalid Configuration. Node is null or empty")
+ .build();
+ }
+ handleResourceCongruence(name, flowConfig.getName());
+ handleResourceCongruence(nodeId, flowConfig.getNode().getNodeIDString());
handleDefaultDisabled(containerName);
IForwardingRulesManager frm = getForwardingRulesManagerService(containerName);
if (frm == null) {
- throw new ServiceUnavailableException("Flow Programmer "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Flow Programmer " + RestMessages.SERVICEUNAVAILABLE.toString());
}
Node node = handleNodeAvailability(containerName, nodeType, nodeId);
FlowConfig staticFlow = frm.getStaticFlow(name, node);
if (staticFlow != null) {
- throw new ResourceConflictException(name + " already exists."
- + RestMessages.RESOURCECONFLICT.toString());
+ throw new ResourceConflictException(name + " already exists." + RestMessages.RESOURCECONFLICT.toString());
}
- Status status = frm.addStaticFlow(flowConfig.getValue());
+ Status status = frm.addStaticFlow(flowConfig);
if (status.isSuccess()) {
- NorthboundUtils.auditlog("Flow", username, "added", name, containerName);
+ NorthboundUtils.auditlog("Flow Entry", username, "added",
+ name + " on Node " + NorthboundUtils.getNodeDesc(node, containerName, this), containerName);
return Response.status(Response.Status.CREATED).entity("Success").build();
}
return NorthboundUtils.getResponse(status);
@@ -466,58 +437,54 @@ public class FlowProgrammerNorthbound {
* Name of the Static Flow configuration (Eg. 'Flow1')
* @return Response as dictated by the HTTP Response code
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default/node/OF/00:00:00:00:00:00:00:01/static-flow/flow1
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default/node/OF/00:00:00:00:00:00:00:01/staticFlow/flow1
*
*
*/
- @Path("/{containerName}/node/{nodeType}/{nodeId}/static-flow/{name}")
+ @Path("/{containerName}/node/{nodeType}/{nodeId}/staticFlow/{name}")
@DELETE
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@StatusCodes({
- @ResponseCode(code = 200, condition = "Flow Config deleted successfully"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The Container Name or Node-id or Flow Name passed is not found"),
- @ResponseCode(code = 406, condition = "Failed to delete Flow config due to invalid operation. Failure details included in HTTP Error response"),
- @ResponseCode(code = 500, condition = "Failed to delete Flow config. Failure Reason included in HTTP Error response"),
- @ResponseCode(code = 503, condition = "One or more of Controller service is unavailable") })
- public Response deleteFlow(
- @PathParam(value = "containerName") String containerName,
- @PathParam(value = "name") String name,
- @PathParam("nodeType") String nodeType,
+ @ResponseCode(code = 204, condition = "Flow Config deleted successfully"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The Container Name or Node-id or Flow Name passed is not found"),
+ @ResponseCode(code = 406, condition = "Failed to delete Flow config due to invalid operation. Failure details included in HTTP Error response"),
+ @ResponseCode(code = 500, condition = "Failed to delete Flow config. Failure Reason included in HTTP Error response"),
+ @ResponseCode(code = 503, condition = "One or more of Controller service is unavailable") })
+ public Response deleteFlow(@PathParam(value = "containerName") String containerName,
+ @PathParam(value = "name") String name, @PathParam("nodeType") String nodeType,
@PathParam(value = "nodeId") String nodeId) {
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.WRITE, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
}
handleDefaultDisabled(containerName);
IForwardingRulesManager frm = getForwardingRulesManagerService(containerName);
if (frm == null) {
- throw new ServiceUnavailableException("Flow Programmer "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Flow Programmer " + RestMessages.SERVICEUNAVAILABLE.toString());
}
Node node = handleNodeAvailability(containerName, nodeType, nodeId);
FlowConfig staticFlow = frm.getStaticFlow(name, node);
if (staticFlow == null) {
- throw new ResourceNotFoundException(name + " : "
- + RestMessages.NOFLOW.toString());
+ throw new ResourceNotFoundException(name + " : " + RestMessages.NOFLOW.toString());
}
Status status = frm.removeStaticFlow(name, node);
if (status.isSuccess()) {
- NorthboundUtils.auditlog("Flow", username, "removed", name, containerName);
+ NorthboundUtils.auditlog("Flow Entry", username, "removed",
+ name + " from Node " + NorthboundUtils.getNodeDesc(node, containerName, this), containerName);
+ return Response.noContent().build();
}
return NorthboundUtils.getResponse(status);
}
@@ -535,36 +502,32 @@ public class FlowProgrammerNorthbound {
* Name of the Static Flow configuration (Eg. 'Flow1')
* @return Response as dictated by the HTTP Response code
*
- *
+ *
*
* Example:
*
* RequestURL:
- * http://localhost:8080/controller/nb/v2/flow/default/node/OF/00:00:00:00:00:00:00:01/static-flow/flow1
+ * http://localhost:8080/controller/nb/v2/flowprogrammer/default/node/OF/00:00:00:00:00:00:00:01/staticFlow/flow1
*
*
*/
- @Path("/{containerName}/node/{nodeType}/{nodeId}/static-flow/{name}")
+ @Path("/{containerName}/node/{nodeType}/{nodeId}/staticFlow/{name}")
@POST
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@StatusCodes({
- @ResponseCode(code = 200, condition = "Flow Config processed successfully"),
- @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
- @ResponseCode(code = 404, condition = "The Container Name or Node-id or Flow Name passed is not found"),
- @ResponseCode(code = 406, condition = "Failed to delete Flow config due to invalid operation. Failure details included in HTTP Error response"),
- @ResponseCode(code = 500, condition = "Failed to delete Flow config. Failure Reason included in HTTP Error response"),
- @ResponseCode(code = 503, condition = "One or more of Controller service is unavailable") })
- public Response toggleFlow(
- @PathParam(value = "containerName") String containerName,
- @PathParam("nodeType") String nodeType,
- @PathParam(value = "nodeId") String nodeId,
+ @ResponseCode(code = 200, condition = "Flow Config processed successfully"),
+ @ResponseCode(code = 401, condition = "User not authorized to perform this operation"),
+ @ResponseCode(code = 404, condition = "The Container Name or Node-id or Flow Name passed is not found"),
+ @ResponseCode(code = 406, condition = "Failed to delete Flow config due to invalid operation. Failure details included in HTTP Error response"),
+ @ResponseCode(code = 500, condition = "Failed to delete Flow config. Failure Reason included in HTTP Error response"),
+ @ResponseCode(code = 503, condition = "One or more of Controller service is unavailable") })
+ public Response toggleFlow(@PathParam(value = "containerName") String containerName,
+ @PathParam("nodeType") String nodeType, @PathParam(value = "nodeId") String nodeId,
@PathParam(value = "name") String name) {
- if (!NorthboundUtils.isAuthorized(
- getUserName(), containerName, Privilege.WRITE, this)) {
- throw new UnauthorizedException(
- "User is not authorized to perform this operation on container "
- + containerName);
+ if (!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)) {
+ throw new UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
}
handleDefaultDisabled(containerName);
@@ -572,60 +535,51 @@ public class FlowProgrammerNorthbound {
IForwardingRulesManager frm = getForwardingRulesManagerService(containerName);
if (frm == null) {
- throw new ServiceUnavailableException("Flow Programmer "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Flow Programmer " + RestMessages.SERVICEUNAVAILABLE.toString());
}
Node node = handleNodeAvailability(containerName, nodeType, nodeId);
FlowConfig staticFlow = frm.getStaticFlow(name, node);
if (staticFlow == null) {
- throw new ResourceNotFoundException(name + " : "
- + RestMessages.NOFLOW.toString());
+ throw new ResourceNotFoundException(name + " : " + RestMessages.NOFLOW.toString());
}
Status status = frm.toggleStaticFlowStatus(staticFlow);
if (status.isSuccess()) {
- NorthboundUtils.auditlog("Flow", username, "toggled", name, containerName);
+ NorthboundUtils.auditlog("Flow Entry", username, "toggled",
+ name + " on Node " + NorthboundUtils.getNodeDesc(node, containerName, this), containerName);
}
return NorthboundUtils.getResponse(status);
}
- private Node handleNodeAvailability(String containerName, String nodeType,
- String nodeId) {
+ private Node handleNodeAvailability(String containerName, String nodeType, String nodeId) {
Node node = Node.fromString(nodeType, nodeId);
if (node == null) {
- throw new ResourceNotFoundException(nodeId + " : "
- + RestMessages.NONODE.toString());
+ throw new ResourceNotFoundException(nodeId + " : " + RestMessages.NONODE.toString());
}
- ISwitchManager sm = (ISwitchManager) ServiceHelper.getInstance(
- ISwitchManager.class, containerName, this);
+ ISwitchManager sm = (ISwitchManager) ServiceHelper.getInstance(ISwitchManager.class, containerName, this);
if (sm == null) {
- throw new ServiceUnavailableException("Switch Manager "
- + RestMessages.SERVICEUNAVAILABLE.toString());
+ throw new ServiceUnavailableException("Switch Manager " + RestMessages.SERVICEUNAVAILABLE.toString());
}
if (!sm.getNodes().contains(node)) {
- throw new ResourceNotFoundException(node.toString() + " : "
- + RestMessages.NONODE.toString());
+ throw new ResourceNotFoundException(node.toString() + " : " + RestMessages.NONODE.toString());
}
return node;
}
private void handleDefaultDisabled(String containerName) {
- IContainerManager containerManager = (IContainerManager) ServiceHelper
- .getGlobalInstance(IContainerManager.class, this);
+ IContainerManager containerManager = (IContainerManager) ServiceHelper.getGlobalInstance(
+ IContainerManager.class, this);
if (containerManager == null) {
- throw new InternalServerErrorException(
- RestMessages.INTERNALERROR.toString());
+ throw new InternalServerErrorException(RestMessages.INTERNALERROR.toString());
}
- if (containerName.equals(GlobalConstants.DEFAULT.toString())
- && containerManager.hasNonDefaultContainer()) {
- throw new NotAcceptableException(
- RestMessages.DEFAULTDISABLED.toString());
+ if (containerName.equals(GlobalConstants.DEFAULT.toString()) && containerManager.hasNonDefaultContainer()) {
+ throw new NotAcceptableException(RestMessages.DEFAULTDISABLED.toString());
}
}