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