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.yang.store.api.YangStoreSnapshot;
  15 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  16 import org.opendaylight.controller.config.yangjmxgenerator.RuntimeBeanEntry;
  17 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  18 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
  19 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
  20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
  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.config.ServiceRegistryWrapper;
  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.getconfig.GetConfig;
  30 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
  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.HashMap;
  40 import java.util.List;
  41 import java.util.Map;
  42 import java.util.Set;
  43
  44 public class Get extends AbstractConfigNetconfOperation {
  45
  46     private final YangStoreSnapshot yangStoreSnapshot;
  47     private static final Logger logger = LoggerFactory.getLogger(Get.class);
  48     private final TransactionProvider transactionProvider;
  49
  50     public Get(YangStoreSnapshot yangStoreSnapshot, ConfigRegistryClient configRegistryClient,
  51                String netconfSessionIdForReporting, TransactionProvider transactionProvider) {
  52         super(configRegistryClient, netconfSessionIdForReporting);
  53         this.yangStoreSnapshot = yangStoreSnapshot;
  54         this.transactionProvider = transactionProvider;
  55     }
  56
  57     private Map<String, Map<String, ModuleRuntime>> createModuleRuntimes(ConfigRegistryClient configRegistryClient,
  58             Map<String, Map<String, ModuleMXBeanEntry>> mBeanEntries) {
  59         Map<String, Map<String, ModuleRuntime>> retVal = Maps.newHashMap();
  60
  61         for (String namespace : mBeanEntries.keySet()) {
  62
  63             Map<String, ModuleRuntime> innerMap = Maps.newHashMap();
  64             Map<String, ModuleMXBeanEntry> entriesFromNamespace = mBeanEntries.get(namespace);
  65             for (String module : entriesFromNamespace.keySet()) {
  66
  67                 ModuleMXBeanEntry mbe = entriesFromNamespace.get(module);
  68
  69                 Map<RuntimeBeanEntry, InstanceConfig> cache = Maps.newHashMap();
  70                 RuntimeBeanEntry root = null;
  71                 for (RuntimeBeanEntry rbe : mbe.getRuntimeBeans()) {
  72                     cache.put(rbe, new InstanceConfig(configRegistryClient, rbe.getYangPropertiesToTypesMap()));
  73                     if (rbe.isRoot())
  74                         root = rbe;
  75                 }
  76
  77                 if (root == null)
  78                     continue;
  79
  80                 InstanceRuntime rootInstanceRuntime = createInstanceRuntime(root, cache);
  81                 ModuleRuntime moduleRuntime = new ModuleRuntime(module, rootInstanceRuntime);
  82                 innerMap.put(module, moduleRuntime);
  83             }
  84
  85             retVal.put(namespace, innerMap);
  86         }
  87         return retVal;
  88     }
  89
  90     private InstanceRuntime createInstanceRuntime(RuntimeBeanEntry root, Map<RuntimeBeanEntry, InstanceConfig> cache) {
  91         Map<String, InstanceRuntime> children = Maps.newHashMap();
  92         for (RuntimeBeanEntry child : root.getChildren()) {
  93             children.put(child.getJavaNamePrefix(), createInstanceRuntime(child, cache));
  94         }
  95
  96         return new InstanceRuntime(cache.get(root), children, createJmxToYangMap(root.getChildren()));
  97     }
  98
  99     private Map<String, String> createJmxToYangMap(List<RuntimeBeanEntry> children) {
 100         Map<String, String> jmxToYangNamesForChildRbe = Maps.newHashMap();
 101         for (RuntimeBeanEntry rbe : children) {
 102             jmxToYangNamesForChildRbe.put(rbe.getJavaNamePrefix(), rbe.getYangName());
 103         }
 104         return jmxToYangNamesForChildRbe;
 105     }
 106
 107     private static void checkXml(XmlElement xml) {
 108         xml.checkName(XmlNetconfConstants.GET);
 109         xml.checkNamespace(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
 110
 111         // Filter option - unsupported
 112         if (xml.getChildElements(XmlNetconfConstants.FILTER).size() != 0)
 113             throw new UnsupportedOperationException("Unsupported option " + XmlNetconfConstants.FILTER + " for " + XmlNetconfConstants.GET);
 114     }
 115
 116     @Override
 117     protected String getOperationName() {
 118         return XmlNetconfConstants.GET;
 119     }
 120
 121     @Override
 122     protected Element handle(Document document, XmlElement xml) throws NetconfDocumentedException {
 123         try {
 124             checkXml(xml);
 125         } catch (final IllegalArgumentException e) {
 126             logger.warn("Error parsing xml", e);
 127             final Map<String, String> errorInfo = new HashMap<>();
 128             errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
 129             throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.rpc, ErrorTag.bad_attribute,
 130                     ErrorSeverity.error, errorInfo);
 131         } catch (final UnsupportedOperationException e) {
 132             logger.warn("Unsupported", e);
 133             final Map<String, String> errorInfo = new HashMap<>();
 134             errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'get'");
 135             throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.application,
 136                     ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
 137         }
 138
 139         final Set<ObjectName> runtimeBeans = configRegistryClient.lookupRuntimeBeans();
 140
 141         //Transaction provider required only for candidate datastore
 142         final Set<ObjectName> configBeans = Datastore.getInstanceQueryStrategy(Datastore.running, null)
 143                 .queryInstances(configRegistryClient);
 144
 145         final Map<String, Map<String, ModuleRuntime>> moduleRuntimes = createModuleRuntimes(configRegistryClient,
 146                 yangStoreSnapshot.getModuleMXBeanEntryMap());
 147         final Map<String, Map<String, ModuleConfig>> moduleConfigs = GetConfig.transform(configRegistryClient,
 148                 yangStoreSnapshot.getModuleMXBeanEntryMap());
 149
 150         final Runtime runtime = new Runtime(moduleRuntimes, moduleConfigs);
 151
 152         ObjectName txOn = transactionProvider.getOrCreateTransaction();
 153         ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(txOn);
 154         final Element element = runtime.toXml(runtimeBeans, configBeans, document, new ServiceRegistryWrapper(ta));
 155
 156         logger.info("{} operation successful", XmlNetconfConstants.GET);
 157
 158         return element;
 159     }
 160 }