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:
- * http://localhost:8080/controller/nb/v2/staticroute/default/routes
- *
- * Response body in XML:
- * <list>
- * <staticRoute>
- * <name>route-1</name>
- * <prefix>10.10.1.0/24</prefix>
- * <nextHop>1.1.1.1</nextHop>
- * </staticRoute>
- * </list>
- *
- * Response body in JSON:
- * {
- * "staticRoute": [
- * {
- * "name": "route-1",
- * "prefix": "10.10.1.0/24",
- * "nextHop": "1.1.1.1"
- * }
- * ]
- * }
- *
- */
- @Path("/{containerName}/routes")
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @TypeHint(StaticRoutes.class)
- @StatusCodes( {
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 404, condition = "The containerName passed was not found") })
- public StaticRoutes getStaticRoutes(
- @PathParam("containerName") String containerName,
- @QueryParam("_q") String queryString) {
-
- if(!NorthboundUtils.isAuthorized(getUserName(), containerName,
- Privilege.WRITE, this)){
- throw new
- UnauthorizedException("User is not authorized to perform this operation on container "
- + containerName);
- }
- StaticRoutes result = new StaticRoutes(getStaticRoutesInternal(containerName));
- if (queryString != null) {
- queryContext.createQuery(queryString, StaticRoutes.class)
- .filter(result, StaticRoute.class);
- }
- return result;
- }
-
- /**
- * 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 route Name of the Static Route configuration
- * @return Static route configured with the supplied Name.
- *
- *
- * Example:
- *
- * Request URL:
- * http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1
- *
- * Response body in XML:
- *
- * <staticRoute>
- * <name>route-1</name>
- * <prefix>10.10.1.0/24</prefix>
- * <nextHop>1.1.1.1</nextHop>
- * </staticRoute>
- *
- * Response body in JSON:
- * {
- * "name":"route-1",
- * "prefix":"10.10.1.0/24",
- * "nextHop":"1.1.1.1"
- * }
- *
- *
- */
- @Path("/{containerName}/route/{route}")
- @GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @TypeHint(StaticRoute.class)
- @StatusCodes( {
- @ResponseCode(code = 200, condition = "Operation successful"),
- @ResponseCode(code = 404, condition = "The Container Name or Static Route Configuration name passed was not found") })
- public StaticRoute getStaticRoute(
- @PathParam("containerName") String containerName,
- @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:
- * http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1
- *
- * Request body in XML:
- * <staticRoute>
- * <name>route-1</name>
- * <prefix>10.10.1.0/24</prefix>
- * <nextHop>1.1.1.1</nextHop>
- * </staticRoute>
- * Request body in JSON:
- * {
- * "name":"route-1",
- * "prefix":"10.10.1.0/24",
- * "nextHop":"1.1.1.1"
- * }
- *
- */
- @Path("/{containerName}/route/{route}")
- @PUT
- @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @StatusCodes( {
- @ResponseCode(code = 201, condition = "Created Static Route successfully"),
- @ResponseCode(code = 404, condition = "The Container Name passed 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 Route entry due to Conflicting Name or Prefix."), })
- public Response addStaticRoute(
- @Context UriInfo uriInfo,
- @PathParam(value = "containerName") String containerName,
- @PathParam(value = "route") String route,
- @TypeHint(StaticRoute.class) StaticRoute staticRouteData) {
-
-
- 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
- .getInstance(IForwardingStaticRouting.class, containerName,
- this);
-
- if (staticRouting == null) {
- throw new ResourceNotFoundException(RestMessages.NOCONTAINER
- .toString());
- }
-
- StaticRoute sRoute = staticRouteData;
- StaticRouteConfig cfgObject = new StaticRouteConfig(sRoute.getName(),
- sRoute.getPrefix(), sRoute.getNextHop());
- Status response = staticRouting.addStaticRoute(cfgObject);
- if (response.isSuccess()) {
- NorthboundUtils.auditlog("Static Route", username, "added", route, containerName);
- return Response.created(uriInfo.getRequestUri()).build();
- }
- throw new ResourceConflictException(response.getDescription());
- }
-
- /**
- *
- * Delete a Static Route
- *
- * @param containerName Name of the Container. The Container name for the base controller is "default".
- * @param route Name of the Static Route configuration to be removed
- *
- * @return Response as dictated by the HTTP Response code
- *
- * - * Example: - * - * Request URL: - * DELETE http://localhost:8080/controller/nb/v2/staticroute/default/route/route-1 - * - *- */ - @Path("/{containerName}/route/{route}") - @DELETE - @StatusCodes( { - @ResponseCode(code = 204, condition = "Static route removed successfully"), - @ResponseCode(code = 404, condition = "Container Name or Configuration Name not found"), - @ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active") }) - public Response removeStaticRoute( - @PathParam(value = "containerName") String containerName, - @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 - .getInstance(IForwardingStaticRouting.class, containerName, - this); - - if (staticRouting == null) { - throw new ResourceNotFoundException(RestMessages.NOCONTAINER - .toString()); - } - - Status status = staticRouting.removeStaticRoute(route); - if (status.isSuccess()) { - NorthboundUtils.auditlog("Static Route", username, "removed", route, containerName); - return Response.noContent().build(); - } - return NorthboundUtils.getResponse(status); - } - - private void handleDefaultDisabled(String containerName) { - IContainerManager containerManager = (IContainerManager) ServiceHelper - .getGlobalInstance(IContainerManager.class, this); - if (containerManager == null) { - throw new InternalServerErrorException(RestMessages.INTERNALERROR - .toString()); - } - if (containerName.equals(GlobalConstants.DEFAULT.toString()) - && containerManager.hasNonDefaultContainer()) { - throw new NotAcceptableException(RestMessages.DEFAULTDISABLED - .toString()); - } - } -}