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.collect.Maps;
13 import com.google.common.collect.Multimap;
14 import org.opendaylight.controller.config.api.JmxAttributeValidationException;
15 import org.opendaylight.controller.config.api.ValidationException;
16 import org.opendaylight.controller.config.util.ConfigRegistryClient;
17 import org.opendaylight.controller.config.util.ConfigTransactionClient;
18 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
19 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
21 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
22 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
23 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
24 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
25 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
26 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
27 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
29 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
30 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
31 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
32 import org.opendaylight.controller.netconf.util.xml.XmlElement;
33 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36 import org.w3c.dom.Document;
37 import org.w3c.dom.Element;
39 import javax.management.ObjectName;
40 import java.util.HashMap;
42 import java.util.Map.Entry;
44 public class EditConfig extends AbstractConfigNetconfOperation {
46 private static final Logger logger = LoggerFactory.getLogger(EditConfig.class);
48 private final YangStoreSnapshot yangStoreSnapshot;
50 private final TransactionProvider transactionProvider;
51 private EditConfigXmlParser editConfigXmlParser;
53 public EditConfig(YangStoreSnapshot yangStoreSnapshot, TransactionProvider transactionProvider,
54 ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
55 super(configRegistryClient, netconfSessionIdForReporting);
56 this.yangStoreSnapshot = yangStoreSnapshot;
57 this.transactionProvider = transactionProvider;
58 this.editConfigXmlParser = new EditConfigXmlParser();
62 Element getResponseInternal(final Document document,
63 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
64 if (editConfigExecution.shouldTest()) {
65 executeTests(configRegistryClient, editConfigExecution);
68 if (editConfigExecution.shouldSet()) {
69 executeSet(configRegistryClient, editConfigExecution);
72 logger.info("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
74 return document.createElement(XmlNetconfConstants.OK);
77 private void executeSet(ConfigRegistryClient configRegistryClient,
78 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
80 set(configRegistryClient, editConfigExecution);
81 } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
82 logger.warn("Set phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
83 final Map<String, String> errorInfo = new HashMap<>();
84 errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
85 throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
86 ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
88 logger.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
91 private void executeTests(ConfigRegistryClient configRegistryClient,
92 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
94 test(configRegistryClient, editConfigExecution.getResolvedXmlElements(), editConfigExecution.getDefaultStrategy());
95 } catch (IllegalStateException | JmxAttributeValidationException | ValidationException e) {
96 logger.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 logger.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
105 private void test(ConfigRegistryClient configRegistryClient,
106 Map<String, Multimap<String, ModuleElementResolved>> resolvedModules, EditStrategyType editStrategyType) {
107 ObjectName taON = transactionProvider.getTestTransaction();
110 // default strategy = replace wipes config
111 if (editStrategyType == EditStrategyType.replace) {
112 transactionProvider.wipeTestTransaction(taON);
114 setOnTransaction(configRegistryClient, resolvedModules, taON);
115 transactionProvider.validateTestTransaction(taON);
117 transactionProvider.abortTestTransaction(taON);
121 private void set(ConfigRegistryClient configRegistryClient,
122 EditConfigXmlParser.EditConfigExecution editConfigExecution) {
123 ObjectName taON = transactionProvider.getOrCreateTransaction();
125 // default strategy = replace wipes config
126 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
127 transactionProvider.wipeTransaction();
129 setOnTransaction(configRegistryClient, editConfigExecution.getResolvedXmlElements(), taON);
132 private void setOnTransaction(ConfigRegistryClient configRegistryClient,
133 Map<String, Multimap<String, ModuleElementResolved>> resolvedXmlElements, ObjectName taON) {
134 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
136 for (Multimap<String, ModuleElementResolved> modulesToResolved : resolvedXmlElements.values()) {
137 for (Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
138 String moduleName = moduleToResolved.getKey();
140 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
141 String instanceName = moduleElementResolved.getInstanceName();
143 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
144 EditConfigStrategy strategy = ice.getEditStrategy();
145 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta);
150 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient,
151 Map<String/* Namespace from yang file */,
152 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
153 Map<String, Map<String, ModuleConfig>> factories = transform(configRegistryClient, mBeanEntries);
154 return new Config(factories);
158 private static Map<String/* Namespace from yang file */,
159 Map<String /* Name of module entry from yang file */, ModuleConfig>> transform
160 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
161 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
162 return Maps.transformEntries(mBeanEntries,
163 new Maps.EntryTransformer<String, Map<String, ModuleMXBeanEntry>, Map<String, ModuleConfig>>() {
166 public Map<String, ModuleConfig> transformEntry(String arg0, Map<String, ModuleMXBeanEntry> arg1) {
167 return Maps.transformEntries(arg1,
168 new Maps.EntryTransformer<String, ModuleMXBeanEntry, ModuleConfig>() {
171 public ModuleConfig transformEntry(String key, ModuleMXBeanEntry moduleMXBeanEntry) {
172 return new ModuleConfig(key, new InstanceConfig(configRegistryClient, moduleMXBeanEntry
173 .getAttributes()), moduleMXBeanEntry.getProvidedServices().values());
181 protected String getOperationName() {
182 return EditConfigXmlParser.EDIT_CONFIG;
186 protected Element handle(Document document, XmlElement xml) throws NetconfDocumentedException {
188 EditConfigXmlParser.EditConfigExecution editConfigExecution;
189 Config cfg = getConfigMapping(configRegistryClient, yangStoreSnapshot.getModuleMXBeanEntryMap());
191 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, configRegistryClient);
192 } catch (IllegalStateException e) {
193 logger.warn("Error parsing xml", e);
194 final Map<String, String> errorInfo = new HashMap<>();
195 errorInfo.put(ErrorTag.missing_attribute.name(), "Missing value for 'target' attribute");
196 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.missing_attribute,
197 ErrorSeverity.error, errorInfo);
198 } catch (final IllegalArgumentException e) {
199 logger.warn("Error parsing xml", e);
200 final Map<String, String> errorInfo = new HashMap<>();
201 errorInfo.put(ErrorTag.bad_attribute.name(), e.getMessage());
202 throw new NetconfDocumentedException(e.getMessage(), ErrorType.rpc, ErrorTag.bad_attribute,
203 ErrorSeverity.error, errorInfo);
204 } catch (final UnsupportedOperationException e) {
205 logger.warn("Unsupported", e);
206 final Map<String, String> errorInfo = new HashMap<>();
207 errorInfo.put(ErrorTag.operation_not_supported.name(), "Unsupported option for 'edit-config'");
208 throw new NetconfDocumentedException(e.getMessage(), ErrorType.application,
209 ErrorTag.operation_not_supported, ErrorSeverity.error, errorInfo);
212 return getResponseInternal(document, editConfigExecution);