+++ /dev/null
-/*
- * Copyright (c) 2015, 2017 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-
-package org.opendaylight.controller.config.facade.xml.mapping.config;
-
-import static com.google.common.base.Preconditions.checkState;
-
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.collect.HashMultimap;
-import com.google.common.collect.Lists;
-import com.google.common.collect.Maps;
-import com.google.common.collect.Multimap;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Set;
-import javax.management.ObjectName;
-import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
-import org.opendaylight.controller.config.facade.xml.mapping.IdentityMapping;
-import org.opendaylight.controller.config.facade.xml.osgi.EnumResolver;
-import org.opendaylight.controller.config.facade.xml.strategy.EditStrategyType;
-import org.opendaylight.controller.config.util.xml.DocumentedException;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.config.util.xml.XmlMappingConstants;
-import org.opendaylight.controller.config.util.xml.XmlUtil;
-import org.opendaylight.yangtools.yang.common.Revision;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-
-public class Config {
-
- private final Map<String/* Namespace from yang file */,
- Map<String /* Name of module entry from yang file */,
- ModuleConfig>> moduleConfigs;
-
- private final Map<String, Map<Optional<Revision>, IdentityMapping>> identityMap;
-
- private final EnumResolver enumResolver;
-
- public Config(final Map<String, Map<String, ModuleConfig>> moduleConfigs, final EnumResolver enumResolver) {
- this(moduleConfigs, Collections.<String, Map<Optional<Revision>, IdentityMapping>>emptyMap(), enumResolver);
- }
-
- public Config(final Map<String, Map<String, ModuleConfig>> moduleConfigs,
- final Map<String, Map<Optional<Revision>, IdentityMapping>> identityMap, final EnumResolver enumResolver) {
- this.moduleConfigs = moduleConfigs;
- this.identityMap = identityMap;
- this.enumResolver = enumResolver;
- }
-
- public static Map<String, Map<String, Collection<ObjectName>>> getMappedInstances(
- final Set<ObjectName> instancesToMap, final Map<String, Map<String, ModuleConfig>> configs) {
- Multimap<String, ObjectName> moduleToInstances = mapInstancesToModules(instancesToMap);
-
- Map<String, Map<String, Collection<ObjectName>>> retVal = Maps.newLinkedHashMap();
-
- for (Entry<String, Map<String, ModuleConfig>> namespaceToModuleToConfigEntry : configs.entrySet()) {
-
- Map<String, Collection<ObjectName>> innerRetVal = Maps.newHashMap();
-
- for (Entry<String, ModuleConfig> mbeEntry : namespaceToModuleToConfigEntry.getValue().entrySet()) {
-
- String moduleName = mbeEntry.getKey();
- Collection<ObjectName> instances = moduleToInstances.get(moduleName);
-
- // TODO, this code does not support same module names from different namespaces
- // Namespace should be present in ObjectName
-
- if (instances == null) {
- continue;
- }
-
- innerRetVal.put(moduleName, instances);
-
- }
- retVal.put(namespaceToModuleToConfigEntry.getKey(), innerRetVal);
- }
- return retVal;
- }
-
- private static Multimap<String, ObjectName> mapInstancesToModules(final Set<ObjectName> instancesToMap) {
- Multimap<String, ObjectName> retVal = HashMultimap.create();
-
- for (ObjectName objectName : instancesToMap) {
- String factoryName = ObjectNameUtil.getFactoryName(objectName);
- retVal.put(factoryName, objectName);
- }
- return retVal;
- }
-
- public Element toXml(final Set<ObjectName> instancesToMap, final Optional<String> maybeNamespace,
- final Document document, final Element dataElement, final ServiceRegistryWrapper serviceTracker) {
-
- Map<String, Map<String, Collection<ObjectName>>> moduleToInstances = getMappedInstances(instancesToMap,
- moduleConfigs);
-
- if (maybeNamespace.isPresent()) {
- dataElement.setAttributeNS(maybeNamespace.get(), dataElement.getNodeName(), "xmlns");
- }
-
- Element modulesElement = XmlUtil.createElement(document, XmlMappingConstants.MODULES_KEY,
- Optional.of(XmlMappingConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
- dataElement.appendChild(modulesElement);
- for (Entry<String, Map<String, Collection<ObjectName>>> moduleToInstanceEntry : moduleToInstances.entrySet()) {
- for (Entry<String, Collection<ObjectName>> moduleMappingEntry : moduleToInstanceEntry.getValue()
- .entrySet()) {
-
- ModuleConfig mapping = moduleConfigs.get(moduleToInstanceEntry.getKey())
- .get(moduleMappingEntry.getKey());
-
- if (moduleMappingEntry.getValue().isEmpty()) {
- continue;
- }
-
- for (ObjectName objectName : moduleMappingEntry.getValue()) {
- modulesElement.appendChild(
- mapping.toXml(objectName, document, moduleToInstanceEntry.getKey(), enumResolver));
- }
-
- }
- }
-
- dataElement.appendChild(Services.toXml(serviceTracker, document));
-
- return dataElement;
- }
-
- public Element moduleToXml(final String moduleNamespace, final String factoryName, final String instanceName,
- final ObjectName instanceON, final Document document) {
- ModuleConfig moduleConfig = getModuleMapping(moduleNamespace, instanceName, factoryName);
- return moduleConfig.toXml(instanceON, document, moduleNamespace, enumResolver);
- }
-
- // TODO refactor, replace string representing namespace with namespace class
- // TODO refactor, replace Map->Multimap with e.g. ConfigElementResolved
- // class
-
- public Map<String, Multimap<String, ModuleElementResolved>> fromXmlModulesResolved(final XmlElement xml,
- final EditStrategyType defaultEditStrategyType, final ServiceRegistryWrapper serviceTracker)
- throws DocumentedException {
- Optional<XmlElement> modulesElement = getModulesElement(xml);
- List<XmlElement> moduleElements = getModulesElementList(modulesElement);
-
- Map<String, Multimap<String, ModuleElementResolved>> retVal = Maps.newHashMap();
-
- ResolvingStrategy<ModuleElementResolved> resolvingStrategy = (moduleMapping, moduleElement, serviceTracker1,
- instanceName, moduleNamespace, defaultStrategy) -> moduleMapping.fromXml(moduleElement, serviceTracker1,
- instanceName, moduleNamespace, defaultStrategy, identityMap, enumResolver);
-
- for (XmlElement moduleElement : moduleElements) {
- resolveModule(retVal, serviceTracker, moduleElement, defaultEditStrategyType, resolvingStrategy);
- }
-
- return retVal;
- }
-
- /**
- * return a map containing namespace -> moduleName -> instanceName map.
- * Attribute parsing is omitted.
- */
- public Map<String, Multimap<String, ModuleElementDefinition>> fromXmlModulesMap(final XmlElement xml,
- final EditStrategyType defaultEditStrategyType, final ServiceRegistryWrapper serviceTracker)
- throws DocumentedException {
- Optional<XmlElement> modulesElement = getModulesElement(xml);
- List<XmlElement> moduleElements = getModulesElementList(modulesElement);
-
- Map<String, Multimap<String, ModuleElementDefinition>> retVal = Maps.newHashMap();
-
- ResolvingStrategy<ModuleElementDefinition> resolvingStrategy = (moduleMapping, moduleElement, serviceTracker1,
- instanceName, moduleNamespace, defaultStrategy) -> {
- // TODO: add check for conflicts between global and local edit
- // strategy
- String perInstanceEditStrategy = moduleElement.getAttribute(XmlMappingConstants.OPERATION_ATTR_KEY,
- XmlMappingConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
- return new ModuleElementDefinition(instanceName, perInstanceEditStrategy, defaultStrategy);
- };
-
- for (XmlElement moduleElement : moduleElements) {
- resolveModule(retVal, serviceTracker, moduleElement, defaultEditStrategyType, resolvingStrategy);
- }
-
- return retVal;
- }
-
- private static Optional<XmlElement> getModulesElement(final XmlElement xml) {
- return xml.getOnlyChildElementOptionally(XmlMappingConstants.MODULES_KEY,
- XmlMappingConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
- }
-
- private List<XmlElement> getModulesElementList(final Optional<XmlElement> modulesElement)
- throws DocumentedException {
- List<XmlElement> moduleElements;
-
- if (modulesElement.isPresent()) {
- moduleElements = modulesElement.get().getChildElementsWithSameNamespace(XmlMappingConstants.MODULE_KEY);
- modulesElement.get().checkUnrecognisedElements(moduleElements);
- } else {
- moduleElements = Lists.newArrayList();
- }
- return moduleElements;
- }
-
- private <T> void resolveModule(final Map<String, Multimap<String, T>> retVal,
- final ServiceRegistryWrapper serviceTracker, final XmlElement moduleElement,
- final EditStrategyType defaultStrategy, final ResolvingStrategy<T> resolvingStrategy)
- throws DocumentedException {
- XmlElement typeElement = null;
- typeElement = moduleElement.getOnlyChildElementWithSameNamespace(XmlMappingConstants.TYPE_KEY);
- Entry<String, String> prefixToNamespace = typeElement.findNamespaceOfTextContent();
- String moduleNamespace = prefixToNamespace.getValue();
- XmlElement nameElement = null;
- nameElement = moduleElement.getOnlyChildElementWithSameNamespace(XmlMappingConstants.NAME_KEY);
- String instanceName = nameElement.getTextContent();
- String factoryNameWithPrefix = typeElement.getTextContent();
- String prefixOrEmptyString = prefixToNamespace.getKey();
- String factoryName = getFactoryName(factoryNameWithPrefix, prefixOrEmptyString);
-
- ModuleConfig moduleMapping = getModuleMapping(moduleNamespace, instanceName, factoryName);
-
- Multimap<String, T> innerMap = retVal.computeIfAbsent(moduleNamespace, k -> HashMultimap.create());
-
- T resolvedElement = resolvingStrategy.resolveElement(moduleMapping, moduleElement, serviceTracker, instanceName,
- moduleNamespace, defaultStrategy);
-
- innerMap.put(factoryName, resolvedElement);
- }
-
- public Services fromXmlServices(final XmlElement xml) throws DocumentedException {
- Optional<XmlElement> servicesElement = getServicesElement(xml);
-
- Services services;
- if (servicesElement.isPresent()) {
- services = Services.fromXml(servicesElement.get());
- } else {
- services = new Services();
- }
-
- return services;
- }
-
- private static Optional<XmlElement> getServicesElement(final XmlElement xml) {
- return xml.getOnlyChildElementOptionally(XmlMappingConstants.SERVICES_KEY,
- XmlMappingConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG);
- }
-
- public static void checkUnrecognisedChildren(final XmlElement parent) throws DocumentedException {
- Optional<XmlElement> servicesOpt = getServicesElement(parent);
- Optional<XmlElement> modulesOpt = getModulesElement(parent);
-
- List<XmlElement> recognised = Lists.newArrayList();
- if (servicesOpt.isPresent()) {
- recognised.add(servicesOpt.get());
- }
- if (modulesOpt.isPresent()) {
- recognised.add(modulesOpt.get());
- }
-
- parent.checkUnrecognisedElements(recognised);
- }
-
- private String getFactoryName(final String factoryNameWithPrefix, final String prefixOrEmptyString) {
- checkState(factoryNameWithPrefix.startsWith(prefixOrEmptyString),
- String.format("Internal error: text " + "content '%s' of type node does not start with prefix '%s'",
- factoryNameWithPrefix, prefixOrEmptyString));
-
- int factoryNameAfterPrefixIndex;
- if (prefixOrEmptyString.isEmpty()) {
- factoryNameAfterPrefixIndex = 0;
- } else {
- factoryNameAfterPrefixIndex = prefixOrEmptyString.length() + 1;
- }
- return factoryNameWithPrefix.substring(factoryNameAfterPrefixIndex);
- }
-
- private ModuleConfig getModuleMapping(final String moduleNamespace, final String instanceName,
- final String factoryName) {
- Map<String, ModuleConfig> mappingsFromNamespace = moduleConfigs.get(moduleNamespace);
-
- Preconditions.checkNotNull(mappingsFromNamespace,
- "Namespace %s, defined in: module %s of type %s not found, available namespaces: %s", moduleNamespace,
- instanceName, factoryName, moduleConfigs.keySet());
-
- ModuleConfig moduleMapping = mappingsFromNamespace.get(factoryName);
- checkState(moduleMapping != null, "Cannot find mapping for module type " + factoryName);
- return moduleMapping;
- }
-
- private interface ResolvingStrategy<T> {
- T resolveElement(ModuleConfig moduleMapping, XmlElement moduleElement, ServiceRegistryWrapper serviceTracker,
- String instanceName, String moduleNamespace, EditStrategyType defaultStrategy)
- throws DocumentedException;
- }
-}
Code Review / controller.git / blobdiff