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