Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.net.driver; |
| 17 | |
| 18 | import com.google.common.collect.ImmutableMap; |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 20 | import com.google.common.collect.Maps; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 21 | import org.apache.commons.configuration.ConfigurationException; |
| 22 | import org.apache.commons.configuration.HierarchicalConfiguration; |
| 23 | import org.apache.commons.configuration.XMLConfiguration; |
| 24 | |
| 25 | import java.io.IOException; |
| 26 | import java.io.InputStream; |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 27 | import java.util.Arrays; |
| 28 | import java.util.List; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 29 | import java.util.Map; |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 30 | import java.util.stream.Collectors; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Utility capable of reading driver configuration XML resources and producing |
| 34 | * a device driver provider as a result. |
| 35 | * <p> |
| 36 | * The drivers stream structure is as follows: |
| 37 | * </p> |
| 38 | * <pre> |
| 39 | * <drivers> |
| 40 | * <driver name=“...” [manufacturer="..." hwVersion="..." swVersion="..."]> |
| 41 | * <behaviour api="..." impl="..."/> |
| 42 | * ... |
| 43 | * [<property name=“key”>value</key>] |
| 44 | * ... |
| 45 | * </driver> |
| 46 | * ... |
| 47 | * </drivers> |
| 48 | * </pre> |
| 49 | */ |
| 50 | public class XmlDriverLoader { |
| 51 | |
| 52 | private static final String DRIVERS = "drivers"; |
| 53 | private static final String DRIVER = "driver"; |
| 54 | |
| 55 | private static final String BEHAVIOUR = "behaviour"; |
| 56 | private static final String PROPERTY = "property"; |
| 57 | |
| 58 | private static final String NAME = "[@name]"; |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 59 | private static final String EXTENDS = "[@extends]"; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 60 | private static final String MFG = "[@manufacturer]"; |
| 61 | private static final String HW = "[@hwVersion]"; |
| 62 | private static final String SW = "[@swVersion]"; |
| 63 | private static final String API = "[@api]"; |
| 64 | private static final String IMPL = "[@impl]"; |
| 65 | |
| 66 | private final ClassLoader classLoader; |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 67 | private final BehaviourClassResolver resolver; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 68 | |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 69 | private Map<String, Driver> drivers = Maps.newHashMap(); |
| 70 | |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 71 | /** |
| 72 | * Creates a new driver loader capable of loading drivers from the supplied |
| 73 | * class loader. |
| 74 | * |
| 75 | * @param classLoader class loader to use |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 76 | * @deprecated since 1.7.0 (Hummingbird) |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 77 | */ |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 78 | @Deprecated |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 79 | public XmlDriverLoader(ClassLoader classLoader) { |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 80 | this(classLoader, null); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Creates a new driver loader capable of loading drivers from the supplied |
| 85 | * class loader. |
| 86 | * |
| 87 | * @param classLoader class loader to use |
| 88 | * @param resolver behaviour class resolver |
| 89 | */ |
| 90 | public XmlDriverLoader(ClassLoader classLoader, BehaviourClassResolver resolver) { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 91 | this.classLoader = classLoader; |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 92 | this.resolver = resolver; |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Loads the specified drivers resource as an XML stream and parses it to |
| 97 | * produce a ready-to-register driver provider. |
| 98 | * |
| 99 | * @param driversStream stream containing the drivers definitions |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 100 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 101 | * @return driver provider |
| 102 | * @throws java.io.IOException if issues are encountered reading the stream |
| 103 | * or parsing the driver definitions within |
| 104 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 105 | public DefaultDriverProvider loadDrivers(InputStream driversStream, |
| 106 | DriverResolver resolver) throws IOException { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 107 | try { |
| 108 | XMLConfiguration cfg = new XMLConfiguration(); |
| 109 | cfg.setRootElementName(DRIVERS); |
| 110 | cfg.setAttributeSplittingDisabled(true); |
| 111 | |
| 112 | cfg.load(driversStream); |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 113 | return loadDrivers(cfg, resolver); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 114 | } catch (ConfigurationException e) { |
| 115 | throw new IOException("Unable to load drivers", e); |
| 116 | } |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Loads a driver provider from the supplied hierarchical configuration. |
| 121 | * |
| 122 | * @param driversCfg hierarchical configuration containing the drivers definitions |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 123 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 124 | * @return driver provider |
| 125 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 126 | public DefaultDriverProvider loadDrivers(HierarchicalConfiguration driversCfg, |
| 127 | DriverResolver resolver) { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 128 | DefaultDriverProvider provider = new DefaultDriverProvider(); |
| 129 | for (HierarchicalConfiguration cfg : driversCfg.configurationsAt(DRIVER)) { |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 130 | DefaultDriver driver = loadDriver(cfg, resolver); |
| 131 | drivers.put(driver.name(), driver); |
| 132 | provider.addDriver(driver); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 133 | } |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 134 | drivers.clear(); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 135 | return provider; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Loads a driver from the supplied hierarchical configuration. |
| 140 | * |
| 141 | * @param driverCfg hierarchical configuration containing the driver definition |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 142 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 143 | * @return driver |
| 144 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 145 | public DefaultDriver loadDriver(HierarchicalConfiguration driverCfg, |
| 146 | DriverResolver resolver) { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 147 | String name = driverCfg.getString(NAME); |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 148 | String parentsString = driverCfg.getString(EXTENDS, ""); |
| 149 | List<Driver> parents = Lists.newArrayList(); |
| 150 | if (!parentsString.equals("")) { |
| 151 | List<String> parentsNames; |
| 152 | if (parentsString.contains(",")) { |
| 153 | parentsNames = Arrays.asList(parentsString.replace(" ", "").split(",")); |
| 154 | } else { |
| 155 | parentsNames = Lists.newArrayList(parentsString); |
| 156 | } |
| 157 | parents = parentsNames.stream().map(parent -> (parent != null) ? |
| 158 | resolve(parent, resolver) : null).collect(Collectors.toList()); |
| 159 | } |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 160 | String manufacturer = driverCfg.getString(MFG, ""); |
| 161 | String hwVersion = driverCfg.getString(HW, ""); |
| 162 | String swVersion = driverCfg.getString(SW, ""); |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 163 | return new DefaultDriver(name, parents, manufacturer, hwVersion, swVersion, |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 164 | parseBehaviours(driverCfg), |
| 165 | parseProperties(driverCfg)); |
| 166 | } |
| 167 | |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 168 | // Resolves the driver by name locally at first and then using the specified resolver. |
| 169 | private Driver resolve(String parentName, DriverResolver resolver) { |
| 170 | Driver driver = drivers.get(parentName); |
| 171 | return driver != null ? driver : |
| 172 | (resolver != null ? resolver.getDriver(parentName) : null); |
| 173 | } |
| 174 | |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 175 | // Parses the behaviours section. |
| 176 | private Map<Class<? extends Behaviour>, Class<? extends Behaviour>> |
| 177 | parseBehaviours(HierarchicalConfiguration driverCfg) { |
| 178 | ImmutableMap.Builder<Class<? extends Behaviour>, |
| 179 | Class<? extends Behaviour>> behaviours = ImmutableMap.builder(); |
| 180 | for (HierarchicalConfiguration b : driverCfg.configurationsAt(BEHAVIOUR)) { |
| 181 | behaviours.put(getClass(b.getString(API)), getClass(b.getString(IMPL))); |
| 182 | } |
| 183 | return behaviours.build(); |
| 184 | } |
| 185 | |
| 186 | // Parses the properties section. |
| 187 | private Map<String, String> parseProperties(HierarchicalConfiguration driverCfg) { |
| 188 | ImmutableMap.Builder<String, String> properties = ImmutableMap.builder(); |
| 189 | for (HierarchicalConfiguration b : driverCfg.configurationsAt(PROPERTY)) { |
| 190 | properties.put(b.getString(NAME), (String) b.getRootNode().getValue()); |
| 191 | } |
| 192 | return properties.build(); |
| 193 | } |
| 194 | |
| 195 | @SuppressWarnings("unchecked") |
| 196 | private Class<? extends Behaviour> getClass(String className) { |
| 197 | try { |
| 198 | return (Class<? extends Behaviour>) classLoader.loadClass(className); |
| 199 | } catch (ClassNotFoundException e) { |
Thomas Vachuska | e7ea688 | 2016-07-22 10:22:46 -0700 | [diff] [blame] | 200 | if (resolver != null) { |
| 201 | Class<? extends Behaviour> cls = resolver.getBehaviourClass(className); |
| 202 | if (cls != null) { |
| 203 | return cls; |
| 204 | } |
| 205 | } |
| 206 | throw new IllegalArgumentException("Unable to resolve class " + className, e); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 207 | } |
| 208 | } |
| 209 | |
| 210 | } |