Allow addition and removal of individual routes via REST.
ONOS-6919
Change-Id: I7c851c92d495b42a9e0948f739859f46eb2ded7a
diff --git a/apps/route-service/app/BUCK b/apps/route-service/app/BUCK
index 30e6c49..f9233bb 100644
--- a/apps/route-service/app/BUCK
+++ b/apps/route-service/app/BUCK
@@ -3,10 +3,13 @@
'//lib:JACKSON',
'//lib:KRYO',
'//lib:concurrent-trees',
+ '//lib:javax.ws.rs-api',
+ '//lib:jersey-server',
'//core/store/serializers:onos-core-serializers',
'//apps/route-service/api:onos-apps-route-service-api',
'//cli:onos-cli',
'//lib:org.apache.karaf.shell.console',
+ '//utils/rest:onlab-rest',
]
TEST_DEPS = [
@@ -18,4 +21,9 @@
osgi_jar_with_tests (
deps = COMPILE_DEPS,
test_deps = TEST_DEPS,
+ web_context = '/onos/routeservice',
+ api_title = 'Route Service App',
+ api_version = '1.0',
+ api_description = 'REST API for Route Service App',
+ api_package = 'org.onosproject.routeservice.rest',
)
diff --git a/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteCodec.java b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteCodec.java
new file mode 100644
index 0000000..3ea9f07
--- /dev/null
+++ b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteCodec.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.routeservice.rest;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onlab.packet.IpAddress;
+import org.onlab.packet.IpPrefix;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.routeservice.Route;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Codec to encode and decode a unicast route to and from JSON.
+ */
+public class RouteCodec extends JsonCodec<Route> {
+
+ private static final String SOURCE = "source";
+ private static final String PREFIX = "prefix";
+ private static final String NEXT_HOP = "nextHop";
+
+ @Override
+ public ObjectNode encode(Route route, CodecContext context) {
+ checkNotNull(route);
+ ObjectNode root = context.mapper().createObjectNode()
+ .put(SOURCE, route.source().toString())
+ .put(PREFIX, route.prefix().toString())
+ .put(NEXT_HOP, route.nextHop().toString());
+
+ return root;
+ }
+
+ @Override
+ public Route decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+
+ IpPrefix prefix = IpPrefix.valueOf(json.path(PREFIX).asText());
+ IpAddress nextHop = IpAddress.valueOf(json.path(NEXT_HOP).asText());
+
+ // Routes through the REST API are created as STATIC, so we ignore
+ // the source parameter if it is specified in the JSON.
+ Route route = new Route(Route.Source.STATIC, prefix, nextHop);
+
+ return route;
+ }
+}
diff --git a/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceCodecRegistrator.java b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceCodecRegistrator.java
new file mode 100644
index 0000000..2868e5f
--- /dev/null
+++ b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceCodecRegistrator.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.routeservice.rest;
+
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.onosproject.codec.CodecService;
+import org.onosproject.routeservice.Route;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * Implementation of the JSON codec brokering service for route service app.
+ */
+@Component(immediate = true)
+public class RouteServiceCodecRegistrator {
+
+ private static Logger log = LoggerFactory.getLogger(RouteServiceCodecRegistrator.class);
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected CodecService codecService;
+
+ @Activate
+ public void activate() {
+ codecService.registerCodec(Route.class, new RouteCodec());
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ log.info("Stopped");
+ }
+}
diff --git a/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebApplication.java b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebApplication.java
new file mode 100644
index 0000000..fe5f361
--- /dev/null
+++ b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebApplication.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.routeservice.rest;
+
+import java.util.Set;
+
+import org.onlab.rest.AbstractWebApplication;
+
+/**
+ * Route Service Web application.
+ */
+public class RouteServiceWebApplication extends AbstractWebApplication {
+ @Override
+ public Set<Class<?>> getClasses() {
+ return getClasses(RouteServiceWebResource.class);
+ }
+}
diff --git a/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebResource.java b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebResource.java
new file mode 100644
index 0000000..bc03799
--- /dev/null
+++ b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/RouteServiceWebResource.java
@@ -0,0 +1,120 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.routeservice.rest;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+import org.onosproject.rest.AbstractWebResource;
+import org.onosproject.routeservice.ResolvedRoute;
+import org.onosproject.routeservice.Route;
+import org.onosproject.routeservice.RouteAdminService;
+import org.onosproject.routeservice.RouteService;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+/**
+ * Manage the unicast routing information.
+ */
+@Path("routes")
+public class RouteServiceWebResource extends AbstractWebResource {
+
+ /**
+ * Get all unicast routes.
+ * Returns array of all known unicast routes.
+ *
+ * @return 200 OK with array of all known unicast routes
+ * @onos.rsModel RoutesGet
+ */
+ @GET
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response getRoutes() {
+ RouteService service = get(RouteService.class);
+ ObjectNode root = mapper().createObjectNode();
+ service.getRouteTables().forEach(table -> {
+ List<Route> routes = service.getRoutes(table).stream()
+ .flatMap(ri -> ri.allRoutes().stream())
+ .map(ResolvedRoute::route)
+ .collect(Collectors.toList());
+ root.put(table.name(), codec(Route.class).encode(routes, this));
+ });
+ return ok(root).build();
+ }
+
+ /**
+ * Create new unicast route.
+ * Creates a new route in the unicast RIB. Routes created through the REST
+ * API are always created as STATIC routes, so there is no need to specify
+ * the type.
+ *
+ * @onos.rsModel RoutePost
+ * @param route unicast route JSON
+ * @return status of the request - CREATED if the JSON is correct,
+ * BAD_REQUEST if the JSON is invalid, NO_CONTENT otherwise
+ */
+ @POST
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response createRoute(InputStream route) {
+ RouteAdminService service = get(RouteAdminService.class);
+ try {
+ ObjectNode jsonTree = (ObjectNode) mapper().readTree(route);
+ Route r = codec(Route.class).decode(jsonTree, this);
+ service.update(Collections.singletonList(r));
+ } catch (IOException ex) {
+ throw new IllegalArgumentException(ex);
+ }
+
+ return Response
+ .noContent()
+ .build();
+ }
+
+ /**
+ * Remove a unicast route.
+ * Removes a route from the unicast RIB.
+ *
+ * @param route unicast route JSON
+ * @return 204 NO CONTENT
+ * @onos.rsModel RoutePost
+ */
+ @DELETE
+ @Consumes(MediaType.APPLICATION_JSON)
+ public Response deleteRoute(InputStream route) {
+ RouteAdminService service = get(RouteAdminService.class);
+ try {
+ ObjectNode jsonTree = (ObjectNode) mapper().readTree(route);
+ Route r = codec(Route.class).decode(jsonTree, this);
+ service.withdraw(Collections.singletonList(r));
+ } catch (IOException ex) {
+ throw new IllegalArgumentException(ex);
+ }
+ return Response.noContent().build();
+ }
+}
diff --git a/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/package-info.java b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/package-info.java
new file mode 100644
index 0000000..b3fa22b
--- /dev/null
+++ b/apps/route-service/app/src/main/java/org/onosproject/routeservice/rest/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * REST APIs for sample application that assigns and manages DHCP leases.
+ */
+package org.onosproject.routeservice.rest;
diff --git a/apps/route-service/app/src/main/resources/definitions/RoutePost.json b/apps/route-service/app/src/main/resources/definitions/RoutePost.json
new file mode 100644
index 0000000..c55578a
--- /dev/null
+++ b/apps/route-service/app/src/main/resources/definitions/RoutePost.json
@@ -0,0 +1,20 @@
+{
+ "type": "object",
+ "title": "route",
+ "required": [
+ "prefix",
+ "nextHop"
+ ],
+ "properties": {
+ "prefix": {
+ "type": "string",
+ "example": "10.1.1.0/24",
+ "description": "Route prefix"
+ },
+ "nextHop": {
+ "type": "string",
+ "example": "1.1.1.1",
+ "description": "Next hop IP address"
+ }
+ }
+}
diff --git a/apps/route-service/app/src/main/resources/definitions/RoutesGet.json b/apps/route-service/app/src/main/resources/definitions/RoutesGet.json
new file mode 100644
index 0000000..0ddb67d
--- /dev/null
+++ b/apps/route-service/app/src/main/resources/definitions/RoutesGet.json
@@ -0,0 +1,76 @@
+{
+ "type": "object",
+ "title": "routes",
+ "required": [
+ "ipv4",
+ "ipv6"
+ ],
+ "properties": {
+ "ipv4": {
+ "type": "array",
+ "xml": {
+ "name": "ipv4",
+ "wrapped": true
+ },
+ "items": {
+ "type": "object",
+ "title": "route",
+ "required": [
+ "source",
+ "prefix",
+ "nextHop"
+ ],
+ "properties": {
+ "source": {
+ "type": "string",
+ "example": "STATIC",
+ "description": "Route source"
+ },
+ "prefix": {
+ "type": "string",
+ "example": "10.1.1.0/24",
+ "description": "Route prefix"
+ },
+ "nextHop": {
+ "type": "string",
+ "example": "1.1.1.1",
+ "description": "Next hop IP address"
+ }
+ }
+ }
+ },
+ "ipv6": {
+ "type": "array",
+ "xml": {
+ "name": "ipv6",
+ "wrapped": true
+ },
+ "items": {
+ "type": "object",
+ "title": "route",
+ "required": [
+ "source",
+ "prefix",
+ "nextHop"
+ ],
+ "properties": {
+ "source": {
+ "type": "string",
+ "example": "STATIC",
+ "description": "Route source"
+ },
+ "prefix": {
+ "type": "string",
+ "example": "1111::/64",
+ "description": "Route prefix"
+ },
+ "nextHop": {
+ "type": "string",
+ "example": "2222::1",
+ "description": "Next hop IP address"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/apps/route-service/app/src/main/webapp/WEB-INF/web.xml b/apps/route-service/app/src/main/webapp/WEB-INF/web.xml
new file mode 100644
index 0000000..4ee6c96
--- /dev/null
+++ b/apps/route-service/app/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2017-present Open Networking Foundation
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://java.sun.com/xml/ns/javaee"
+ xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+ id="ONOS" version="2.5">
+ <display-name>DHCP Server REST API v1.0</display-name>
+
+ <security-constraint>
+ <web-resource-collection>
+ <web-resource-name>Secured</web-resource-name>
+ <url-pattern>/*</url-pattern>
+ </web-resource-collection>
+ <auth-constraint>
+ <role-name>admin</role-name>
+ </auth-constraint>
+ </security-constraint>
+
+ <security-role>
+ <role-name>admin</role-name>
+ </security-role>
+
+ <login-config>
+ <auth-method>BASIC</auth-method>
+ <realm-name>karaf</realm-name>
+ </login-config>
+
+ <servlet>
+ <servlet-name>JAX-RS Service</servlet-name>
+ <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
+ <init-param>
+ <param-name>javax.ws.rs.Application</param-name>
+ <param-value>org.onosproject.routeservice.rest.RouteServiceWebApplication</param-value>
+ </init-param>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+
+ <servlet-mapping>
+ <servlet-name>JAX-RS Service</servlet-name>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+</web-app>
diff --git a/core/common/src/main/java/org/onosproject/codec/impl/CodecManager.java b/core/common/src/main/java/org/onosproject/codec/impl/CodecManager.java
index 7c06b76..cd39d47 100644
--- a/core/common/src/main/java/org/onosproject/codec/impl/CodecManager.java
+++ b/core/common/src/main/java/org/onosproject/codec/impl/CodecManager.java
@@ -48,13 +48,13 @@
import org.onosproject.net.Annotations;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.Device;
+import org.onosproject.net.DisjointPath;
+import org.onosproject.net.FilteredConnectPoint;
import org.onosproject.net.Host;
import org.onosproject.net.HostLocation;
import org.onosproject.net.Link;
import org.onosproject.net.MastershipRole;
import org.onosproject.net.Path;
-import org.onosproject.net.DisjointPath;
-import org.onosproject.net.FilteredConnectPoint;
import org.onosproject.net.Port;
import org.onosproject.net.behaviour.protection.TransportEndpointDescription;
import org.onosproject.net.device.PortStatistics;
@@ -97,7 +97,8 @@
import java.util.concurrent.ConcurrentHashMap;
import static org.onosproject.security.AppGuard.checkPermission;
-import static org.onosproject.security.AppPermission.Type.*;
+import static org.onosproject.security.AppPermission.Type.CODEC_READ;
+import static org.onosproject.security.AppPermission.Type.CODEC_WRITE;
/**
* Implementation of the JSON codec brokering service.