Allowing driver loaders to refer to classes loaded by others.

Change-Id: Ife4e50758620d4c052a7bb81740d9b9305647317

@@ -49,7 +49,7 @@ public abstract class AbstractDriverLoader {
     @Activate
     protected void activate() {
         try {
-            provider = new XmlDriverLoader(getClass().getClassLoader())
+            provider = new XmlDriverLoader(getClass().getClassLoader(), driverAdminService)
                     .loadDrivers(getClass().getResourceAsStream(path), driverAdminService);
             driverAdminService.registerProvider(provider);
         } catch (Exception e) {

+/*
+ * 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.net.driver;
+
+/**
+ * Entity capable of resolving a class using its name.
+ */
+public interface BehaviourClassResolver {
+
+    /**
+     * Returns the class corresponding to the specified class name.
+     * @param className class className
+     * @return
+     */
+    Class<? extends Behaviour> getBehaviourClass(String className);
+
+}

@@ -20,7 +20,7 @@ import java.util.Set;
 /**
  * Service for managing drivers and driver behaviour implementations.
  */
-public interface DriverAdminService extends DriverService {
+public interface DriverAdminService extends DriverService, BehaviourClassResolver {
 
     /**
      * Returns the set of driver providers currently registered.

@@ -64,6 +64,7 @@ public class XmlDriverLoader {
     private static final String IMPL = "[@impl]";
 
     private final ClassLoader classLoader;
+    private final BehaviourClassResolver resolver;
 
     private Map<String, Driver> drivers = Maps.newHashMap();
 
@@ -72,9 +73,23 @@ public class XmlDriverLoader {
      * class loader.
      *
      * @param classLoader class loader to use
+     * @deprecated since 1.7.0 (Hummingbird)
      */
+    @Deprecated
     public XmlDriverLoader(ClassLoader classLoader) {
+        this(classLoader, null);
+    }
+
+    /**
+     * Creates a new driver loader capable of loading drivers from the supplied
+     * class loader.
+     *
+     * @param classLoader class loader to use
+     * @param resolver    behaviour class resolver
+     */
+    public XmlDriverLoader(ClassLoader classLoader, BehaviourClassResolver resolver) {
         this.classLoader = classLoader;
+        this.resolver = resolver;
     }
 
     /**
@@ -182,7 +197,13 @@ public class XmlDriverLoader {
         try {
             return (Class<? extends Behaviour>) classLoader.loadClass(className);
         } catch (ClassNotFoundException e) {
-            throw new IllegalArgumentException("Unable to load class " + className, e);
+            if (resolver != null) {
+                Class<? extends Behaviour> cls = resolver.getBehaviourClass(className);
+                if (cls != null) {
+                    return cls;
+                }
+            }
+            throw new IllegalArgumentException("Unable to resolve class " + className, e);
         }
     }
 

 package org.onosproject.net.driver;
 
-import java.util.Set;
-
 import org.junit.Test;
-import org.onosproject.net.DeviceId;
+
+import java.util.Set;
 
 /**
  * Base test class for driver loading.
  */
 public abstract class AbstractDriverLoaderTest {
 
-    private class DriverAdminServiceAdapter implements DriverAdminService {
+    private class DriverAdminServiceAdapter extends DriverServiceAdapter implements DriverAdminService {
         @Override
         public Set<DriverProvider> getProviders() {
             return null;
@@ -18,41 +17,14 @@ public abstract class AbstractDriverLoaderTest {
 
         @Override
         public void registerProvider(DriverProvider provider) {
-
         }
 
         @Override
         public void unregisterProvider(DriverProvider provider) {
-
-        }
-
-        @Override
-        public Set<Driver> getDrivers() {
-            return null;
-        }
-
-        @Override
-        public Set<Driver> getDrivers(Class<? extends Behaviour> withBehaviour) {
-            return null;
-        }
-
-        @Override
-        public Driver getDriver(String mfr, String hw, String sw) {
-            return null;
-        }
-
-        @Override
-        public Driver getDriver(DeviceId deviceId) {
-            return null;
-        }
-
-        @Override
-        public DriverHandler createHandler(DeviceId deviceId, String... credentials) {
-            return null;
         }
 
         @Override
-        public Driver getDriver(String driverName) {
+        public Class<? extends Behaviour> getBehaviourClass(String className) {
             return null;
         }
     }

@@ -33,7 +33,7 @@ public class XmlDriverLoaderTest {
 
     @Test
     public void basics() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         InputStream stream = getClass().getResourceAsStream("drivers.1.xml");
         DriverProvider provider = loader.loadDrivers(stream, null);
         System.out.println(provider);
@@ -59,19 +59,19 @@ public class XmlDriverLoaderTest {
 
     @Test(expected = IOException.class)
     public void badXml() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         loader.loadDrivers(getClass().getResourceAsStream("drivers.bad.xml"), null);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void noClass() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         loader.loadDrivers(getClass().getResourceAsStream("drivers.noclass.xml"), null);
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void noConstructor() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         InputStream stream = getClass().getResourceAsStream("drivers.noconstructor.xml");
         DriverProvider provider = loader.loadDrivers(stream, null);
         Driver driver = provider.getDrivers().iterator().next();
@@ -80,7 +80,7 @@ public class XmlDriverLoaderTest {
 
     @Test
     public void multipleDrivers() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         InputStream stream = getClass().getResourceAsStream("drivers.multipleInheritance.xml");
         DriverProvider provider = loader.loadDrivers(stream, null);
         Iterator<Driver> iterator = provider.getDrivers().iterator();
@@ -94,7 +94,7 @@ public class XmlDriverLoaderTest {
 
     @Test
     public void multipleDriversSameBehaviors() throws IOException {
-        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader());
+        XmlDriverLoader loader = new XmlDriverLoader(getClass().getClassLoader(), null);
         InputStream stream = getClass().getResourceAsStream("drivers.sameMultipleInheritance.xml");
         DriverProvider provider = loader.loadDrivers(stream, null);
         Iterator<Driver> iterator = provider.getDrivers().iterator();

@@ -70,6 +70,7 @@ public class DriverManager extends DefaultDriverProvider implements DriverAdminS
 
     private Set<DriverProvider> providers = Sets.newConcurrentHashSet();
     private Map<String, Driver> driverByKey = Maps.newConcurrentMap();
+    private Map<String, Class<? extends Behaviour>> classes = Maps.newConcurrentMap();
 
     @Activate
     protected void activate() {
@@ -80,6 +81,9 @@ public class DriverManager extends DefaultDriverProvider implements DriverAdminS
     @Deactivate
     protected void deactivate() {
         AbstractProjectableModel.setDriverService(this, null);
+        providers.clear();
+        driverByKey.clear();
+        classes.clear();
         log.info("Stopped");
     }
 
@@ -95,6 +99,11 @@ public class DriverManager extends DefaultDriverProvider implements DriverAdminS
             driverByKey.put(key(driver.manufacturer(),
                                 driver.hwVersion(),
                                 driver.swVersion()), d);
+            d.behaviours().forEach(b -> {
+                Class<? extends Behaviour> implementation = d.implementation(b);
+                classes.put(b.getName(), b);
+                classes.put(implementation.getName(), implementation);
+            });
         });
         providers.add(provider);
     }
@@ -111,6 +120,11 @@ public class DriverManager extends DefaultDriverProvider implements DriverAdminS
     }
 
     @Override
+    public Class<? extends Behaviour> getBehaviourClass(String className) {
+        return classes.get(className);
+    }
+
+    @Override
     public Set<Driver> getDrivers() {
         checkPermission(DRIVER_READ);
         ImmutableSet.Builder<Driver> builder = ImmutableSet.builder();