2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig;
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;
17 import java.util.Date;
18 import java.util.HashMap;
22 import javax.management.InstanceNotFoundException;
23 import javax.management.ObjectName;
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;
54 public class EditConfig extends AbstractConfigNetconfOperation {
56 private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
58 private final YangStoreSnapshot yangStoreSnapshot;
60 private final TransactionProvider transactionProvider;
61 private EditConfigXmlParser editConfigXmlParser;
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();
72 Element getResponseInternal(final Document document,
73 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
75 if (editConfigExecution.shouldTest()) {
76 executeTests(getConfigRegistryClient(), editConfigExecution);
79 if (editConfigExecution.shouldSet()) {
80 executeSet(getConfigRegistryClient(), editConfigExecution);
83 logger.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
85 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
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);
94 private void executeTests(ConfigRegistryClient configRegistryClient,
95 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
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);
105 logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
108 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
109 EditStrategyType editStrategyType) throws ValidationException, NetconfDocumentedException {
110 ObjectName taON = transactionProvider.getTestTransaction();
112 // default strategy = replace wipes config
113 if (editStrategyType == EditStrategyType.replace) {
114 transactionProvider.wipeTestTransaction(taON);
117 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
119 handleMisssingInstancesOnTransaction(ta, execution);
120 setServicesOnTransaction(ta, execution);
121 setOnTransaction(ta, execution);
122 transactionProvider.validateTestTransaction(taON);
124 transactionProvider.abortTestTransaction(taON);
128 private void set(ConfigRegistryClient configRegistryClient,
129 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
130 ObjectName taON = transactionProvider.getOrCreateTransaction();
132 // default strategy = replace wipes config
133 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
134 transactionProvider.wipeTransaction();
137 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
139 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
140 setServicesOnTransaction(ta, editConfigExecution);
141 setOnTransaction(ta, editConfigExecution);
144 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
146 Services services = execution.getServices();
148 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
149 .getNamespaceToServiceNameToRefNameToInstance();
151 for (Map.Entry<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceToRefEntry : namespaceToServiceNameToRefNameToInstance.entrySet()) {
152 for (Map.Entry<String, Map<String, Services.ServiceInstance>> serviceToRefEntry : namespaceToServiceToRefEntry.getValue().entrySet()) {
154 String qnameOfService = getQname(ta, namespaceToServiceToRefEntry.getKey(), serviceToRefEntry.getKey());
155 Map<String, Services.ServiceInstance> refNameToInstance = serviceToRefEntry.getValue();
157 for (Map.Entry<String, Services.ServiceInstance> refNameToServiceEntry : refNameToInstance.entrySet()) {
158 ObjectName on = refNameToServiceEntry.getValue().getObjectName(ta.getTransactionName());
160 ObjectName saved = ta.saveServiceReference(qnameOfService, refNameToServiceEntry.getKey(), on);
161 logger.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
162 on, refNameToServiceEntry.getKey(), saved);
163 } catch (InstanceNotFoundException e) {
164 throw new NetconfDocumentedException(String.format("Unable to save ref name " + refNameToServiceEntry.getKey() + " for instance " + on, e),
165 ErrorType.application,
166 ErrorTag.operation_failed,
167 ErrorSeverity.error);
174 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
175 return ta.getServiceInterfaceName(namespace, serviceName);
178 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
180 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
182 for (Map.Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
183 String moduleName = moduleToResolved.getKey();
185 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
186 String instanceName = moduleElementResolved.getInstanceName();
188 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
189 EditConfigStrategy strategy = ice.getEditStrategy();
190 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
195 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
196 EditConfigExecution execution) throws NetconfDocumentedException {
198 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
199 for (Map.Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
200 String moduleName = moduleToResolved.getKey();
202 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
204 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
205 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
210 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
211 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
212 yangStoreSnapshot.getModuleMXBeanEntryMap());
213 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
214 return new Config(factories, identitiesMap);
218 public static class IdentityMapping {
219 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
222 this.identityNameToSchemaNode = Maps.newHashMap();
225 void addIdSchemaNode(IdentitySchemaNode node) {
226 String name = node.getQName().getLocalName();
227 Preconditions.checkState(!identityNameToSchemaNode.containsKey(name));
228 identityNameToSchemaNode.put(name, node);
231 public boolean containsIdName(String idName) {
232 return identityNameToSchemaNode.containsKey(idName);
237 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
238 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
239 for (Module module : modules) {
240 String namespace = module.getNamespace().toString();
241 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
242 if(revisionsByNamespace == null) {
243 revisionsByNamespace = Maps.newHashMap();
244 mappedIds.put(namespace, revisionsByNamespace);
247 Date revision = module.getRevision();
248 Preconditions.checkState(!revisionsByNamespace.containsKey(revision),
249 "Duplicate revision %s for namespace %s", revision, namespace);
251 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
252 if(identityMapping == null) {
253 identityMapping = new IdentityMapping();
254 revisionsByNamespace.put(revision, identityMapping);
257 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
258 identityMapping.addIdSchemaNode(identitySchemaNode);
266 public static Map<String/* Namespace from yang file */,
267 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
268 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
269 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
271 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
273 for (Map.Entry<String, Map<String, ModuleMXBeanEntry>> namespaceToModuleToMbe : mBeanEntries.entrySet()) {
274 for (Map.Entry<String, ModuleMXBeanEntry> moduleNameToMbe : namespaceToModuleToMbe.getValue().entrySet()) {
275 String moduleName = moduleNameToMbe.getKey();
276 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
278 ModuleConfig moduleConfig = new ModuleConfig(moduleName,
279 new InstanceConfig(configRegistryClient,moduleMXBeanEntry.getAttributes(), moduleMXBeanEntry.getNullableDummyContainerName()));
281 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespaceToModuleToMbe.getKey());
282 if(moduleNameToModuleConfig == null) {
283 moduleNameToModuleConfig = Maps.newHashMap();
284 namespaceToModuleNameToModuleConfig.put(namespaceToModuleToMbe.getKey(), moduleNameToModuleConfig);
287 moduleNameToModuleConfig.put(moduleName, moduleConfig);
291 return namespaceToModuleNameToModuleConfig;
295 protected String getOperationName() {
296 return EditConfigXmlParser.EDIT_CONFIG;
300 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
302 EditConfigXmlParser.EditConfigExecution editConfigExecution;
303 Config cfg = getConfigMapping(getConfigRegistryClient(), yangStoreSnapshot);
304 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg);
306 Element responseInternal;
307 responseInternal = getResponseInternal(document, editConfigExecution);
308 return responseInternal;