Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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; |
| 67 | |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 68 | private Map<String, Driver> drivers = Maps.newHashMap(); |
| 69 | |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 70 | /** |
| 71 | * Creates a new driver loader capable of loading drivers from the supplied |
| 72 | * class loader. |
| 73 | * |
| 74 | * @param classLoader class loader to use |
| 75 | */ |
| 76 | public XmlDriverLoader(ClassLoader classLoader) { |
| 77 | this.classLoader = classLoader; |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Loads the specified drivers resource as an XML stream and parses it to |
| 82 | * produce a ready-to-register driver provider. |
| 83 | * |
| 84 | * @param driversStream stream containing the drivers definitions |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 85 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 86 | * @return driver provider |
| 87 | * @throws java.io.IOException if issues are encountered reading the stream |
| 88 | * or parsing the driver definitions within |
| 89 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 90 | public DefaultDriverProvider loadDrivers(InputStream driversStream, |
| 91 | DriverResolver resolver) throws IOException { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 92 | try { |
| 93 | XMLConfiguration cfg = new XMLConfiguration(); |
| 94 | cfg.setRootElementName(DRIVERS); |
| 95 | cfg.setAttributeSplittingDisabled(true); |
| 96 | |
| 97 | cfg.load(driversStream); |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 98 | return loadDrivers(cfg, resolver); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 99 | } catch (ConfigurationException e) { |
| 100 | throw new IOException("Unable to load drivers", e); |
| 101 | } |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Loads a driver provider from the supplied hierarchical configuration. |
| 106 | * |
| 107 | * @param driversCfg hierarchical configuration containing the drivers definitions |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 108 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 109 | * @return driver provider |
| 110 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 111 | public DefaultDriverProvider loadDrivers(HierarchicalConfiguration driversCfg, |
| 112 | DriverResolver resolver) { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 113 | DefaultDriverProvider provider = new DefaultDriverProvider(); |
| 114 | for (HierarchicalConfiguration cfg : driversCfg.configurationsAt(DRIVER)) { |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 115 | DefaultDriver driver = loadDriver(cfg, resolver); |
| 116 | drivers.put(driver.name(), driver); |
| 117 | provider.addDriver(driver); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 118 | } |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 119 | drivers.clear(); |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 120 | return provider; |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Loads a driver from the supplied hierarchical configuration. |
| 125 | * |
| 126 | * @param driverCfg hierarchical configuration containing the driver definition |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 127 | * @param resolver driver resolver |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 128 | * @return driver |
| 129 | */ |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 130 | public DefaultDriver loadDriver(HierarchicalConfiguration driverCfg, |
| 131 | DriverResolver resolver) { |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 132 | String name = driverCfg.getString(NAME); |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 133 | String parentsString = driverCfg.getString(EXTENDS, ""); |
| 134 | List<Driver> parents = Lists.newArrayList(); |
| 135 | if (!parentsString.equals("")) { |
| 136 | List<String> parentsNames; |
| 137 | if (parentsString.contains(",")) { |
| 138 | parentsNames = Arrays.asList(parentsString.replace(" ", "").split(",")); |
| 139 | } else { |
| 140 | parentsNames = Lists.newArrayList(parentsString); |
| 141 | } |
| 142 | parents = parentsNames.stream().map(parent -> (parent != null) ? |
| 143 | resolve(parent, resolver) : null).collect(Collectors.toList()); |
| 144 | } |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 145 | String manufacturer = driverCfg.getString(MFG, ""); |
| 146 | String hwVersion = driverCfg.getString(HW, ""); |
| 147 | String swVersion = driverCfg.getString(SW, ""); |
Andrea Campanella | 80520b8 | 2016-01-05 17:55:29 -0800 | [diff] [blame] | 148 | return new DefaultDriver(name, parents, manufacturer, hwVersion, swVersion, |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 149 | parseBehaviours(driverCfg), |
| 150 | parseProperties(driverCfg)); |
| 151 | } |
| 152 | |
Thomas Vachuska | 635c2d7 | 2015-05-08 14:32:13 -0700 | [diff] [blame] | 153 | // Resolves the driver by name locally at first and then using the specified resolver. |
| 154 | private Driver resolve(String parentName, DriverResolver resolver) { |
| 155 | Driver driver = drivers.get(parentName); |
| 156 | return driver != null ? driver : |
| 157 | (resolver != null ? resolver.getDriver(parentName) : null); |
| 158 | } |
| 159 | |
Thomas Vachuska | a8f4e7d | 2015-01-08 17:31:55 -0800 | [diff] [blame] | 160 | // Parses the behaviours section. |
| 161 | private Map<Class<? extends Behaviour>, Class<? extends Behaviour>> |
| 162 | parseBehaviours(HierarchicalConfiguration driverCfg) { |
| 163 | ImmutableMap.Builder<Class<? extends Behaviour>, |
| 164 | Class<? extends Behaviour>> behaviours = ImmutableMap.builder(); |
| 165 | for (HierarchicalConfiguration b : driverCfg.configurationsAt(BEHAVIOUR)) { |
| 166 | behaviours.put(getClass(b.getString(API)), getClass(b.getString(IMPL))); |
| 167 | } |
| 168 | return behaviours.build(); |
| 169 | } |
| 170 | |
| 171 | // Parses the properties section. |
| 172 | private Map<String, String> parseProperties(HierarchicalConfiguration driverCfg) { |
| 173 | ImmutableMap.Builder<String, String> properties = ImmutableMap.builder(); |
| 174 | for (HierarchicalConfiguration b : driverCfg.configurationsAt(PROPERTY)) { |
| 175 | properties.put(b.getString(NAME), (String) b.getRootNode().getValue()); |
| 176 | } |
| 177 | return properties.build(); |
| 178 | } |
| 179 | |
| 180 | @SuppressWarnings("unchecked") |
| 181 | private Class<? extends Behaviour> getClass(String className) { |
| 182 | try { |
| 183 | return (Class<? extends Behaviour>) classLoader.loadClass(className); |
| 184 | } catch (ClassNotFoundException e) { |
| 185 | throw new IllegalArgumentException("Unable to load class " + className, e); |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | } |