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