X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnorthbound%2Fstaticrouting%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fforwarding%2Fstaticrouting%2Fnorthbound%2FStaticRoutingNorthbound.java;h=07f125dae3f79a8428d7609a18c1f4194b2553a1;hp=c48d7ec02684463962909ec2d60b600e3b270167;hb=d059b1faef43031951d426048974fa9b32dceba3;hpb=59cc8f34c24d81a8890a94c11dedd4b21caa0adf diff --git a/opendaylight/northbound/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/northbound/StaticRoutingNorthbound.java b/opendaylight/northbound/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/northbound/StaticRoutingNorthbound.java index c48d7ec026..07f125dae3 100644 --- a/opendaylight/northbound/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/northbound/StaticRoutingNorthbound.java +++ b/opendaylight/northbound/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/northbound/StaticRoutingNorthbound.java @@ -16,6 +16,7 @@ import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; +import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; @@ -23,6 +24,7 @@ import javax.ws.rs.core.Context; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import javax.ws.rs.core.SecurityContext; +import javax.ws.rs.core.UriInfo; import javax.xml.bind.JAXBElement; import org.codehaus.enunciate.jaxrs.ResponseCode; @@ -44,33 +46,42 @@ import org.opendaylight.controller.sal.utils.ServiceHelper; import org.opendaylight.controller.sal.utils.Status; /** - * Static Routing Northbound APIs + *
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/routes + * + * 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}") + @Path("/{containerName}/routes") @GET @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) @TypeHint(StaticRoutes.class) @@ -109,9 +140,9 @@ public class StaticRoutingNorthbound { public StaticRoutes getStaticRoutes( @PathParam("containerName") String containerName) { - if(!NorthboundUtils.isAuthorized(getUserName(), containerName, + if(!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)){ - throw new + throw new UnauthorizedException("User is not authorized to perform this operation on container " + containerName); } @@ -122,10 +153,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) @@ -134,18 +184,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, + if(!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)){ - throw new + throw new UnauthorizedException("User is not authorized to perform this operation on container " + containerName); } List
+ * Example: + * + * Request URL: + * PUT 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}") - @POST + @Path("/{containerName}/route/{route}") + @PUT @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) @StatusCodes( { @ResponseCode(code = 201, condition = "Created Static Route successfully"), @@ -170,14 +232,15 @@ 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, - @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"), + @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 = "name") String name) { - - if(!NorthboundUtils.isAuthorized(getUserName(), containerName, + @PathParam(value = "route") String route) { + + if(!NorthboundUtils.isAuthorized(getUserName(), containerName, Privilege.WRITE, this)){ - throw new + throw new UnauthorizedException("User is not authorized to perform this operation on container " + containerName); } @@ -239,11 +310,12 @@ public class StaticRoutingNorthbound { .toString()); } - Status status = staticRouting.removeStaticRoute(name); + Status status = staticRouting.removeStaticRoute(route); if (status.isSuccess()) { - return Response.ok().build(); + NorthboundUtils.auditlog("Static Route", username, "removed", route, containerName); + return Response.noContent().build(); } - throw new ResourceNotFoundException(status.getDescription()); + return NorthboundUtils.getResponse(status); } private void handleDefaultDisabled(String containerName) {