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.base.Preconditions;
  13 import com.google.common.collect.Maps;
  14 import com.google.common.collect.Multimap;
  15 import org.opendaylight.controller.config.api.JmxAttributeValidationException;
  16 import org.opendaylight.controller.config.api.ValidationException;
  17 import org.opendaylight.controller.config.util.ConfigRegistryClient;
  18 import org.opendaylight.controller.config.util.ConfigTransactionClient;
  19 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
  20 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  21 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  22 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
  23 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
  24 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
  25 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
  26 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
  27 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
  28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
  29 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
  30 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
  31 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
  32 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
  33 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
  34 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
  35 import org.opendaylight.controller.netconf.util.xml.XmlElement;
  36 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
  37 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.Module;
  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 javax.management.InstanceNotFoundException;
  45 import javax.management.ObjectName;
  46 import java.util.Date;
  47 import java.util.HashMap;
  48 import java.util.Map;
  49 import java.util.Map.Entry;
  50 import java.util.Set;
  51
  52 public class EditConfig extends AbstractConfigNetconfOperation {
  53
  54     private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
  55
  56     private final YangStoreSnapshot yangStoreSnapshot;
  57
  58     private final TransactionProvider transactionProvider;
  59     private EditConfigXmlParser editConfigXmlParser;
  60
  61     public EditConfig(YangStoreSnapshot yangStoreSnapshot, TransactionProvider transactionProvider,
  62             ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
  63         super(configRegistryClient, netconfSessionIdForReporting);
  64         this.yangStoreSnapshot = yangStoreSnapshot;
  65         this.transactionProvider = transactionProvider;
  66         this.editConfigXmlParser = new EditConfigXmlParser();
  67     }
  68
  69     @VisibleForTesting
  70     Element getResponseInternal(final Document document,
  71             final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
  72
  73         if (editConfigExecution.shouldTest()) {
  74             executeTests(configRegistryClient, editConfigExecution);
  75         }
  76
  77         if (editConfigExecution.shouldSet()) {
  78             executeSet(configRegistryClient, editConfigExecution);
  79         }
  80
  81         logger.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
  82
  83         return document.createElement(XmlNetconfConstants.OK);
  84     }
  85
  86     private void executeSet(ConfigRegistryClient configRegistryClient,
  87             EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
  88         try {
  89             set(configRegistryClient, editConfigExecution);
  90         } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
  91             logger.warn("Set 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("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
  98     }
  99
 100     private void executeTests(ConfigRegistryClient configRegistryClient,
 101             EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
 102         try {
 103             test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
 104         } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
 105             logger.warn("Test phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
 106             final Map<String, String> errorInfo = new HashMap<>();
 107             errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
 108             throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
 109                     ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
 110         }
 111         logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
 112     }
 113
 114     private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
 115             EditStrategyType editStrategyType) {
 116         ObjectName taON = transactionProvider.getTestTransaction();
 117         try {
 118
 119             // default strategy = replace wipes config
 120             if (editStrategyType == EditStrategyType.replace) {
 121                 transactionProvider.wipeTestTransaction(taON);
 122             }
 123
 124             ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
 125
 126             handleMisssingInstancesOnTransaction(ta, execution);
 127             setServicesOnTransaction(ta, execution);
 128             setOnTransaction(ta, execution);
 129             transactionProvider.validateTestTransaction(taON);
 130         } finally {
 131             transactionProvider.abortTestTransaction(taON);
 132         }
 133     }
 134
 135     private void set(ConfigRegistryClient configRegistryClient,
 136             EditConfigXmlParser.EditConfigExecution editConfigExecution) {
 137         ObjectName taON = transactionProvider.getOrCreateTransaction();
 138
 139         // default strategy = replace wipes config
 140         if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
 141             transactionProvider.wipeTransaction();
 142         }
 143
 144         ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
 145
 146         handleMisssingInstancesOnTransaction(ta, editConfigExecution);
 147         setServicesOnTransaction(ta, editConfigExecution);
 148         setOnTransaction(ta, editConfigExecution);
 149     }
 150
 151     private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
 152
 153         Services services = execution.getServices();
 154
 155         Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
 156                 .getNamespaceToServiceNameToRefNameToInstance();
 157
 158         for (String serviceNamespace : namespaceToServiceNameToRefNameToInstance.keySet()) {
 159             for (String serviceName : namespaceToServiceNameToRefNameToInstance.get(serviceNamespace).keySet()) {
 160
 161                 String qnameOfService = getQname(ta, serviceNamespace, serviceName);
 162                 Map<String, Services.ServiceInstance> refNameToInstance = namespaceToServiceNameToRefNameToInstance
 163                         .get(serviceNamespace).get(serviceName);
 164
 165                 for (String refName : refNameToInstance.keySet()) {
 166                     ObjectName on = refNameToInstance.get(refName).getObjectName(ta.getTransactionName());
 167                     try {
 168                         ObjectName saved = ta.saveServiceReference(qnameOfService, refName, on);
 169                         logger.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
 170                                 on, refName, saved);
 171                     } catch (InstanceNotFoundException e) {
 172                         throw new IllegalStateException("Unable to save ref name " + refName + " for instance " + on, e);
 173                     }
 174                 }
 175             }
 176         }
 177     }
 178
 179     private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
 180         return ta.getServiceInterfaceName(namespace, serviceName);
 181     }
 182
 183     private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
 184
 185         for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
 186
 187             for (Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
 188                 String moduleName = moduleToResolved.getKey();
 189
 190                 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
 191                 String instanceName = moduleElementResolved.getInstanceName();
 192
 193                 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
 194                 EditConfigStrategy strategy = ice.getEditStrategy();
 195                 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
 196             }
 197         }
 198     }
 199
 200     private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
 201             EditConfigExecution execution) {
 202
 203         for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
 204             for (Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
 205                 String moduleName = moduleToResolved.getKey();
 206
 207                 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
 208
 209                 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
 210                 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
 211             }
 212         }
 213     }
 214
 215     public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
 216         Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
 217                 yangStoreSnapshot.getModuleMXBeanEntryMap());
 218         Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
 219         return new Config(factories, identitiesMap);
 220     }
 221
 222
 223     public static class IdentityMapping {
 224         private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
 225
 226         IdentityMapping() {
 227             this.identityNameToSchemaNode = Maps.newHashMap();
 228         }
 229
 230         void addIdSchemaNode(IdentitySchemaNode node) {
 231             String name = node.getQName().getLocalName();
 232             Preconditions.checkState(identityNameToSchemaNode.containsKey(name) == false);
 233             identityNameToSchemaNode.put(name, node);
 234         }
 235
 236         public boolean containsIdName(String idName) {
 237             return identityNameToSchemaNode.containsKey(idName);
 238         }
 239
 240         public IdentitySchemaNode getIdentitySchemaNode(String idName) {
 241             Preconditions.checkState(identityNameToSchemaNode.containsKey(idName), "No identity under name %s", idName);
 242             return identityNameToSchemaNode.get(idName);
 243         }
 244     }
 245
 246     private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
 247         Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
 248         for (Module module : modules) {
 249             String namespace = module.getNamespace().toString();
 250             Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
 251             if(revisionsByNamespace == null) {
 252                 revisionsByNamespace = Maps.newHashMap();
 253                 mappedIds.put(namespace, revisionsByNamespace);
 254             }
 255
 256             Date revision = module.getRevision();
 257             Preconditions.checkState(revisionsByNamespace.containsKey(revision) == false,
 258                     "Duplicate revision %s for namespace %s", revision, namespace);
 259
 260             IdentityMapping identityMapping = revisionsByNamespace.get(revision);
 261             if(identityMapping == null) {
 262                 identityMapping = new IdentityMapping();
 263                 revisionsByNamespace.put(revision, identityMapping);
 264             }
 265
 266             for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
 267                 identityMapping.addIdSchemaNode(identitySchemaNode);
 268             }
 269
 270         }
 271
 272         return mappedIds;
 273     }
 274
 275     public static Map<String/* Namespace from yang file */,
 276             Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
 277             (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
 278                     Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
 279
 280         Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
 281
 282         for (String namespace : mBeanEntries.keySet()) {
 283             for (Entry<String, ModuleMXBeanEntry> moduleNameToMbe : mBeanEntries.get(namespace).entrySet()) {
 284                 String moduleName = moduleNameToMbe.getKey();
 285                 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
 286
 287                 ModuleConfig moduleConfig = new ModuleConfig(moduleName, new InstanceConfig(configRegistryClient,
 288                         moduleMXBeanEntry.getAttributes()), moduleMXBeanEntry
 289                         .getProvidedServices().values());
 290
 291                 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespace);
 292                 if(moduleNameToModuleConfig == null) {
 293                     moduleNameToModuleConfig = Maps.newHashMap();
 294                     namespaceToModuleNameToModuleConfig.put(namespace, moduleNameToModuleConfig);
 295                 }
 296
 297                 moduleNameToModuleConfig.put(moduleName, moduleConfig);
 298             }
 299         }
 300
 301         return namespaceToModuleNameToModuleConfig;
 302     }
 303
 304     @Override
 305     protected String getOperationName() {
 306         return EditConfigXmlParser.EDIT_CONFIG;
 307     }
 308
 309     @Override
 310     protected Element handle(Document document, XmlElement xml) throws NetconfDocumentedException {
 311
 312         EditConfigXmlParser.EditConfigExecution editConfigExecution;
 313         Config cfg = getConfigMapping(configRegistryClient, yangStoreSnapshot);
 314         try {
 315             editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, configRegistryClient);
 316         } catch (IllegalStateException e) {
 317             logger.warn("Error parsing xml", e);
 318             final Map<String, String> errorInfo = new HashMap<>();
 319             errorInfo.put(ErrorTag.missing_attribute.name(), "Error parsing xml: " + e.getMessage());
 320             throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.missing_attribute,
 321                     ErrorSeverity.error, errorInfo);
 322         } catch (final IllegalArgumentException e) {
 323             logger.warn("Error parsing xml", e);
 324             final Map<String, String> errorInfo = new HashMap<>();
 325             errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
 326             throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.bad_attribute,
 327                     ErrorSeverity.error, errorInfo);
 328         } catch (final UnsupportedOperationException e) {
 329             logger.warn("Unsupported", e);
 330             final Map<String, String> errorInfo = new HashMap<>();
 331             errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'edit-config'");
 332             throw new NetconfDocumentedException(e.getMessage(), ErrorType.application,
 333                     ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
 334         }
 335
 336         return getResponseInternal(document, editConfigExecution);
 337     }
 338
 339 }