opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/operations/get/Get.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.operations.get;
  10
  11 import com.google.common.collect.Maps;
  12
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16
  17 import javax.management.ObjectName;
  18
  19 import org.opendaylight.controller.config.util.ConfigRegistryClient;
  20 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  21 import org.opendaylight.controller.config.yangjmxgenerator.RuntimeBeanEntry;
  22 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  23 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
  24 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
  25 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
  26 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.runtime.InstanceRuntime;
  27 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.runtime.ModuleRuntime;
  28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.runtime.Runtime;
  29 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
  30 import org.opendaylight.controller.netconf.confignetconfconnector.operations.Datastore;
  31 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfig;
  32 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot;
  33 import org.opendaylight.controller.netconf.util.exception.MissingNameSpaceException;
  34 import org.opendaylight.controller.netconf.util.exception.UnexpectedElementException;
  35 import org.opendaylight.controller.netconf.util.exception.UnexpectedNamespaceException;
  36 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.w3c.dom.Document;
  40 import org.w3c.dom.Element;
  41
  42 public class Get extends AbstractConfigNetconfOperation {
  43
  44     private final YangStoreSnapshot yangStoreSnapshot;
  45     private static final Logger logger = LoggerFactory.getLogger(Get.class);
  46
  47     public Get(YangStoreSnapshot yangStoreSnapshot, ConfigRegistryClient configRegistryClient,
  48                String netconfSessionIdForReporting) {
  49         super(configRegistryClient, netconfSessionIdForReporting);
  50         this.yangStoreSnapshot = yangStoreSnapshot;
  51     }
  52
  53     private Map<String, Map<String, ModuleRuntime>> createModuleRuntimes(ConfigRegistryClient configRegistryClient,
  54             Map<String, Map<String, ModuleMXBeanEntry>> mBeanEntries) {
  55         Map<String, Map<String, ModuleRuntime>> retVal = Maps.newHashMap();
  56
  57         for (Map.Entry<String, Map<String, ModuleMXBeanEntry>> namespaceToModuleEntry : mBeanEntries.entrySet()) {
  58
  59             Map<String, ModuleRuntime> innerMap = Maps.newHashMap();
  60             Map<String, ModuleMXBeanEntry> entriesFromNamespace = namespaceToModuleEntry.getValue();
  61             for (Map.Entry<String, ModuleMXBeanEntry> moduleToMXEntry : entriesFromNamespace.entrySet()) {
  62
  63                 ModuleMXBeanEntry mbe = moduleToMXEntry.getValue();
  64
  65                 Map<RuntimeBeanEntry, InstanceConfig> cache = Maps.newHashMap();
  66                 RuntimeBeanEntry root = null;
  67                 for (RuntimeBeanEntry rbe : mbe.getRuntimeBeans()) {
  68                     cache.put(rbe, new InstanceConfig(configRegistryClient, rbe.getYangPropertiesToTypesMap(), mbe.getNullableDummyContainerName()));
  69                     if (rbe.isRoot()){
  70                         root = rbe;
  71                     }
  72                 }
  73
  74                 if (root == null){
  75                     continue;
  76                 }
  77
  78                 InstanceRuntime rootInstanceRuntime = createInstanceRuntime(root, cache);
  79                 ModuleRuntime moduleRuntime = new ModuleRuntime(rootInstanceRuntime);
  80                 innerMap.put(moduleToMXEntry.getKey(), moduleRuntime);
  81             }
  82
  83             retVal.put(namespaceToModuleEntry.getKey(), innerMap);
  84         }
  85         return retVal;
  86     }
  87
  88     private InstanceRuntime createInstanceRuntime(RuntimeBeanEntry root, Map<RuntimeBeanEntry, InstanceConfig> cache) {
  89         Map<String, InstanceRuntime> children = Maps.newHashMap();
  90         for (RuntimeBeanEntry child : root.getChildren()) {
  91             children.put(child.getJavaNamePrefix(), createInstanceRuntime(child, cache));
  92         }
  93
  94         return new InstanceRuntime(cache.get(root), children, createJmxToYangMap(root.getChildren()));
  95     }
  96
  97     private Map<String, String> createJmxToYangMap(List<RuntimeBeanEntry> children) {
  98         Map<String, String> jmxToYangNamesForChildRbe = Maps.newHashMap();
  99         for (RuntimeBeanEntry rbe : children) {
 100             jmxToYangNamesForChildRbe.put(rbe.getJavaNamePrefix(), rbe.getYangName());
 101         }
 102         return jmxToYangNamesForChildRbe;
 103     }
 104
 105     private static void checkXml(XmlElement xml) throws UnexpectedElementException, UnexpectedNamespaceException, MissingNameSpaceException {
 106         xml.checkName(XmlNetconfConstants.GET);
 107         xml.checkNamespace(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
 108
 109         // Filter option: ignore for now, TODO only load modules specified by the filter
 110     }
 111
 112     @Override
 113     protected String getOperationName() {
 114         return XmlNetconfConstants.GET;
 115     }
 116
 117     @Override
 118     protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
 119         checkXml(xml);
 120
 121         final Set<ObjectName> runtimeBeans = getConfigRegistryClient().lookupRuntimeBeans();
 122
 123         //Transaction provider required only for candidate datastore
 124         final Set<ObjectName> configBeans = Datastore.getInstanceQueryStrategy(Datastore.running, null)
 125                 .queryInstances(getConfigRegistryClient());
 126
 127         final Map<String, Map<String, ModuleRuntime>> moduleRuntimes = createModuleRuntimes(getConfigRegistryClient(),
 128                 yangStoreSnapshot.getModuleMXBeanEntryMap());
 129         final Map<String, Map<String, ModuleConfig>> moduleConfigs = EditConfig.transformMbeToModuleConfigs(
 130                 getConfigRegistryClient(), yangStoreSnapshot.getModuleMXBeanEntryMap());
 131
 132         final Runtime runtime = new Runtime(moduleRuntimes, moduleConfigs);
 133
 134         final Element element = runtime.toXml(runtimeBeans, configBeans, document);
 135
 136         logger.trace("{} operation successful", XmlNetconfConstants.GET);
 137
 138         return element;
 139     }
 140 }