ONOS-3650 Device driver multiple inheritance
Change-Id: Ib7b72d44533d4e63c4122662b50485243562aa21
diff --git a/core/api/src/main/java/org/onosproject/net/driver/DefaultDriver.java b/core/api/src/main/java/org/onosproject/net/driver/DefaultDriver.java
index b7a9f2b..f1d1fb4 100644
--- a/core/api/src/main/java/org/onosproject/net/driver/DefaultDriver.java
+++ b/core/api/src/main/java/org/onosproject/net/driver/DefaultDriver.java
@@ -16,8 +16,11 @@
package org.onosproject.net.driver;
import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
+import org.slf4j.Logger;
+import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
@@ -26,14 +29,17 @@
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.ImmutableMap.copyOf;
+import static org.slf4j.LoggerFactory.getLogger;
/**
* Default implementation of extensible driver.
*/
public class DefaultDriver implements Driver {
+ private final Logger log = getLogger(getClass());
+
private final String name;
- private final Driver parent;
+ private final List<Driver> parents;
private final String manufacturer;
private final String hwVersion;
@@ -53,12 +59,37 @@
* @param behaviours device behaviour classes
* @param properties properties for configuration of device behaviour classes
*/
+ @Deprecated
public DefaultDriver(String name, Driver parent, String manufacturer,
String hwVersion, String swVersion,
Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours,
Map<String, String> properties) {
this.name = checkNotNull(name, "Name cannot be null");
- this.parent = parent;
+ this.parents = parent == null ? null : Lists.newArrayList(parent);
+ this.manufacturer = checkNotNull(manufacturer, "Manufacturer cannot be null");
+ this.hwVersion = checkNotNull(hwVersion, "HW version cannot be null");
+ this.swVersion = checkNotNull(swVersion, "SW version cannot be null");
+ this.behaviours = copyOf(checkNotNull(behaviours, "Behaviours cannot be null"));
+ this.properties = copyOf(checkNotNull(properties, "Properties cannot be null"));
+ }
+
+ /**
+ * Creates a driver with the specified name.
+ *
+ * @param name driver name
+ * @param parents optional parent drivers
+ * @param manufacturer device manufacturer
+ * @param hwVersion device hardware version
+ * @param swVersion device software version
+ * @param behaviours device behaviour classes
+ * @param properties properties for configuration of device behaviour classes
+ */
+ public DefaultDriver(String name, List<Driver> parents, String manufacturer,
+ String hwVersion, String swVersion,
+ Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours,
+ Map<String, String> properties) {
+ this.name = checkNotNull(name, "Name cannot be null");
+ this.parents = parents == null || parents.isEmpty() ? null : parents;
this.manufacturer = checkNotNull(manufacturer, "Manufacturer cannot be null");
this.hwVersion = checkNotNull(hwVersion, "HW version cannot be null");
this.swVersion = checkNotNull(swVersion, "SW version cannot be null");
@@ -68,7 +99,7 @@
@Override
public Driver merge(Driver other) {
- checkArgument(parent == null || Objects.equals(parent, other.parent()),
+ checkArgument(parents == null || Objects.equals(parent(), other.parent()),
"Parent drivers are not the same");
// Merge the behaviours.
@@ -81,7 +112,8 @@
ImmutableMap.Builder<String, String> properties = ImmutableMap.builder();
properties.putAll(this.properties).putAll(other.properties());
- return new DefaultDriver(name, other.parent(), manufacturer, hwVersion, swVersion,
+ return new DefaultDriver(name, other.parents(),
+ manufacturer, hwVersion, swVersion,
ImmutableMap.copyOf(behaviours), properties.build());
}
@@ -107,7 +139,12 @@
@Override
public Driver parent() {
- return parent;
+ return parents == null ? null : parents.get(0);
+ }
+
+ @Override
+ public List<Driver> parents() {
+ return parents;
}
@Override
@@ -123,7 +160,8 @@
@Override
public boolean hasBehaviour(Class<? extends Behaviour> behaviourClass) {
return behaviours.containsKey(behaviourClass) ||
- (parent != null && parent.hasBehaviour(behaviourClass));
+ (parents != null && parents.stream()
+ .filter(parent -> parent.hasBehaviour(behaviourClass)).count() > 0);
}
@Override
@@ -132,8 +170,14 @@
T behaviour = createBehaviour(data, null, behaviourClass);
if (behaviour != null) {
return behaviour;
- } else if (parent != null) {
- return parent.createBehaviour(data, behaviourClass);
+ } else if (parents != null) {
+ for (Driver parent : Lists.reverse(parents)) {
+ try {
+ return parent.createBehaviour(data, behaviourClass);
+ } catch (IllegalArgumentException e) {
+ log.debug("Parent {} does not support behaviour {}", parent, behaviourClass);
+ }
+ }
}
throw new IllegalArgumentException(behaviourClass.getName() + " not supported");
}
@@ -144,8 +188,14 @@
T behaviour = createBehaviour(handler.data(), handler, behaviourClass);
if (behaviour != null) {
return behaviour;
- } else if (parent != null) {
- return parent.createBehaviour(handler, behaviourClass);
+ } else if (parents != null && !parents.isEmpty()) {
+ for (Driver parent : Lists.reverse(parents)) {
+ try {
+ return parent.createBehaviour(handler, behaviourClass);
+ } catch (IllegalArgumentException e) {
+ log.debug("Parent {} does not support behaviour {}", parent, behaviourClass);
+ }
+ }
}
throw new IllegalArgumentException(behaviourClass.getName() + " not supported");
}
@@ -202,7 +252,7 @@
public String toString() {
return toStringHelper(this)
.add("name", name)
- .add("parent", parent)
+ .add("parents", parents)
.add("manufacturer", manufacturer)
.add("hwVersion", hwVersion)
.add("swVersion", swVersion)
diff --git a/core/api/src/main/java/org/onosproject/net/driver/Driver.java b/core/api/src/main/java/org/onosproject/net/driver/Driver.java
index 50611b1..3dc0fdb0 100644
--- a/core/api/src/main/java/org/onosproject/net/driver/Driver.java
+++ b/core/api/src/main/java/org/onosproject/net/driver/Driver.java
@@ -17,6 +17,7 @@
import org.onosproject.net.Annotations;
+import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -40,9 +41,18 @@
*
* @return parent driver; null if driver has no parent
*/
+ @Deprecated
Driver parent();
/**
+ * Returns all the parent drivers from which this driver inherits behaviours
+ * and properties.
+ *
+ * @return list of parent drivers; null if driver has no parent
+ */
+ List<Driver> parents();
+
+ /**
* Returns the device manufacturer name.
*
* @return manufacturer name
diff --git a/core/api/src/main/java/org/onosproject/net/driver/XmlDriverLoader.java b/core/api/src/main/java/org/onosproject/net/driver/XmlDriverLoader.java
index fc5e04a..af79ba6 100644
--- a/core/api/src/main/java/org/onosproject/net/driver/XmlDriverLoader.java
+++ b/core/api/src/main/java/org/onosproject/net/driver/XmlDriverLoader.java
@@ -16,6 +16,7 @@
package org.onosproject.net.driver;
import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.HierarchicalConfiguration;
@@ -23,7 +24,10 @@
import java.io.IOException;
import java.io.InputStream;
+import java.util.Arrays;
+import java.util.List;
import java.util.Map;
+import java.util.stream.Collectors;
/**
* Utility capable of reading driver configuration XML resources and producing
@@ -126,13 +130,22 @@
public DefaultDriver loadDriver(HierarchicalConfiguration driverCfg,
DriverResolver resolver) {
String name = driverCfg.getString(NAME);
- String parentName = driverCfg.getString(EXTENDS);
+ String parentsString = driverCfg.getString(EXTENDS, "");
+ List<Driver> parents = Lists.newArrayList();
+ if (!parentsString.equals("")) {
+ List<String> parentsNames;
+ if (parentsString.contains(",")) {
+ parentsNames = Arrays.asList(parentsString.replace(" ", "").split(","));
+ } else {
+ parentsNames = Lists.newArrayList(parentsString);
+ }
+ parents = parentsNames.stream().map(parent -> (parent != null) ?
+ resolve(parent, resolver) : null).collect(Collectors.toList());
+ }
String manufacturer = driverCfg.getString(MFG, "");
String hwVersion = driverCfg.getString(HW, "");
String swVersion = driverCfg.getString(SW, "");
-
- Driver parent = parentName != null ? resolve(parentName, resolver) : null;
- return new DefaultDriver(name, parent, manufacturer, hwVersion, swVersion,
+ return new DefaultDriver(name, parents, manufacturer, hwVersion, swVersion,
parseBehaviours(driverCfg),
parseProperties(driverCfg));
}