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.BeanReader;
24 import org.opendaylight.controller.config.util.ConfigRegistryClient;
25 import org.opendaylight.controller.config.util.ConfigTransactionClient;
26 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
27 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
28 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
29 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
30 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
31 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
32 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
33 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
34 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
35 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
36 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
37 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
38 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
39 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
40 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
41 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreContext;
42 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
43 import org.opendaylight.controller.netconf.util.xml.XmlElement;
44 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
45 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.Module;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
49 import org.w3c.dom.Document;
50 import org.w3c.dom.Element;
52 public class EditConfig extends AbstractConfigNetconfOperation {
54 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
56 private final YangStoreContext yangStoreSnapshot;
58 private final TransactionProvider transactionProvider;
59 private EditConfigXmlParser editConfigXmlParser;
61 public EditConfig(YangStoreContext yangStoreSnapshot, TransactionProvider transactionProvider,
62 ConfigRegistryClient configRegistryClient, String netconfSessionIdForReporting) {
63 super(configRegistryClient, netconfSessionIdForReporting);
64 this.yangStoreSnapshot = yangStoreSnapshot;
65 this.transactionProvider = transactionProvider;
66 this.editConfigXmlParser = new EditConfigXmlParser();
70 Element getResponseInternal(final Document document,
71 final EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
73 if (editConfigExecution.shouldTest()) {
74 executeTests(getConfigRegistryClient(), editConfigExecution);
77 if (editConfigExecution.shouldSet()) {
78 executeSet(getConfigRegistryClient(), editConfigExecution);
81 LOG.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
83 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
86 private void executeSet(ConfigRegistryClient configRegistryClient,
87 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
88 set(configRegistryClient, editConfigExecution);
89 LOG.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
92 private void executeTests(ConfigRegistryClient configRegistryClient,
93 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
95 test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
96 } catch (final ValidationException e) {
97 LOG.warn("Test phase for {} failed", EditConfigXmlParser.EDIT_CONFIG, e);
98 final Map<String, String> errorInfo = new HashMap<>();
99 errorInfo.put(ErrorTag.operation_failed.name(), e.getMessage());
100 throw new NetconfDocumentedException("Test phase: " + e.getMessage(), e, ErrorType.application,
101 ErrorTag.operation_failed, ErrorSeverity.error, errorInfo);
103 LOG.debug("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
106 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
107 EditStrategyType editStrategyType) throws ValidationException, NetconfDocumentedException {
108 ObjectName taON = transactionProvider.getTestTransaction();
110 // default strategy = replace wipes config
111 if (editStrategyType == EditStrategyType.replace) {
112 transactionProvider.wipeTestTransaction(taON);
115 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
117 handleMisssingInstancesOnTransaction(ta, execution);
118 setServicesOnTransaction(ta, execution);
119 setOnTransaction(ta, execution);
120 transactionProvider.validateTestTransaction(taON);
122 transactionProvider.abortTestTransaction(taON);
126 private void set(ConfigRegistryClient configRegistryClient,
127 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
128 ObjectName taON = transactionProvider.getOrCreateTransaction();
130 // default strategy = replace wipes config
131 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
132 transactionProvider.wipeTransaction();
135 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
137 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
138 setServicesOnTransaction(ta, editConfigExecution);
139 setOnTransaction(ta, editConfigExecution);
142 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
144 Services services = execution.getServices();
146 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
147 .getNamespaceToServiceNameToRefNameToInstance();
149 for (Map.Entry<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceToRefEntry : namespaceToServiceNameToRefNameToInstance.entrySet()) {
150 for (Map.Entry<String, Map<String, Services.ServiceInstance>> serviceToRefEntry : namespaceToServiceToRefEntry.getValue().entrySet()) {
152 String qnameOfService = getQname(ta, namespaceToServiceToRefEntry.getKey(), serviceToRefEntry.getKey());
153 Map<String, Services.ServiceInstance> refNameToInstance = serviceToRefEntry.getValue();
155 for (Map.Entry<String, Services.ServiceInstance> refNameToServiceEntry : refNameToInstance.entrySet()) {
156 ObjectName on = refNameToServiceEntry.getValue().getObjectName(ta.getTransactionName());
158 ObjectName saved = ta.saveServiceReference(qnameOfService, refNameToServiceEntry.getKey(), on);
159 LOG.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
160 on, refNameToServiceEntry.getKey(), saved);
161 } catch (InstanceNotFoundException e) {
162 throw new NetconfDocumentedException(String.format("Unable to save ref name " + refNameToServiceEntry.getKey() + " for instance " + on, e),
163 ErrorType.application,
164 ErrorTag.operation_failed,
165 ErrorSeverity.error);
172 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
173 return ta.getServiceInterfaceName(namespace, serviceName);
176 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
178 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
180 for (Map.Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
181 String moduleName = moduleToResolved.getKey();
183 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
184 String instanceName = moduleElementResolved.getInstanceName();
186 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
187 EditConfigStrategy strategy = ice.getEditStrategy();
188 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
193 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
194 EditConfigExecution execution) throws NetconfDocumentedException {
196 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
197 for (Map.Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
198 String moduleName = moduleToResolved.getKey();
200 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
202 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
203 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
208 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreContext yangStoreSnapshot) {
209 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
210 yangStoreSnapshot.getModuleMXBeanEntryMap());
211 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
212 return new Config(factories, identitiesMap);
216 public static class IdentityMapping {
217 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
220 this.identityNameToSchemaNode = Maps.newHashMap();
223 void addIdSchemaNode(IdentitySchemaNode node) {
224 String name = node.getQName().getLocalName();
225 Preconditions.checkState(!identityNameToSchemaNode.containsKey(name));
226 identityNameToSchemaNode.put(name, node);
229 public boolean containsIdName(String idName) {
230 return identityNameToSchemaNode.containsKey(idName);
235 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
236 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
237 for (Module module : modules) {
238 String namespace = module.getNamespace().toString();
239 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
240 if(revisionsByNamespace == null) {
241 revisionsByNamespace = Maps.newHashMap();
242 mappedIds.put(namespace, revisionsByNamespace);
245 Date revision = module.getRevision();
246 Preconditions.checkState(!revisionsByNamespace.containsKey(revision),
247 "Duplicate revision %s for namespace %s", revision, namespace);
249 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
250 if(identityMapping == null) {
251 identityMapping = new IdentityMapping();
252 revisionsByNamespace.put(revision, identityMapping);
255 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
256 identityMapping.addIdSchemaNode(identitySchemaNode);
264 public static Map<String/* Namespace from yang file */,
265 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
266 (final BeanReader configRegistryClient, Map<String/* Namespace from yang file */,
267 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
269 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
271 for (Map.Entry<String, Map<String, ModuleMXBeanEntry>> namespaceToModuleToMbe : mBeanEntries.entrySet()) {
272 for (Map.Entry<String, ModuleMXBeanEntry> moduleNameToMbe : namespaceToModuleToMbe.getValue().entrySet()) {
273 String moduleName = moduleNameToMbe.getKey();
274 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
276 ModuleConfig moduleConfig = new ModuleConfig(moduleName,
277 new InstanceConfig(configRegistryClient,moduleMXBeanEntry.getAttributes(), moduleMXBeanEntry.getNullableDummyContainerName()));
279 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespaceToModuleToMbe.getKey());
280 if(moduleNameToModuleConfig == null) {
281 moduleNameToModuleConfig = Maps.newHashMap();
282 namespaceToModuleNameToModuleConfig.put(namespaceToModuleToMbe.getKey(), moduleNameToModuleConfig);
285 moduleNameToModuleConfig.put(moduleName, moduleConfig);
289 return namespaceToModuleNameToModuleConfig;
293 protected String getOperationName() {
294 return EditConfigXmlParser.EDIT_CONFIG;
298 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;