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