opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/operations/editconfig/EditConfig.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.editconfig;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.collect.Maps;
  13 import com.google.common.collect.Multimap;
  14 import org.opendaylight.controller.config.api.JmxAttributeValidationException;
  15 import org.opendaylight.controller.config.api.ValidationException;
  16 import org.opendaylight.controller.config.util.ConfigRegistryClient;
  17 import org.opendaylight.controller.config.util.ConfigTransactionClient;
  18 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
  19 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  21 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
  22 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
  23 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
  24 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
  25 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
  26 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
  27 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
  28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
  29 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
  30 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
  31 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
  32 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  33 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36 import org.w3c.dom.Document;
  37 import org.w3c.dom.Element;
  38
  39 import javax.management.ObjectName;
  40 import java.util.HashMap;
  41 import java.util.Map;
  42 import java.util.Map.Entry;
  43
  44 public class EditConfig extends AbstractConfigNetconfOperation {
  45
  46     private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
  47
  48     private final YangStoreSnapshot yangStoreSnapshot;
  49
  50     private final TransactionProvider transactionProvider;
  51     private EditConfigXmlParser editConfigXmlParser;
  52
  53     public EditConfig(YangStoreSnapshot yangStoreSnapshot, TransactionProvider transactionProvider,
  54             ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
  55         super(configRegistryClient, netconfSessionIdForReporting);
  56         this.yangStoreSnapshot = yangStoreSnapshot;
  57         this.transactionProvider = transactionProvider;
  58         this.editConfigXmlParser = new EditConfigXmlParser();
  59     }
  60
  61     @VisibleForTesting
  62     Element getResponseInternal(final Document document,
  63             final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
  64         if (editConfigExecution.shouldTest()) {
  65             executeTests(configRegistryClient, editConfigExecution);
  66         }
  67
  68         if (editConfigExecution.shouldSet()) {
  69             executeSet(configRegistryClient, editConfigExecution);
  70         }
  71
  72         logger.info("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
  73
  74         return document.createElement(XmlNetconfConstants.OK);
  75     }
  76
  77     private void executeSet(ConfigRegistryClient configRegistryClient,
  78             EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
  79         try {
  80             set(configRegistryClient, editConfigExecution);
  81         } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
  82             logger.warn("Set phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
  83             final Map<String, String> errorInfo = new HashMap<>();
  84             errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
  85             throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
  86                     ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
  87         }
  88         logger.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
  89     }
  90
  91     private void executeTests(ConfigRegistryClient configRegistryClient,
  92             EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
  93         try {
  94             test(configRegistryClient, editConfigExecution.getResolvedXmlElements(), editConfigExecution.getDefaultStrategy());
  95         } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
  96             logger.warn("Test phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
  97             final Map<String, String> errorInfo = new HashMap<>();
  98             errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
  99             throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
 100                     ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
 101         }
 102         logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
 103     }
 104
 105     private void test(ConfigRegistryClient configRegistryClient,
 106                       Map<String, Multimap<String, ModuleElementResolved>> resolvedModules, EditStrategyType editStrategyType) {
 107         ObjectName taON = transactionProvider.getTestTransaction();
 108         try {
 109
 110             // default strategy = replace wipes config
 111             if (editStrategyType == EditStrategyType.replace) {
 112                 transactionProvider.wipeTestTransaction(taON);
 113             }
 114             setOnTransaction(configRegistryClient, resolvedModules, taON);
 115             transactionProvider.validateTestTransaction(taON);
 116         } finally {
 117             transactionProvider.abortTestTransaction(taON);
 118         }
 119     }
 120
 121     private void set(ConfigRegistryClient configRegistryClient,
 122             EditConfigXmlParser.EditConfigExecution editConfigExecution) {
 123         ObjectName taON = transactionProvider.getOrCreateTransaction();
 124
 125         // default strategy = replace wipes config
 126         if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
 127             transactionProvider.wipeTransaction();
 128         }
 129         setOnTransaction(configRegistryClient, editConfigExecution.getResolvedXmlElements(), taON);
 130     }
 131
 132     private void setOnTransaction(ConfigRegistryClient configRegistryClient,
 133             Map<String, Multimap<String, ModuleElementResolved>> resolvedXmlElements, ObjectName taON) {
 134         ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
 135
 136         for (Multimap<String, ModuleElementResolved> modulesToResolved : resolvedXmlElements.values()) {
 137             for (Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
 138                 String moduleName = moduleToResolved.getKey();
 139
 140                 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
 141                 String instanceName = moduleElementResolved.getInstanceName();
 142
 143                 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
 144                 EditConfigStrategy strategy = ice.getEditStrategy();
 145                 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta);
 146             }
 147         }
 148     }
 149
 150     public static Config getConfigMapping(ConfigRegistryClient configRegistryClient,
 151             Map<String/* Namespace from yang file */,
 152                     Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
 153         Map<String, Map<String, ModuleConfig>> factories = transform(configRegistryClient, mBeanEntries);
 154
 155         return new Config(factories);
 156     }
 157
 158     // TODO refactor
 159     private static Map<String/* Namespace from yang file */,
 160             Map<String /* Name of module entry from yang file */, ModuleConfig>> transform
 161     (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
 162                     Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
 163         return Maps.transformEntries(mBeanEntries,
 164                 new Maps.EntryTransformer<String, Map<String, ModuleMXBeanEntry>, Map<String, ModuleConfig>>() {
 165
 166                     @Override
 167                     public Map<String, ModuleConfig> transformEntry(String arg0, Map<String, ModuleMXBeanEntry> arg1) {
 168                         return Maps.transformEntries(arg1,
 169                                 new Maps.EntryTransformer<String, ModuleMXBeanEntry, ModuleConfig>() {
 170
 171                                     @Override
 172                                     public ModuleConfig transformEntry(String key, ModuleMXBeanEntry moduleMXBeanEntry) {
 173                                         return new ModuleConfig(key, new InstanceConfig(configRegistryClient, moduleMXBeanEntry
 174                                                 .getAttributes()), moduleMXBeanEntry.getProvidedServices().values());
 175                                     }
 176                                 });
 177                     }
 178                 });
 179     }
 180
 181     @Override
 182     protected String getOperationName() {
 183         return EditConfigXmlParser.EDIT_CONFIG;
 184     }
 185
 186     @Override
 187     protected Element handle(Document document, XmlElement xml) throws NetconfDocumentedException {
 188
 189         EditConfigXmlParser.EditConfigExecution editConfigExecution;
 190         Config cfg = getConfigMapping(configRegistryClient, yangStoreSnapshot.getModuleMXBeanEntryMap());
 191         try {
 192             editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, configRegistryClient);
 193         } catch (IllegalStateException e) {
 194             logger.warn("Error parsing xml", e);
 195             final Map<String, String> errorInfo = new HashMap<>();
 196             errorInfo.put(ErrorTag.missing_attribute.name(), "Error parsing xml: " + e.getMessage());
 197             throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.missing_attribute,
 198                     ErrorSeverity.error, errorInfo);
 199         } catch (final IllegalArgumentException e) {
 200             logger.warn("Error parsing xml", e);
 201             final Map<String, String> errorInfo = new HashMap<>();
 202             errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
 203             throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.bad_attribute,
 204                     ErrorSeverity.error, errorInfo);
 205         } catch (final UnsupportedOperationException e) {
 206             logger.warn("Unsupported", e);
 207             final Map<String, String> errorInfo = new HashMap<>();
 208             errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'edit-config'");
 209             throw new NetconfDocumentedException(e.getMessage(), ErrorType.application,
 210                     ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
 211         }
 212
 213         return getResponseInternal(document, editConfigExecution);
 214     }
 215 }