Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [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.cfg.impl; |
| 17 | |
| 18 | import com.google.common.collect.ImmutableSet; |
| 19 | import com.google.common.collect.Maps; |
| 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
| 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 25 | import org.apache.felix.scr.annotations.Service; |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 26 | import org.onlab.util.AbstractAccumulator; |
| 27 | import org.onlab.util.Accumulator; |
| 28 | import org.onlab.util.SharedExecutors; |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 29 | import org.onosproject.cfg.ComponentConfigEvent; |
| 30 | import org.onosproject.cfg.ComponentConfigService; |
| 31 | import org.onosproject.cfg.ComponentConfigStore; |
| 32 | import org.onosproject.cfg.ComponentConfigStoreDelegate; |
| 33 | import org.onosproject.cfg.ConfigProperty; |
| 34 | import org.osgi.service.cm.Configuration; |
| 35 | import org.osgi.service.cm.ConfigurationAdmin; |
| 36 | import org.slf4j.Logger; |
| 37 | |
| 38 | import java.io.IOException; |
| 39 | import java.io.InputStream; |
| 40 | import java.util.Dictionary; |
| 41 | import java.util.Enumeration; |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 42 | import java.util.HashSet; |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 43 | import java.util.Hashtable; |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 44 | import java.util.List; |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 45 | import java.util.Map; |
| 46 | import java.util.Set; |
| 47 | |
| 48 | import static com.google.common.base.Preconditions.checkArgument; |
| 49 | import static com.google.common.base.Preconditions.checkNotNull; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 50 | import static org.onosproject.security.AppGuard.checkPermission; |
Thomas Vachuska | 92af89f | 2015-06-22 15:16:23 -0700 | [diff] [blame] | 51 | import static org.slf4j.LoggerFactory.getLogger; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 52 | import static org.onosproject.security.AppPermission.Type.*; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 53 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 54 | |
| 55 | /** |
| 56 | * Implementation of the centralized component configuration service. |
| 57 | */ |
| 58 | @Component(immediate = true) |
| 59 | @Service |
| 60 | public class ComponentConfigManager implements ComponentConfigService { |
| 61 | |
| 62 | private static final String COMPONENT_NULL = "Component name cannot be null"; |
| 63 | private static final String PROPERTY_NULL = "Property name cannot be null"; |
Brian O'Connor | 57e83e8 | 2015-09-22 15:45:37 -0700 | [diff] [blame] | 64 | private static final String COMPONENT_MISSING = "Component %s is not registered"; |
| 65 | private static final String PROPERTY_MISSING = "Property %s does not exist for %s"; |
| 66 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 67 | |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 68 | //Symbolic constants for use with the accumulator |
| 69 | private static final int MAX_ITEMS = 100; |
| 70 | private static final int MAX_BATCH_MILLIS = 1000; |
| 71 | private static final int MAX_IDLE_MILLIS = 250; |
| 72 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 73 | private static final String RESOURCE_EXT = ".cfgdef"; |
| 74 | |
| 75 | private final Logger log = getLogger(getClass()); |
| 76 | |
| 77 | private final ComponentConfigStoreDelegate delegate = new InternalStoreDelegate(); |
Thomas Vachuska | 92af89f | 2015-06-22 15:16:23 -0700 | [diff] [blame] | 78 | private final InternalAccumulator accumulator = new InternalAccumulator(); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 79 | |
| 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 81 | protected ComponentConfigStore store; |
| 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 84 | protected ConfigurationAdmin cfgAdmin; |
| 85 | |
| 86 | // Locally maintained catalog of definitions. |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 87 | private final Map<String, Map<String, ConfigProperty>> properties = |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 88 | Maps.newConcurrentMap(); |
| 89 | |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 90 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 91 | @Activate |
| 92 | public void activate() { |
| 93 | store.setDelegate(delegate); |
| 94 | log.info("Started"); |
| 95 | } |
| 96 | |
| 97 | @Deactivate |
| 98 | public void deactivate() { |
| 99 | store.unsetDelegate(delegate); |
| 100 | log.info("Stopped"); |
| 101 | } |
| 102 | |
| 103 | @Override |
| 104 | public Set<String> getComponentNames() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 105 | checkPermission(CONFIG_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 106 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 107 | return ImmutableSet.copyOf(properties.keySet()); |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public void registerProperties(Class<?> componentClass) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 112 | checkPermission(CONFIG_WRITE); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 113 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 114 | String componentName = componentClass.getName(); |
| 115 | String resourceName = componentClass.getSimpleName() + RESOURCE_EXT; |
| 116 | try (InputStream ris = componentClass.getResourceAsStream(resourceName)) { |
| 117 | checkArgument(ris != null, "Property definitions not found at resource %s", |
| 118 | resourceName); |
| 119 | |
| 120 | // Read the definitions |
| 121 | Set<ConfigProperty> defs = ConfigPropertyDefinitions.read(ris); |
| 122 | |
| 123 | // Produce a new map of the properties and register it. |
| 124 | Map<String, ConfigProperty> map = Maps.newConcurrentMap(); |
| 125 | defs.forEach(p -> map.put(p.name(), p)); |
| 126 | |
| 127 | properties.put(componentName, map); |
| 128 | loadExistingValues(componentName); |
| 129 | } catch (IOException e) { |
| 130 | log.error("Unable to read property definitions from resource " + resourceName, e); |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | @Override |
| 135 | public void unregisterProperties(Class<?> componentClass, boolean clear) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 136 | checkPermission(CONFIG_WRITE); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 137 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 138 | String componentName = componentClass.getName(); |
| 139 | checkNotNull(componentName, COMPONENT_NULL); |
| 140 | Map<String, ConfigProperty> cps = properties.remove(componentName); |
Thomas Vachuska | fc52fec | 2015-05-18 19:13:56 -0700 | [diff] [blame] | 141 | if (clear && cps != null) { |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 142 | cps.keySet().forEach(name -> store.unsetProperty(componentName, name)); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 143 | clearExistingValues(componentName); |
| 144 | } |
| 145 | } |
| 146 | |
| 147 | // Clears any existing values that may have been set. |
| 148 | private void clearExistingValues(String componentName) { |
| 149 | triggerUpdate(componentName); |
| 150 | } |
| 151 | |
| 152 | @Override |
| 153 | public Set<ConfigProperty> getProperties(String componentName) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 154 | checkPermission(CONFIG_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 155 | |
Brian O'Connor | 85c2926 | 2015-03-10 20:53:43 -0700 | [diff] [blame] | 156 | Map<String, ConfigProperty> map = properties.get(componentName); |
| 157 | return map != null ? ImmutableSet.copyOf(map.values()) : null; |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | @Override |
| 161 | public void setProperty(String componentName, String name, String value) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 162 | checkPermission(CONFIG_WRITE); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 163 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 164 | checkNotNull(componentName, COMPONENT_NULL); |
| 165 | checkNotNull(name, PROPERTY_NULL); |
Brian O'Connor | 57e83e8 | 2015-09-22 15:45:37 -0700 | [diff] [blame] | 166 | |
| 167 | checkArgument(properties.containsKey(componentName), |
| 168 | COMPONENT_MISSING, componentName); |
| 169 | checkArgument(properties.get(componentName).containsKey(name), |
| 170 | PROPERTY_MISSING, name, componentName); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 171 | store.setProperty(componentName, name, value); |
| 172 | } |
| 173 | |
| 174 | @Override |
andrea | dd106a6 | 2015-10-02 13:39:48 -0700 | [diff] [blame] | 175 | public void preSetProperty(String componentName, String name, String value) { |
| 176 | |
| 177 | checkPermission(CONFIG_WRITE); |
| 178 | |
| 179 | checkNotNull(componentName, COMPONENT_NULL); |
| 180 | checkNotNull(name, PROPERTY_NULL); |
| 181 | |
| 182 | store.setProperty(componentName, name, value); |
| 183 | } |
| 184 | |
| 185 | @Override |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 186 | public void unsetProperty(String componentName, String name) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 187 | checkPermission(CONFIG_WRITE); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 188 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 189 | checkNotNull(componentName, COMPONENT_NULL); |
| 190 | checkNotNull(name, PROPERTY_NULL); |
Brian O'Connor | 57e83e8 | 2015-09-22 15:45:37 -0700 | [diff] [blame] | 191 | |
| 192 | checkArgument(properties.containsKey(componentName), |
| 193 | COMPONENT_MISSING, componentName); |
| 194 | checkArgument(properties.get(componentName).containsKey(name), |
| 195 | PROPERTY_MISSING, name, componentName); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 196 | store.unsetProperty(componentName, name); |
| 197 | } |
| 198 | |
| 199 | private class InternalStoreDelegate implements ComponentConfigStoreDelegate { |
| 200 | |
| 201 | @Override |
| 202 | public void notify(ComponentConfigEvent event) { |
| 203 | String componentName = event.subject(); |
| 204 | String name = event.name(); |
| 205 | String value = event.value(); |
| 206 | |
| 207 | switch (event.type()) { |
| 208 | case PROPERTY_SET: |
| 209 | set(componentName, name, value); |
| 210 | break; |
| 211 | case PROPERTY_UNSET: |
| 212 | reset(componentName, name); |
| 213 | break; |
| 214 | default: |
| 215 | break; |
| 216 | } |
| 217 | } |
| 218 | } |
| 219 | |
Thomas Vachuska | 92af89f | 2015-06-22 15:16:23 -0700 | [diff] [blame] | 220 | // Buffers multiple subsequent configuration updates into one notification. |
| 221 | private class InternalAccumulator extends AbstractAccumulator<String> |
| 222 | implements Accumulator<String> { |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 223 | |
Thomas Vachuska | 92af89f | 2015-06-22 15:16:23 -0700 | [diff] [blame] | 224 | protected InternalAccumulator() { |
| 225 | super(SharedExecutors.getTimer(), MAX_ITEMS, MAX_BATCH_MILLIS, MAX_IDLE_MILLIS); |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | @Override |
Thomas Vachuska | 92af89f | 2015-06-22 15:16:23 -0700 | [diff] [blame] | 229 | public void processItems(List<String> items) { |
| 230 | // Conversion to set removes duplicates |
| 231 | Set<String> componentSet = new HashSet<>(items); |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 232 | componentSet.forEach(ComponentConfigManager.this::triggerUpdate); |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 233 | } |
| 234 | } |
| 235 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 236 | // Locates the property in the component map and replaces it with an |
| 237 | // updated copy. |
| 238 | private void set(String componentName, String name, String value) { |
| 239 | Map<String, ConfigProperty> map = properties.get(componentName); |
| 240 | if (map != null) { |
| 241 | ConfigProperty prop = map.get(name); |
| 242 | if (prop != null) { |
| 243 | map.put(name, ConfigProperty.setProperty(prop, value)); |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 244 | accumulator.add(componentName); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 245 | return; |
| 246 | } |
| 247 | } |
Naoki Shiota | 6bc04be | 2016-01-08 12:02:38 -0800 | [diff] [blame] | 248 | |
| 249 | // If definition doesn't exist in local catalog, cache the property. |
| 250 | preSet(componentName, name, value); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | // Locates the property in the component map and replaces it with an |
| 254 | // reset copy. |
| 255 | private void reset(String componentName, String name) { |
| 256 | Map<String, ConfigProperty> map = properties.get(componentName); |
| 257 | if (map != null) { |
| 258 | ConfigProperty prop = map.get(name); |
| 259 | if (prop != null) { |
| 260 | map.put(name, ConfigProperty.resetProperty(prop)); |
Aaron Kruglikov | 6685521 | 2015-06-22 12:29:02 -0700 | [diff] [blame] | 261 | accumulator.add(componentName); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 262 | return; |
| 263 | } |
Thomas Vachuska | db320ab | 2015-04-22 09:03:33 -0700 | [diff] [blame] | 264 | log.warn("Unable to reset non-existent property {} for component {}", |
| 265 | name, componentName); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 266 | } |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 267 | } |
| 268 | |
Naoki Shiota | 6bc04be | 2016-01-08 12:02:38 -0800 | [diff] [blame] | 269 | // Stores non-existent property so that loadExistingValues() can load in future. |
| 270 | private void preSet(String componentName, String name, String value) { |
| 271 | try { |
Naoki Shiota | 4ce97ff | 2016-01-14 18:45:22 -0800 | [diff] [blame] | 272 | Configuration config = cfgAdmin.getConfiguration(componentName, null); |
Naoki Shiota | 6bc04be | 2016-01-08 12:02:38 -0800 | [diff] [blame] | 273 | Dictionary<String, Object> property = config.getProperties(); |
| 274 | if (property == null) { |
| 275 | property = new Hashtable<>(); |
| 276 | } |
| 277 | property.put(name, value); |
| 278 | config.update(property); |
| 279 | } catch (IOException e) { |
| 280 | log.error("Failed to preset configuration for {}", componentName); |
| 281 | } |
| 282 | } |
| 283 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 284 | // Loads existing property values that may have been set. |
| 285 | private void loadExistingValues(String componentName) { |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 286 | try { |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 287 | Configuration cfg = cfgAdmin.getConfiguration(componentName, null); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 288 | Map<String, ConfigProperty> map = properties.get(componentName); |
| 289 | Dictionary<String, Object> props = cfg.getProperties(); |
| 290 | if (props != null) { |
| 291 | Enumeration<String> it = props.keys(); |
| 292 | while (it.hasMoreElements()) { |
| 293 | String name = it.nextElement(); |
| 294 | ConfigProperty p = map.get(name); |
| 295 | if (p != null) { |
| 296 | map.put(name, ConfigProperty.setProperty(p, (String) props.get(name))); |
| 297 | } |
| 298 | } |
| 299 | } |
| 300 | } catch (IOException e) { |
| 301 | log.error("Unable to get configuration for " + componentName, e); |
| 302 | } |
| 303 | |
| 304 | } |
| 305 | |
| 306 | // FIXME: This should be a slightly deferred execution to allow changing |
| 307 | // values just once per component when a number of updates arrive shortly |
| 308 | // after each other. |
| 309 | private void triggerUpdate(String componentName) { |
| 310 | try { |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 311 | Configuration cfg = cfgAdmin.getConfiguration(componentName, null); |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 312 | Map<String, ConfigProperty> map = properties.get(componentName); |
| 313 | Dictionary<String, Object> props = new Hashtable<>(); |
| 314 | map.values().forEach(p -> props.put(p.name(), p.value())); |
| 315 | cfg.update(props); |
| 316 | } catch (IOException e) { |
| 317 | log.warn("Unable to update configuration for " + componentName, e); |
| 318 | } |
| 319 | } |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 320 | } |