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