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