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