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;
16 import java.util.Date;
17 import java.util.HashMap;
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.api.xml.XmlNetconfConstants;
31 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
32 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
33 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
34 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
35 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
36 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
37 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
38 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
39 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
40 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot;
41 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
42 import org.opendaylight.controller.netconf.util.xml.XmlElement;
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;
51 public class EditConfig extends AbstractConfigNetconfOperation {
53 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
55 private final YangStoreSnapshot yangStoreSnapshot;
57 private final TransactionProvider transactionProvider;
58 private EditConfigXmlParser editConfigXmlParser;
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();
69 Element getResponseInternal(final Document document,
70 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
72 if (editConfigExecution.shouldTest()) {
73 executeTests(getConfigRegistryClient(), editConfigExecution);
76 if (editConfigExecution.shouldSet()) {
77 executeSet(getConfigRegistryClient(), editConfigExecution);
80 LOG.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
82 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
85 private void executeSet(ConfigRegistryClient configRegistryClient,
86 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
87 set(configRegistryClient, editConfigExecution);
88 LOG.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
91 private void executeTests(ConfigRegistryClient configRegistryClient,
92 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
94 test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
95 } catch (final ValidationException e) {
96 LOG.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);
102 LOG.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
105 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
106 EditStrategyType editStrategyType) throws ValidationException, NetconfDocumentedException {
107 ObjectName taON = transactionProvider.getTestTransaction();
109 // default strategy = replace wipes config
110 if (editStrategyType == EditStrategyType.replace) {
111 transactionProvider.wipeTestTransaction(taON);
114 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
116 handleMisssingInstancesOnTransaction(ta, execution);
117 setServicesOnTransaction(ta, execution);
118 setOnTransaction(ta, execution);
119 transactionProvider.validateTestTransaction(taON);
121 transactionProvider.abortTestTransaction(taON);
125 private void set(ConfigRegistryClient configRegistryClient,
126 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
127 ObjectName taON = transactionProvider.getOrCreateTransaction();
129 // default strategy = replace wipes config
130 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
131 transactionProvider.wipeTransaction();
134 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
136 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
137 setServicesOnTransaction(ta, editConfigExecution);
138 setOnTransaction(ta, editConfigExecution);
141 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
143 Services services = execution.getServices();
145 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
146 .getNamespaceToServiceNameToRefNameToInstance();
148 for (Map.Entry<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceToRefEntry : namespaceToServiceNameToRefNameToInstance.entrySet()) {
149 for (Map.Entry<String, Map<String, Services.ServiceInstance>> serviceToRefEntry : namespaceToServiceToRefEntry.getValue().entrySet()) {
151 String qnameOfService = getQname(ta, namespaceToServiceToRefEntry.getKey(), serviceToRefEntry.getKey());
152 Map<String, Services.ServiceInstance> refNameToInstance = serviceToRefEntry.getValue();
154 for (Map.Entry<String, Services.ServiceInstance> refNameToServiceEntry : refNameToInstance.entrySet()) {
155 ObjectName on = refNameToServiceEntry.getValue().getObjectName(ta.getTransactionName());
157 ObjectName saved = ta.saveServiceReference(qnameOfService, refNameToServiceEntry.getKey(), on);
158 LOG.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
159 on, refNameToServiceEntry.getKey(), saved);
160 } catch (InstanceNotFoundException e) {
161 throw new NetconfDocumentedException(String.format("Unable to save ref name " + refNameToServiceEntry.getKey() + " for instance " + on, e),
162 ErrorType.application,
163 ErrorTag.operation_failed,
164 ErrorSeverity.error);
171 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
172 return ta.getServiceInterfaceName(namespace, serviceName);
175 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
177 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
179 for (Map.Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
180 String moduleName = moduleToResolved.getKey();
182 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
183 String instanceName = moduleElementResolved.getInstanceName();
185 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
186 EditConfigStrategy strategy = ice.getEditStrategy();
187 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
192 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
193 EditConfigExecution execution) throws NetconfDocumentedException {
195 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
196 for (Map.Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
197 String moduleName = moduleToResolved.getKey();
199 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
201 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
202 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
207 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
208 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
209 yangStoreSnapshot.getModuleMXBeanEntryMap());
210 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
211 return new Config(factories, identitiesMap);
215 public static class IdentityMapping {
216 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
219 this.identityNameToSchemaNode = Maps.newHashMap();
222 void addIdSchemaNode(IdentitySchemaNode node) {
223 String name = node.getQName().getLocalName();
224 Preconditions.checkState(!identityNameToSchemaNode.containsKey(name));
225 identityNameToSchemaNode.put(name, node);
228 public boolean containsIdName(String idName) {
229 return identityNameToSchemaNode.containsKey(idName);
234 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
235 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
236 for (Module module : modules) {
237 String namespace = module.getNamespace().toString();
238 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
239 if(revisionsByNamespace == null) {
240 revisionsByNamespace = Maps.newHashMap();
241 mappedIds.put(namespace, revisionsByNamespace);
244 Date revision = module.getRevision();
245 Preconditions.checkState(!revisionsByNamespace.containsKey(revision),
246 "Duplicate revision %s for namespace %s", revision, namespace);
248 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
249 if(identityMapping == null) {
250 identityMapping = new IdentityMapping();
251 revisionsByNamespace.put(revision, identityMapping);
254 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
255 identityMapping.addIdSchemaNode(identitySchemaNode);
263 public static Map<String/* Namespace from yang file */,
264 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
265 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
266 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
268 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
270 for (Map.Entry<String, Map<String, ModuleMXBeanEntry>> namespaceToModuleToMbe : mBeanEntries.entrySet()) {
271 for (Map.Entry<String, ModuleMXBeanEntry> moduleNameToMbe : namespaceToModuleToMbe.getValue().entrySet()) {
272 String moduleName = moduleNameToMbe.getKey();
273 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
275 ModuleConfig moduleConfig = new ModuleConfig(moduleName,
276 new InstanceConfig(configRegistryClient,moduleMXBeanEntry.getAttributes(), moduleMXBeanEntry.getNullableDummyContainerName()));
278 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespaceToModuleToMbe.getKey());
279 if(moduleNameToModuleConfig == null) {
280 moduleNameToModuleConfig = Maps.newHashMap();
281 namespaceToModuleNameToModuleConfig.put(namespaceToModuleToMbe.getKey(), moduleNameToModuleConfig);
284 moduleNameToModuleConfig.put(moduleName, moduleConfig);
288 return namespaceToModuleNameToModuleConfig;
292 protected String getOperationName() {
293 return EditConfigXmlParser.EDIT_CONFIG;
297 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
299 EditConfigXmlParser.EditConfigExecution editConfigExecution;
300 Config cfg = getConfigMapping(getConfigRegistryClient(), yangStoreSnapshot);
301 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg);
303 Element responseInternal;
304 responseInternal = getResponseInternal(document, editConfigExecution);
305 return responseInternal;