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 java.util.Date;
12 import java.util.HashMap;
14 import java.util.Map.Entry;
17 import javax.management.InstanceNotFoundException;
18 import javax.management.ObjectName;
20 import org.opendaylight.controller.config.api.ValidationException;
21 import org.opendaylight.controller.config.util.ConfigRegistryClient;
22 import org.opendaylight.controller.config.util.ConfigTransactionClient;
23 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot;
24 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
25 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
26 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
27 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
28 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
29 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
30 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
31 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
32 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
33 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
34 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
35 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
36 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
37 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
38 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
39 import org.opendaylight.controller.netconf.util.xml.XmlElement;
40 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
41 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.Module;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45 import org.w3c.dom.Document;
46 import org.w3c.dom.Element;
48 import com.google.common.annotations.VisibleForTesting;
49 import com.google.common.base.Preconditions;
50 import com.google.common.collect.Maps;
51 import com.google.common.collect.Multimap;
53 public class EditConfig extends AbstractConfigNetconfOperation {
55 private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
57 private final YangStoreSnapshot yangStoreSnapshot;
59 private final TransactionProvider transactionProvider;
60 private EditConfigXmlParser editConfigXmlParser;
62 public EditConfig(YangStoreSnapshot yangStoreSnapshot, TransactionProvider transactionProvider,
63 ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
64 super(configRegistryClient, netconfSessionIdForReporting);
65 this.yangStoreSnapshot = yangStoreSnapshot;
66 this.transactionProvider = transactionProvider;
67 this.editConfigXmlParser = new EditConfigXmlParser();
71 Element getResponseInternal(final Document document,
72 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
74 if (editConfigExecution.shouldTest()) {
75 executeTests(configRegistryClient, editConfigExecution);
78 if (editConfigExecution.shouldSet()) {
79 executeSet(configRegistryClient, editConfigExecution);
82 logger.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
84 return document.createElement(XmlNetconfConstants.OK);
87 private void executeSet(ConfigRegistryClient configRegistryClient,
88 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
90 set(configRegistryClient, editConfigExecution);
92 } catch (IllegalStateException e) {
93 //FIXME: when can IllegalStateException be thrown?
94 // JmxAttributeValidationException is wrapped in DynamicWritableWrapper with ValidationException
95 // ValidationException is not thrown until validate or commit is issued
96 logger.warn("Set 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 logger.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
105 private void executeTests(ConfigRegistryClient configRegistryClient,
106 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
108 test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
109 } catch (IllegalStateException | ValidationException e) {
110 //FIXME: when can IllegalStateException be thrown?
111 logger.warn("Test phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
112 final Map<String, String> errorInfo = new HashMap<>();
113 errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
114 throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
115 ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
117 logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
120 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
121 EditStrategyType editStrategyType) throws ValidationException {
122 ObjectName taON = transactionProvider.getTestTransaction();
125 // default strategy = replace wipes config
126 if (editStrategyType == EditStrategyType.replace) {
127 transactionProvider.wipeTestTransaction(taON);
130 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
132 handleMisssingInstancesOnTransaction(ta, execution);
133 setServicesOnTransaction(ta, execution);
134 setOnTransaction(ta, execution);
135 transactionProvider.validateTestTransaction(taON);
137 transactionProvider.abortTestTransaction(taON);
141 private void set(ConfigRegistryClient configRegistryClient,
142 EditConfigXmlParser.EditConfigExecution editConfigExecution) {
143 ObjectName taON = transactionProvider.getOrCreateTransaction();
145 // default strategy = replace wipes config
146 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
147 transactionProvider.wipeTransaction();
150 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
152 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
153 setServicesOnTransaction(ta, editConfigExecution);
154 setOnTransaction(ta, editConfigExecution);
157 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
159 Services services = execution.getServices();
161 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
162 .getNamespaceToServiceNameToRefNameToInstance();
164 for (String serviceNamespace : namespaceToServiceNameToRefNameToInstance.keySet()) {
165 for (String serviceName : namespaceToServiceNameToRefNameToInstance.get(serviceNamespace).keySet()) {
167 String qnameOfService = getQname(ta, serviceNamespace, serviceName);
168 Map<String, Services.ServiceInstance> refNameToInstance = namespaceToServiceNameToRefNameToInstance
169 .get(serviceNamespace).get(serviceName);
171 for (String refName : refNameToInstance.keySet()) {
172 ObjectName on = refNameToInstance.get(refName).getObjectName(ta.getTransactionName());
174 ObjectName saved = ta.saveServiceReference(qnameOfService, refName, on);
175 logger.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
177 } catch (InstanceNotFoundException e) {
178 throw new IllegalStateException("Unable to save ref name " + refName + " for instance " + on, e);
185 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
186 return ta.getServiceInterfaceName(namespace, serviceName);
189 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
191 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
193 for (Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
194 String moduleName = moduleToResolved.getKey();
196 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
197 String instanceName = moduleElementResolved.getInstanceName();
199 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
200 EditConfigStrategy strategy = ice.getEditStrategy();
201 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
206 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
207 EditConfigExecution execution) {
209 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
210 for (Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
211 String moduleName = moduleToResolved.getKey();
213 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
215 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
216 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
221 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
222 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
223 yangStoreSnapshot.getModuleMXBeanEntryMap());
224 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
225 return new Config(factories, identitiesMap);
229 public static class IdentityMapping {
230 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
233 this.identityNameToSchemaNode = Maps.newHashMap();
236 void addIdSchemaNode(IdentitySchemaNode node) {
237 String name = node.getQName().getLocalName();
238 Preconditions.checkState(identityNameToSchemaNode.containsKey(name) == false);
239 identityNameToSchemaNode.put(name, node);
242 public boolean containsIdName(String idName) {
243 return identityNameToSchemaNode.containsKey(idName);
246 // FIXME method never used
247 public IdentitySchemaNode getIdentitySchemaNode(String idName) {
248 Preconditions.checkState(identityNameToSchemaNode.containsKey(idName), "No identity under name %s", idName);
249 return identityNameToSchemaNode.get(idName);
253 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
254 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
255 for (Module module : modules) {
256 String namespace = module.getNamespace().toString();
257 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
258 if(revisionsByNamespace == null) {
259 revisionsByNamespace = Maps.newHashMap();
260 mappedIds.put(namespace, revisionsByNamespace);
263 Date revision = module.getRevision();
264 Preconditions.checkState(revisionsByNamespace.containsKey(revision) == false,
265 "Duplicate revision %s for namespace %s", revision, namespace);
267 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
268 if(identityMapping == null) {
269 identityMapping = new IdentityMapping();
270 revisionsByNamespace.put(revision, identityMapping);
273 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
274 identityMapping.addIdSchemaNode(identitySchemaNode);
282 public static Map<String/* Namespace from yang file */,
283 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
284 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
285 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
287 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
289 for (String namespace : mBeanEntries.keySet()) {
290 for (Entry<String, ModuleMXBeanEntry> moduleNameToMbe : mBeanEntries.get(namespace).entrySet()) {
291 String moduleName = moduleNameToMbe.getKey();
292 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
294 ModuleConfig moduleConfig = new ModuleConfig(moduleName, new InstanceConfig(configRegistryClient,
295 moduleMXBeanEntry.getAttributes()), moduleMXBeanEntry
296 .getProvidedServices().values());
298 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespace);
299 if(moduleNameToModuleConfig == null) {
300 moduleNameToModuleConfig = Maps.newHashMap();
301 namespaceToModuleNameToModuleConfig.put(namespace, moduleNameToModuleConfig);
304 moduleNameToModuleConfig.put(moduleName, moduleConfig);
308 return namespaceToModuleNameToModuleConfig;
312 protected String getOperationName() {
313 return EditConfigXmlParser.EDIT_CONFIG;
317 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
319 EditConfigXmlParser.EditConfigExecution editConfigExecution;
320 Config cfg = getConfigMapping(configRegistryClient, yangStoreSnapshot);
322 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, configRegistryClient);
323 } catch (IllegalStateException e) {
324 logger.warn("Error parsing xml", e);
325 final Map<String, String> errorInfo = new HashMap<>();
326 errorInfo.put(ErrorTag.missing_attribute.name(), "Error parsing xml: " + e.getMessage());
327 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.missing_attribute,
328 ErrorSeverity.error, errorInfo);
329 } catch (final IllegalArgumentException e) {
330 logger.warn("Error parsing xml", e);
331 final Map<String, String> errorInfo = new HashMap<>();
332 errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
333 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.bad_attribute,
334 ErrorSeverity.error, errorInfo);
335 } catch (final UnsupportedOperationException e) {
336 logger.warn("Unsupported", e);
337 final Map<String, String> errorInfo = new HashMap<>();
338 errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'edit-config'");
339 throw new NetconfDocumentedException(e.getMessage(), ErrorType.application,
340 ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
343 return getResponseInternal(document, editConfigExecution);