opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/mapping/config/Config.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.netconf.confignetconfconnector.mapping.config;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.HashMultimap;
  14 import com.google.common.collect.Lists;
  15 import com.google.common.collect.Maps;
  16 import com.google.common.collect.Multimap;
  17 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
  18 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditStrategyType;
  19 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  20 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  21 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24 import org.w3c.dom.Document;
  25 import org.w3c.dom.Element;
  26
  27 import javax.management.ObjectName;
  28 import java.util.Collection;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import java.util.Set;
  35
  36 import static com.google.common.base.Preconditions.checkState;
  37 import static java.lang.String.format;
  38
  39 public class Config {
  40     private final Logger logger = LoggerFactory.getLogger(Config.class);
  41
  42     private final Map<String/* Namespace from yang file */,
  43             Map<String /* Name of module entry from yang file */, ModuleConfig>> moduleConfigs;
  44     private final Map<String, ModuleConfig> moduleNamesToConfigs;
  45
  46     public Config(Map<String, Map<String, ModuleConfig>> moduleConfigs) {
  47         this.moduleConfigs = moduleConfigs;
  48         Map<String, ModuleConfig> moduleNamesToConfigs = new HashMap<>();
  49         for (Entry<String, Map<String, ModuleConfig>> entry : moduleConfigs.entrySet()) {
  50             moduleNamesToConfigs.putAll(entry.getValue());
  51         }
  52         this.moduleNamesToConfigs = Collections.unmodifiableMap(moduleNamesToConfigs);
  53     }
  54
  55     private Map<String, Map<String, Collection<ObjectName>>> getMappedInstances(Set<ObjectName> instancesToMap,
  56             Services serviceTracker) {
  57         Multimap<String, ObjectName> moduleToInstances = mapInstancesToModules(instancesToMap);
  58
  59         Map<String, Map<String, Collection<ObjectName>>> retVal = Maps.newLinkedHashMap();
  60
  61         for (String namespace : moduleConfigs.keySet()) {
  62
  63             Map<String, Collection<ObjectName>> innerRetVal = Maps.newHashMap();
  64
  65             for (Entry<String, ModuleConfig> mbeEntry : moduleConfigs.get(namespace).entrySet()) {
  66
  67                 String moduleName = mbeEntry.getKey();
  68                 Collection<ObjectName> instances = moduleToInstances.get(moduleName);
  69
  70                 if (instances == null)
  71                     continue;
  72
  73                 innerRetVal.put(moduleName, instances);
  74
  75                 // All found instances add to service tracker in advance
  76                 // This way all instances will be serialized as all available
  77                 // services when get-config is triggered
  78                 // (even if they are not used as services by other instances)
  79                 // = more user friendly
  80                 addServices(serviceTracker, instances, mbeEntry.getValue().getProvidedServices());
  81
  82             }
  83
  84             retVal.put(namespace, innerRetVal);
  85         }
  86         return retVal;
  87     }
  88
  89     private void addServices(Services serviceTracker, Collection<ObjectName> instances,
  90             Collection<String> providedServices) {
  91         for (ObjectName instanceOn : instances) {
  92             for (String serviceName : providedServices) {
  93                 serviceTracker.addServiceEntry(serviceName, instanceOn);
  94             }
  95         }
  96     }
  97
  98     private static Multimap<String, ObjectName> mapInstancesToModules(Set<ObjectName> instancesToMap) {
  99         Multimap<String, ObjectName> retVal = HashMultimap.create();
 100
 101         for (ObjectName objectName : instancesToMap) {
 102             String factoryName = ObjectNameUtil.getFactoryName(objectName);
 103             retVal.put(factoryName, objectName);
 104         }
 105         return retVal;
 106     }
 107
 108     // public Element toXml(Set<ObjectName> instancesToMap, String namespace,
 109     // Document document) {
 110     // return toXml(instancesToMap, Optional.of(namespace), document);
 111     // }
 112
 113     public Element toXml(Set<ObjectName> instancesToMap, Optional<String> maybeNamespace, Document document,
 114             Element dataElement) {
 115         Services serviceTracker = new Services();
 116
 117         Map<String, Map<String, Collection<ObjectName>>> moduleToInstances = getMappedInstances(instancesToMap,
 118                 serviceTracker);
 119
 120         Element root = dataElement;
 121         if (maybeNamespace.isPresent()) {
 122             XmlUtil.addNamespaceAttr(root, maybeNamespace.get());
 123         }
 124
 125         Element modulesElement = document.createElement(XmlNetconfConstants.MODULES_KEY);
 126         XmlUtil.addNamespaceAttr(modulesElement,
 127                 XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
 128         root.appendChild(modulesElement);
 129         for (String moduleNamespace : moduleToInstances.keySet()) {
 130             for (Entry<String, Collection<ObjectName>> moduleMappingEntry : moduleToInstances.get(moduleNamespace)
 131                     .entrySet()) {
 132
 133                 ModuleConfig mapping = moduleConfigs.get(moduleNamespace).get(moduleMappingEntry.getKey());
 134
 135                 if (moduleMappingEntry.getValue().isEmpty()) {
 136                     addEmptyModulesCommented(document, modulesElement, moduleNamespace, moduleMappingEntry);
 137                 } else {
 138                     for (ObjectName objectName : moduleMappingEntry.getValue()) {
 139                         modulesElement
 140                                 .appendChild(mapping.toXml(objectName, serviceTracker, document, moduleNamespace));
 141                     }
 142                 }
 143
 144             }
 145         }
 146
 147         root.appendChild(serviceTracker.toXml(serviceTracker.getMappedServices(), document));
 148
 149         return root;
 150     }
 151
 152     private void addEmptyModulesCommented(Document document, Element root, String moduleNamespace,
 153             Entry<String, Collection<ObjectName>> moduleMappingEntry) {
 154         Element emptyModule = document.createElement(XmlNetconfConstants.MODULE_KEY);
 155
 156         Element typeElement = XmlUtil.createTextElement(document, XmlNetconfConstants.TYPE_KEY,
 157                 moduleMappingEntry.getKey());
 158         emptyModule.appendChild(typeElement);
 159
 160         root.appendChild(document.createComment(XmlUtil.toString(emptyModule, false)));
 161     }
 162
 163     // TODO refactor, replace string representing namespace with namespace class
 164     // TODO refactor, replace Map->Multimap with e.g. ConfigElementResolved
 165     // class
 166     public Map<String, Multimap<String, ModuleElementResolved>> fromXml(XmlElement xml, Set<ObjectName> instancesForFillingServiceRefMapping,
 167                                                                         EditStrategyType defaultEditStrategyType) {
 168         Map<String, Multimap<String, ModuleElementResolved>> retVal = Maps.newHashMap();
 169
 170         List<XmlElement> recognisedChildren = Lists.newArrayList();
 171
 172         Services serviceTracker = fromXmlServices(xml, recognisedChildren, instancesForFillingServiceRefMapping);
 173         List<XmlElement> moduleElements = fromXmlModules(xml, recognisedChildren);
 174
 175         xml.checkUnrecognisedElements(recognisedChildren);
 176
 177         for (XmlElement moduleElement : moduleElements) {
 178             resolveModule(retVal, serviceTracker, moduleElement, defaultEditStrategyType);
 179         }
 180
 181         return retVal;
 182     }
 183
 184     private List<XmlElement> fromXmlModules(XmlElement xml, List<XmlElement> recognisedChildren) {
 185         Optional<XmlElement> modulesElement = xml.getOnlyChildElementOptionally(XmlNetconfConstants.MODULES_KEY,
 186                 XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
 187         List<XmlElement> moduleElements;
 188         if (modulesElement.isPresent()) {
 189             moduleElements = modulesElement.get().getChildElementsWithSameNamespace(XmlNetconfConstants.MODULE_KEY);
 190             recognisedChildren.add(modulesElement.get());
 191             modulesElement.get().checkUnrecognisedElements(moduleElements);
 192         } else {
 193             moduleElements = Lists.newArrayList();
 194         }
 195         return moduleElements;
 196     }
 197
 198     private void resolveModule(Map<String, Multimap<String, ModuleElementResolved>> retVal, Services serviceTracker,
 199             XmlElement moduleElement, EditStrategyType defaultStrategy) {
 200         XmlElement typeElement = moduleElement.getOnlyChildElementWithSameNamespace(XmlNetconfConstants.TYPE_KEY);
 201         Entry<String, String> prefixToNamespace = typeElement.findNamespaceOfTextContent();
 202         String moduleNamespace = prefixToNamespace.getValue();
 203         XmlElement nameElement = moduleElement.getOnlyChildElementWithSameNamespace(XmlNetconfConstants.NAME_KEY);
 204         String instanceName = nameElement.getTextContent();
 205         String factoryNameWithPrefix = typeElement.getTextContent();
 206         String prefixOrEmptyString = prefixToNamespace.getKey();
 207         String factoryName = getFactoryName(factoryNameWithPrefix, prefixOrEmptyString);
 208
 209         ModuleConfig moduleMapping = getModuleMapping(moduleNamespace, instanceName, factoryName);
 210
 211         Multimap<String, ModuleElementResolved> innerMap = retVal.get(moduleNamespace);
 212         if (innerMap == null) {
 213             innerMap = HashMultimap.create();
 214             retVal.put(moduleNamespace, innerMap);
 215         }
 216
 217         ModuleElementResolved moduleElementResolved = moduleMapping.fromXml(moduleElement, serviceTracker,
 218                 instanceName, moduleNamespace, defaultStrategy);
 219
 220         innerMap.put(factoryName, moduleElementResolved);
 221     }
 222
 223     private Services fromXmlServices(XmlElement xml, List<XmlElement> recognisedChildren, Set<ObjectName> instancesForFillingServiceRefMapping) {
 224         Optional<XmlElement> servicesElement = xml.getOnlyChildElementOptionally(XmlNetconfConstants.SERVICES_KEY,
 225                 XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
 226
 227         Map<String, Map<String, String>> mappedServices;
 228         if (servicesElement.isPresent()) {
 229             mappedServices = Services.fromXml(servicesElement.get());
 230             recognisedChildren.add(servicesElement.get());
 231         } else {
 232             mappedServices = new HashMap<>();
 233         }
 234         Services services = Services.resolveServices(mappedServices);
 235         // merge with what candidate db contains by default - ref_
 236
 237         for(ObjectName existingON: instancesForFillingServiceRefMapping) {
 238             logger.trace("Filling services from {}", existingON);
 239             // get all its services
 240             String factoryName = ObjectNameUtil.getFactoryName(existingON);
 241             ModuleConfig moduleConfig = moduleNamesToConfigs.get(factoryName);
 242
 243             checkState(moduleConfig != null, "Cannot find ModuleConfig with name " + factoryName + " in " + moduleNamesToConfigs);
 244             // Set<String> services = ;
 245             for (String serviceName : moduleConfig.getProvidedServices()) {
 246                 services.addServiceEntry(serviceName, existingON);
 247             }
 248         }
 249
 250         return services;
 251     }
 252
 253     private String getFactoryName(String factoryNameWithPrefix, String prefixOrEmptyString) {
 254         checkState(
 255                 factoryNameWithPrefix.startsWith(prefixOrEmptyString),
 256                 format("Internal error: text " + "content '%s' of type node does not start with prefix '%s'",
 257                         factoryNameWithPrefix, prefixOrEmptyString));
 258
 259         int factoryNameAfterPrefixIndex;
 260         if (prefixOrEmptyString.isEmpty()) {
 261             factoryNameAfterPrefixIndex = 0;
 262         } else {
 263             factoryNameAfterPrefixIndex = prefixOrEmptyString.length() + 1;
 264         }
 265         return factoryNameWithPrefix.substring(factoryNameAfterPrefixIndex);
 266     }
 267
 268     private ModuleConfig getModuleMapping(String moduleNamespace, String instanceName, String factoryName) {
 269         Map<String, ModuleConfig> mappingsFromNamespace = moduleConfigs.get(moduleNamespace);
 270
 271         Preconditions.checkNotNull(mappingsFromNamespace,
 272                 "Namespace %s, defined in: module %s of type %s not found, available namespaces: %s", moduleNamespace,
 273                 instanceName, factoryName, moduleConfigs.keySet());
 274
 275         ModuleConfig moduleMapping = mappingsFromNamespace.get(factoryName);
 276         checkState(moduleMapping != null, "Cannot find mapping for module type " + factoryName);
 277         return moduleMapping;
 278     }
 279
 280 }