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