ONOS-3692 Southbound Rest provider and protocol
Change-Id: I74a5752d4fce1df88828fa6c531979ab7c30a26a
t
diff --git a/providers/netconf/app/pom.xml b/providers/netconf/app/pom.xml
index 0a982ce..6323eb3 100644
--- a/providers/netconf/app/pom.xml
+++ b/providers/netconf/app/pom.xml
@@ -38,6 +38,7 @@
<version>${project.version}</version>
</dependency>
<!-- Add other dependencies here as more bundles are added to the app -->
+
</dependencies>
</project>
diff --git a/providers/pom.xml b/providers/pom.xml
index 31f31c4..f72090b 100644
--- a/providers/pom.xml
+++ b/providers/pom.xml
@@ -42,6 +42,7 @@
<module>ovsdb</module>
<module>bgp</module>
<module>snmp</module>
+ <module>rest</module>
</modules>
<dependencies>
diff --git a/providers/rest/app/app.xml b/providers/rest/app/app.xml
new file mode 100644
index 0000000..1b4d681
--- /dev/null
+++ b/providers/rest/app/app.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2016 Open Networking Laboratory
+ ~
+ ~ 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.
+ -->
+<app name="org.onosproject.restsb" origin="ON.Lab" version="${project.version}"
+ featuresRepo="mvn:${project.groupId}/${project.artifactId}/${project.version}/xml/features"
+ features="${project.artifactId}">
+ <description>${project.description}</description>
+
+ <artifact>mvn:${project.groupId}/onos-restsb-api/${project.version}</artifact>
+ <artifact>mvn:${project.groupId}/onos-restsb-ctl/${project.version}</artifact>
+ <artifact>mvn:${project.groupId}/onos-drivers/${project.version}</artifact>
+
+ <artifact>mvn:${project.groupId}/onos-restsb-provider-device/${project.version}</artifact>
+
+</app>
diff --git a/providers/rest/app/features.xml b/providers/rest/app/features.xml
new file mode 100644
index 0000000..168ae55
--- /dev/null
+++ b/providers/rest/app/features.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<!--
+ ~ Copyright 2016 Open Networking Laboratory
+ ~
+ ~ 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.
+ -->
+<features xmlns="http://karaf.apache.org/xmlns/features/v1.2.0" name="${project.artifactId}-${project.version}">
+ <feature name="${project.artifactId}" version="${project.version}"
+ description="${project.description}">
+ <feature>onos-api</feature>
+ <bundle>mvn:${project.groupId}/onos-restsb-api/${project.version}</bundle>
+ <bundle>mvn:${project.groupId}/onos-restsb-ctl/${project.version}</bundle>
+
+ <bundle>mvn:${project.groupId}/onos-restsb-provider-device/${project.version}</bundle>
+
+ <bundle>mvn:com.sun.jersey/jersey-client/1.19</bundle>
+ <bundle>mvn:commons-io/commons-io/2.4</bundle>
+ </feature>
+</features>
+
diff --git a/providers/rest/app/pom.xml b/providers/rest/app/pom.xml
new file mode 100644
index 0000000..1d4622b
--- /dev/null
+++ b/providers/rest/app/pom.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2016 Open Networking Laboratory
+ ~
+ ~ 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.
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-restsb-providers</artifactId>
+ <version>1.5.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>onos-restsb-app</artifactId>
+
+ <packaging>pom</packaging>
+
+ <description>REST protocol southbound providers</description>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-restsb-provider-device</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <!-- Add other dependencies here as more bundles are added to the app -->
+ </dependencies>
+</project>
\ No newline at end of file
diff --git a/providers/rest/device/pom.xml b/providers/rest/device/pom.xml
new file mode 100644
index 0000000..8006f8edaf
--- /dev/null
+++ b/providers/rest/device/pom.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2016 Open Networking Laboratory
+ ~
+ ~ 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.
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <artifactId>onos-restsb-providers</artifactId>
+ <groupId>org.onosproject</groupId>
+ <version>1.5.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>onos-restsb-provider-device</artifactId>
+ <packaging>bundle</packaging>
+ <dependencies>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-restsb-api</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-restsb-ctl</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-scr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-maven-plugin</artifactId>
+ </plugin>
+ </plugins>
+ </build>
+
+
+</project>
\ No newline at end of file
diff --git a/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestDeviceProvider.java b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestDeviceProvider.java
new file mode 100644
index 0000000..8638561
--- /dev/null
+++ b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestDeviceProvider.java
@@ -0,0 +1,241 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.provider.rest.device.impl;
+
+import com.google.common.base.Preconditions;
+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.onlab.packet.ChassisId;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.core.CoreService;
+import org.onosproject.incubator.net.config.basics.ConfigException;
+import org.onosproject.net.DefaultAnnotations;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.MastershipRole;
+import org.onosproject.net.SparseAnnotations;
+import org.onosproject.net.config.ConfigFactory;
+import org.onosproject.net.config.NetworkConfigEvent;
+import org.onosproject.net.config.NetworkConfigListener;
+import org.onosproject.net.config.NetworkConfigRegistry;
+import org.onosproject.net.device.DefaultDeviceDescription;
+import org.onosproject.net.device.DeviceDescription;
+import org.onosproject.net.device.DeviceProvider;
+import org.onosproject.net.device.DeviceProviderRegistry;
+import org.onosproject.net.device.DeviceProviderService;
+import org.onosproject.net.device.PortDescription;
+import org.onosproject.net.provider.AbstractProvider;
+import org.onosproject.net.provider.ProviderId;
+import org.onosproject.protocol.rest.RestSBController;
+import org.onosproject.protocol.rest.RestSBDevice;
+import org.slf4j.Logger;
+
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import static org.onosproject.net.config.NetworkConfigEvent.Type.CONFIG_ADDED;
+import static org.onosproject.net.config.NetworkConfigEvent.Type.CONFIG_UPDATED;
+import static org.onosproject.net.config.basics.SubjectFactories.APP_SUBJECT_FACTORY;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Provider for devices that use REST as means of configuration communication.
+ */
+@Component(immediate = true)
+public class RestDeviceProvider extends AbstractProvider
+ implements DeviceProvider {
+ private static final String APP_NAME = "org.onosproject.restsb";
+ private static final String REST = "rest";
+ private static final String PROVIDER = "org.onosproject.provider.rest.device";
+ private static final String IPADDRESS = "ipaddress";
+ private static final int TEST_CONNECT_TIMEOUT = 1000;
+ private final Logger log = getLogger(getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected DeviceProviderRegistry providerRegistry;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected RestSBController controller;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected NetworkConfigRegistry cfgService;
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected CoreService coreService;
+
+
+ private DeviceProviderService providerService;
+ protected static final String ISNOTNULL = "Rest device is not null";
+ private static final String UNKNOWN = "unknown";
+
+ private final ConfigFactory factory =
+ new ConfigFactory<ApplicationId, RestProviderConfig>(APP_SUBJECT_FACTORY,
+ RestProviderConfig.class,
+ "restDevices",
+ true) {
+ @Override
+ public RestProviderConfig createConfig() {
+ return new RestProviderConfig();
+ }
+ };
+ private final NetworkConfigListener cfgLister = new InternalNetworkConfigListener();
+ private ApplicationId appId;
+
+
+ @Activate
+ public void activate() {
+ appId = coreService.registerApplication(APP_NAME);
+ providerService = providerRegistry.register(this);
+ cfgService.registerConfigFactory(factory);
+ cfgService.addListener(cfgLister);
+ connectDevices();
+ log.info("Started");
+ }
+
+
+ @Deactivate
+ public void deactivate() {
+ providerRegistry.unregister(this);
+ providerService = null;
+ cfgService.unregisterConfigFactory(factory);
+ cfgService.removeListener(cfgLister);
+ log.info("Stopped");
+ }
+
+ public RestDeviceProvider() {
+ super(new ProviderId(REST, PROVIDER));
+ }
+
+ @Override
+ public void triggerProbe(DeviceId deviceId) {
+ // TODO: This will be implemented later.
+ log.info("Triggering probe on device {}", deviceId);
+ }
+
+ @Override
+ public void roleChanged(DeviceId deviceId, MastershipRole newRole) {
+ // TODO: This will be implemented later.
+ }
+
+
+ @Override
+ public boolean isReachable(DeviceId deviceId) {
+ RestSBDevice restDevice = controller.getDevice(deviceId);
+ if (restDevice == null) {
+ log.warn("BAD REQUEST: the requested device id: " +
+ deviceId.toString() +
+ " is not associated to any REST Device");
+ return false;
+ }
+ return restDevice.isActive();
+ }
+
+ private void deviceAdded(RestSBDevice nodeId) {
+ Preconditions.checkNotNull(nodeId, ISNOTNULL);
+ DeviceId deviceId = nodeId.deviceId();
+ ChassisId cid = new ChassisId();
+ String ipAddress = nodeId.ip().toString();
+ SparseAnnotations annotations = DefaultAnnotations.builder()
+ .set(IPADDRESS, ipAddress).build();
+ DeviceDescription deviceDescription = new DefaultDeviceDescription(
+ deviceId.uri(),
+ Device.Type.SWITCH,
+ UNKNOWN, UNKNOWN,
+ UNKNOWN, UNKNOWN,
+ cid,
+ annotations);
+ providerService.deviceConnected(deviceId, deviceDescription);
+ nodeId.setActive(true);
+ controller.addDevice(nodeId);
+ }
+
+ private void updatePorts(DeviceId deviceId, List<PortDescription> portDescriptions) {
+ // TODO get driver and call behavior to get ports
+ //signal the ports to onos
+ }
+
+ //when do I call it ?
+ public void deviceRemoved(RestSBDevice nodeId) {
+ Preconditions.checkNotNull(nodeId, ISNOTNULL);
+ DeviceId deviceId = nodeId.deviceId();
+ providerService.deviceDisconnected(deviceId);
+ controller.removeDevice(nodeId);
+ }
+
+ private void connectDevices() {
+ RestProviderConfig cfg = cfgService.getConfig(appId, RestProviderConfig.class);
+ try {
+ if (cfg != null && cfg.getDevicesAddresses() != null) {
+ //Precomputing the devices to be removed
+ Set<RestSBDevice> toBeRemoved = new HashSet<>(controller.getDevices().values());
+ toBeRemoved.removeAll(cfg.getDevicesAddresses());
+ //Adding new devices
+ cfg.getDevicesAddresses().stream()
+ .filter(device -> testDeviceConnection(device))
+ .forEach(device -> {
+ deviceAdded(device);
+ });
+ //Removing devices not wanted anymore
+ toBeRemoved.stream().forEach(device -> deviceRemoved(device));
+
+ }
+ } catch (ConfigException e) {
+ log.error("Configuration error {}", e);
+ }
+ log.info("REST Devices {}", controller.getDevices());
+ //TODO ask for ports then call update ports.
+
+ }
+
+ private boolean testDeviceConnection(RestSBDevice device) {
+ try {
+ URL url = new URL(device.protocol(), device.ip().toString(), device.port(), "/");
+ HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();
+ urlConn.setConnectTimeout(TEST_CONNECT_TIMEOUT);
+ boolean open = urlConn.getResponseCode() == (HttpURLConnection.HTTP_OK);
+ urlConn.disconnect();
+ return open;
+ } catch (IOException e) {
+ log.error("Device {} not reachable, error creating HTTP connection", device, e);
+ }
+ return false;
+ }
+
+ private class InternalNetworkConfigListener implements NetworkConfigListener {
+
+
+ @Override
+ public void event(NetworkConfigEvent event) {
+ connectDevices();
+ }
+
+ @Override
+ public boolean isRelevant(NetworkConfigEvent event) {
+ //TODO refactor
+ return event.configClass().equals(RestProviderConfig.class) &&
+ (event.type() == CONFIG_ADDED ||
+ event.type() == CONFIG_UPDATED);
+ }
+ }
+}
diff --git a/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestProviderConfig.java b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestProviderConfig.java
new file mode 100644
index 0000000..2056dce
--- /dev/null
+++ b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/RestProviderConfig.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.provider.rest.device.impl;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.google.common.annotations.Beta;
+import com.google.common.collect.Sets;
+import org.onlab.packet.IpAddress;
+import org.onosproject.core.ApplicationId;
+import org.onosproject.incubator.net.config.basics.ConfigException;
+import org.onosproject.net.config.Config;
+import org.onosproject.protocol.rest.DefaultRestSBDevice;
+import org.onosproject.protocol.rest.RestSBDevice;
+
+
+import java.util.Set;
+
+/**
+ * Configuration for RestSB provider.
+ */
+@Beta
+public class RestProviderConfig extends Config<ApplicationId> {
+
+ public static final String CONFIG_VALUE_ERROR = "Error parsing config value";
+ private static final String IP = "ip";
+ private static final int DEFAULT_HTTP_PORT = 80;
+ private static final String PORT = "port";
+ private static final String NAME = "name";
+ private static final String PASSWORD = "password";
+ private static final String PROTOCOL = "protocol";
+
+ public Set<RestSBDevice> getDevicesAddresses() throws ConfigException {
+ Set<RestSBDevice> devicesAddresses = Sets.newHashSet();
+
+ try {
+ for (JsonNode node : array) {
+ String ip = node.path(IP).asText();
+ IpAddress ipAddr = ip.isEmpty() ? null : IpAddress.valueOf(ip);
+ int port = node.path(PORT).asInt(DEFAULT_HTTP_PORT);
+ String name = node.path(NAME).asText();
+ String password = node.path(PASSWORD).asText();
+ String protocol = node.path(PROTOCOL).asText();
+ devicesAddresses.add(new DefaultRestSBDevice(ipAddr, port, name,
+ password, protocol, false));
+
+ }
+ } catch (IllegalArgumentException e) {
+ throw new ConfigException(CONFIG_VALUE_ERROR, e);
+ }
+
+ return devicesAddresses;
+ }
+
+}
diff --git a/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/package-info.java b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/package-info.java
new file mode 100644
index 0000000..d8b4fdd
--- /dev/null
+++ b/providers/rest/device/src/main/java/org/onosproject/provider/rest/device/impl/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.
+ */
+
+/**
+ * Provider that uses REST calls request as a means of device discovery and setup.
+ */
+package org.onosproject.provider.rest.device.impl;
\ No newline at end of file
diff --git a/providers/rest/pom.xml b/providers/rest/pom.xml
new file mode 100644
index 0000000..fde493c
--- /dev/null
+++ b/providers/rest/pom.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2016 Open Networking Laboratory
+ ~
+ ~ 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.
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <artifactId>onos-providers</artifactId>
+ <groupId>org.onosproject</groupId>
+ <version>1.5.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>onos-restsb-providers</artifactId>
+ <packaging>pom</packaging>
+ <modules>
+ <module>app</module>
+ <module>device</module>
+ </modules>
+</project>
\ No newline at end of file