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.config.yangjmxgenerator.ModuleMXBeanEntry;
24 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
25 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
26 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
27 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
29 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
30 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
31 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
32 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
33 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
34 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
35 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
36 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
37 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot;
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.controller.netconf.util.xml.XmlUtil;
42 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.Module;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import org.w3c.dom.Document;
47 import org.w3c.dom.Element;
49 import com.google.common.annotations.VisibleForTesting;
50 import com.google.common.base.Optional;
51 import com.google.common.base.Preconditions;
52 import com.google.common.collect.Maps;
53 import com.google.common.collect.Multimap;
55 public class EditConfig extends AbstractConfigNetconfOperation {
57 private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
59 private final YangStoreSnapshot yangStoreSnapshot;
61 private final TransactionProvider transactionProvider;
62 private EditConfigXmlParser editConfigXmlParser;
64 public EditConfig(YangStoreSnapshot yangStoreSnapshot, TransactionProvider transactionProvider,
65 ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
66 super(configRegistryClient, netconfSessionIdForReporting);
67 this.yangStoreSnapshot = yangStoreSnapshot;
68 this.transactionProvider = transactionProvider;
69 this.editConfigXmlParser = new EditConfigXmlParser();
73 Element getResponseInternal(final Document document,
74 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
76 if (editConfigExecution.shouldTest()) {
77 executeTests(configRegistryClient, editConfigExecution);
80 if (editConfigExecution.shouldSet()) {
81 executeSet(configRegistryClient, editConfigExecution);
84 logger.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
86 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
89 private void executeSet(ConfigRegistryClient configRegistryClient,
90 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
92 set(configRegistryClient, editConfigExecution);
94 } catch (IllegalStateException e) {
95 //FIXME: when can IllegalStateException be thrown?
96 // JmxAttributeValidationException is wrapped in DynamicWritableWrapper with ValidationException
97 // ValidationException is not thrown until validate or commit is issued
98 logger.warn("Set phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
99 final Map<String, String> errorInfo = new HashMap<>();
100 errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
101 throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
102 ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
104 logger.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
107 private void executeTests(ConfigRegistryClient configRegistryClient,
108 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
110 test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
111 } catch (IllegalStateException | ValidationException e) {
112 //FIXME: when can IllegalStateException be thrown?
113 logger.warn("Test phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
114 final Map<String, String> errorInfo = new HashMap<>();
115 errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
116 throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
117 ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
119 logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
122 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
123 EditStrategyType editStrategyType) throws ValidationException {
124 ObjectName taON = transactionProvider.getTestTransaction();
127 // default strategy = replace wipes config
128 if (editStrategyType == EditStrategyType.replace) {
129 transactionProvider.wipeTestTransaction(taON);
132 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
134 handleMisssingInstancesOnTransaction(ta, execution);
135 setServicesOnTransaction(ta, execution);
136 setOnTransaction(ta, execution);
137 transactionProvider.validateTestTransaction(taON);
139 transactionProvider.abortTestTransaction(taON);
143 private void set(ConfigRegistryClient configRegistryClient,
144 EditConfigXmlParser.EditConfigExecution editConfigExecution) {
145 ObjectName taON = transactionProvider.getOrCreateTransaction();
147 // default strategy = replace wipes config
148 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
149 transactionProvider.wipeTransaction();
152 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
154 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
155 setServicesOnTransaction(ta, editConfigExecution);
156 setOnTransaction(ta, editConfigExecution);
159 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
161 Services services = execution.getServices();
163 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
164 .getNamespaceToServiceNameToRefNameToInstance();
166 for (String serviceNamespace : namespaceToServiceNameToRefNameToInstance.keySet()) {
167 for (String serviceName : namespaceToServiceNameToRefNameToInstance.get(serviceNamespace).keySet()) {
169 String qnameOfService = getQname(ta, serviceNamespace, serviceName);
170 Map<String, Services.ServiceInstance> refNameToInstance = namespaceToServiceNameToRefNameToInstance
171 .get(serviceNamespace).get(serviceName);
173 for (String refName : refNameToInstance.keySet()) {
174 ObjectName on = refNameToInstance.get(refName).getObjectName(ta.getTransactionName());
176 ObjectName saved = ta.saveServiceReference(qnameOfService, refName, on);
177 logger.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
179 } catch (InstanceNotFoundException e) {
180 throw new IllegalStateException("Unable to save ref name " + refName + " for instance " + on, e);
187 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
188 return ta.getServiceInterfaceName(namespace, serviceName);
191 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) {
193 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
195 for (Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
196 String moduleName = moduleToResolved.getKey();
198 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
199 String instanceName = moduleElementResolved.getInstanceName();
201 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
202 EditConfigStrategy strategy = ice.getEditStrategy();
203 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
208 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
209 EditConfigExecution execution) {
211 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
212 for (Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
213 String moduleName = moduleToResolved.getKey();
215 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
217 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
218 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
223 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
224 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
225 yangStoreSnapshot.getModuleMXBeanEntryMap());
226 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
227 return new Config(factories, identitiesMap);
231 public static class IdentityMapping {
232 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
235 this.identityNameToSchemaNode = Maps.newHashMap();
238 void addIdSchemaNode(IdentitySchemaNode node) {
239 String name = node.getQName().getLocalName();
240 Preconditions.checkState(identityNameToSchemaNode.containsKey(name) == false);
241 identityNameToSchemaNode.put(name, node);
244 public boolean containsIdName(String idName) {
245 return identityNameToSchemaNode.containsKey(idName);
248 // FIXME method never used
249 public IdentitySchemaNode getIdentitySchemaNode(String idName) {
250 Preconditions.checkState(identityNameToSchemaNode.containsKey(idName), "No identity under name %s", idName);
251 return identityNameToSchemaNode.get(idName);
255 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
256 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
257 for (Module module : modules) {
258 String namespace = module.getNamespace().toString();
259 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
260 if(revisionsByNamespace == null) {
261 revisionsByNamespace = Maps.newHashMap();
262 mappedIds.put(namespace, revisionsByNamespace);
265 Date revision = module.getRevision();
266 Preconditions.checkState(revisionsByNamespace.containsKey(revision) == false,
267 "Duplicate revision %s for namespace %s", revision, namespace);
269 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
270 if(identityMapping == null) {
271 identityMapping = new IdentityMapping();
272 revisionsByNamespace.put(revision, identityMapping);
275 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
276 identityMapping.addIdSchemaNode(identitySchemaNode);
284 public static Map<String/* Namespace from yang file */,
285 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
286 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
287 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
289 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
291 for (String namespace : mBeanEntries.keySet()) {
292 for (Entry<String, ModuleMXBeanEntry> moduleNameToMbe : mBeanEntries.get(namespace).entrySet()) {
293 String moduleName = moduleNameToMbe.getKey();
294 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
296 ModuleConfig moduleConfig = new ModuleConfig(moduleName, new InstanceConfig(configRegistryClient,
297 moduleMXBeanEntry.getAttributes()), moduleMXBeanEntry
298 .getProvidedServices().values());
300 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespace);
301 if(moduleNameToModuleConfig == null) {
302 moduleNameToModuleConfig = Maps.newHashMap();
303 namespaceToModuleNameToModuleConfig.put(namespace, moduleNameToModuleConfig);
306 moduleNameToModuleConfig.put(moduleName, moduleConfig);
310 return namespaceToModuleNameToModuleConfig;
314 protected String getOperationName() {
315 return EditConfigXmlParser.EDIT_CONFIG;
319 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
321 EditConfigXmlParser.EditConfigExecution editConfigExecution;
322 Config cfg = getConfigMapping(configRegistryClient, yangStoreSnapshot);
324 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, configRegistryClient);
325 } catch (IllegalStateException e) {
326 logger.warn("Error parsing xml", e);
327 final Map<String, String> errorInfo = new HashMap<>();
328 errorInfo.put(ErrorTag.missing_attribute.name(), "Error parsing xml: " + e.getMessage());
329 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.missing_attribute,
330 ErrorSeverity.error, errorInfo);
331 } catch (final IllegalArgumentException e) {
332 logger.warn("Error parsing xml", e);
333 final Map<String, String> errorInfo = new HashMap<>();
334 errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
335 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.bad_attribute,
336 ErrorSeverity.error, errorInfo);
337 } catch (final UnsupportedOperationException e) {
338 logger.warn("Unsupported", e);
339 final Map<String, String> errorInfo = new HashMap<>();
340 errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'edit-config'");
341 throw new NetconfDocumentedException(e.getMessage(), ErrorType.application,
342 ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
345 return getResponseInternal(document, editConfigExecution);