Static Routing Northbound API allows for the management of the static + * routes.
+ * + * An example request/response for retrieving the static routes may look like this: + *
+ * GET http://localhost:8080/controller/nb/v2/staticroute/default HTTP/1.1
+ * Accept: application/json
+ *
+ * HTTP/1.1 200 OK
+ * Content-Type: application/json
+ *
+ * {"staticRoute":{"name":"route-1","prefix":"10.10.1.0/24","nextHop":"1.1.1.1"}}
+ *
+ *
*
*
+ * Example:
+ *
+ * Request URL:
+ * GET http://localhost:8080/controller/nb/v2/staticroute/default
+ *
+ * Response in XML:
+ * <list>
+ * <staticRoute>
+ * <name>route-1</name>
+ * <prefix>10.10.1.0/24</prefix>
+ * <nextHop>1.1.1.1</nextHop>
+ * </staticRoute>
+ * </list>
+ *
+ * Response in JSON:
+ * {"staticRoute":{"name":"route-1","prefix":"10.10.1.0/24","nextHop":"1.1.1.1"}}
+ *
+ *
*/
@Path("/{containerName}")
@GET
@@ -90,6 +138,13 @@ public class StaticRoutingNorthbound {
@ResponseCode(code = 404, condition = "The containerName passed was not found") })
public StaticRoutes getStaticRoutes(
@PathParam("containerName") String containerName) {
+
+ if(!NorthboundUtils.isAuthorized(getUserName(), containerName,
+ Privilege.WRITE, this)){
+ throw new
+ UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
+ }
return new StaticRoutes(getStaticRoutesInternal(containerName));
}
@@ -97,10 +152,29 @@ public class StaticRoutingNorthbound {
* Returns the static route for the provided configuration name on a given container
*
* @param containerName Name of the Container. The Container name for the base controller is "default".
- * @param name Name of the Static Route configuration
+ * @param route Name of the Static Route configuration
* @return Static route configured with the supplied Name.
+ *
+ *
+ * Example:
+ *
+ * Request URL:
+ * GET http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1
+ *
+ * Response in XML:
+ *
+ * <staticRoute>
+ * <name>route-1</name>
+ * <prefix>10.10.1.0/24</prefix>
+ * <nextHop>1.1.1.1</nextHop>
+ * </staticRoute>
+ *
+ * Response in JSON:
+ * {"name":"route-1","prefix":"10.10.1.0/24","nextHop":"1.1.1.1"}
+ *
+ *
*/
- @Path("/{containerName}/{name}")
+ @Path("/{containerName}/route/{route}")
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(StaticRoute.class)
@@ -109,11 +183,18 @@ public class StaticRoutingNorthbound {
@ResponseCode(code = 404, condition = "The Container Name or Static Route Configuration name passed was not found") })
public StaticRoute getStaticRoute(
@PathParam("containerName") String containerName,
- @PathParam("name") String name) {
+ @PathParam("route") String route) {
+
+ if(!NorthboundUtils.isAuthorized(getUserName(), containerName,
+ Privilege.WRITE, this)){
+ throw new
+ UnauthorizedException("User is not authorized to perform this operation on container "
+ + containerName);
+ }
List
+ * Example:
+ *
+ * Request URL:
+ * POST http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1
+ *
+ * Request payload in JSON:
+ * {"name":"route-1","prefix":"10.10.1.0/24","nextHop":"1.1.1.1"}
+ *
+ *
*/
- @Path("/{containerName}/{name}")
+ @Path("/{containerName}/route/{route}")
@POST
@Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@StatusCodes( {
@@ -138,10 +230,18 @@ public class StaticRoutingNorthbound {
@ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active"),
@ResponseCode(code = 409, condition = "Failed to create Static Route entry due to Conflicting Name or Prefix."), })
public Response addStaticRoute(
+ @Context UriInfo uriInfo,
@PathParam(value = "containerName") String containerName,
- @PathParam(value = "name") String name,
+ @PathParam(value = "route") String route,
@TypeHint(StaticRoute.class) JAXBElement+ * Example: + * + * Request URL: + * DELETE http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1 + * + **/ - - @Path("/{containerName}/{name}") + @Path("/{containerName}/route/{route}") @DELETE @StatusCodes( { @ResponseCode(code = 200, condition = "Operation successful"), @@ -181,8 +289,14 @@ public class StaticRoutingNorthbound { @ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active") }) public Response removeStaticRoute( @PathParam(value = "containerName") String containerName, - @PathParam(value = "name") String name) { + @PathParam(value = "route") String route) { + if(!NorthboundUtils.isAuthorized(getUserName(), containerName, + Privilege.WRITE, this)){ + throw new + UnauthorizedException("User is not authorized to perform this operation on container " + + containerName); + } handleDefaultDisabled(containerName); IForwardingStaticRouting staticRouting = (IForwardingStaticRouting) ServiceHelper @@ -194,8 +308,9 @@ public class StaticRoutingNorthbound { .toString()); } - Status status = staticRouting.removeStaticRoute(name); + Status status = staticRouting.removeStaticRoute(route); if (status.isSuccess()) { + NorthboundUtils.auditlog("Static Route", username, "removed", route, containerName); return Response.ok().build(); } throw new ResourceNotFoundException(status.getDescription());