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 org.opendaylight.controller.config.api.ValidationException;
17 import org.opendaylight.controller.config.util.ConfigRegistryClient;
18 import org.opendaylight.controller.config.util.ConfigTransactionClient;
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.exception.NetconfConfigHandlingException;
25 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Config;
26 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfig;
27 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.InstanceConfigElementResolved;
28 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleConfig;
29 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementDefinition;
30 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.ModuleElementResolved;
31 import org.opendaylight.controller.netconf.confignetconfconnector.mapping.config.Services;
32 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
33 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
34 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreSnapshot;
35 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
36 import org.opendaylight.controller.netconf.util.xml.XmlElement;
37 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
38 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
39 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.Module;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.w3c.dom.Document;
44 import org.w3c.dom.Element;
46 import javax.management.InstanceNotFoundException;
47 import javax.management.ObjectName;
48 import java.util.Date;
49 import java.util.HashMap;
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, NetconfConfigHandlingException {
74 if (editConfigExecution.shouldTest()) {
75 executeTests(getConfigRegistryClient(), editConfigExecution);
78 if (editConfigExecution.shouldSet()) {
79 executeSet(getConfigRegistryClient(), editConfigExecution);
82 logger.trace("Operation {} successful", EditConfigXmlParser.EDIT_CONFIG);
84 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
87 private void executeSet(ConfigRegistryClient configRegistryClient,
88 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
89 set(configRegistryClient, editConfigExecution);
90 logger.debug("Set phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
93 private void executeTests(ConfigRegistryClient configRegistryClient,
94 EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
96 test(configRegistryClient, editConfigExecution, editConfigExecution.getDefaultStrategy());
97 } catch (final ValidationException e) {
98 logger.warn("Test 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("Test phase for {} operation successful", EditConfigXmlParser.EDIT_CONFIG);
107 private void test(ConfigRegistryClient configRegistryClient, EditConfigExecution execution,
108 EditStrategyType editStrategyType) throws ValidationException, NetconfDocumentedException {
109 ObjectName taON = transactionProvider.getTestTransaction();
111 // default strategy = replace wipes config
112 if (editStrategyType == EditStrategyType.replace) {
113 transactionProvider.wipeTestTransaction(taON);
116 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
118 handleMisssingInstancesOnTransaction(ta, execution);
119 setServicesOnTransaction(ta, execution);
120 setOnTransaction(ta, execution);
121 transactionProvider.validateTestTransaction(taON);
123 transactionProvider.abortTestTransaction(taON);
127 private void set(ConfigRegistryClient configRegistryClient,
128 EditConfigXmlParser.EditConfigExecution editConfigExecution) throws NetconfDocumentedException {
129 ObjectName taON = transactionProvider.getOrCreateTransaction();
131 // default strategy = replace wipes config
132 if (editConfigExecution.getDefaultStrategy() == EditStrategyType.replace) {
133 transactionProvider.wipeTransaction();
136 ConfigTransactionClient ta = configRegistryClient.getConfigTransactionClient(taON);
138 handleMisssingInstancesOnTransaction(ta, editConfigExecution);
139 setServicesOnTransaction(ta, editConfigExecution);
140 setOnTransaction(ta, editConfigExecution);
143 private void setServicesOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
145 Services services = execution.getServices();
147 Map<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceNameToRefNameToInstance = services
148 .getNamespaceToServiceNameToRefNameToInstance();
150 for (String serviceNamespace : namespaceToServiceNameToRefNameToInstance.keySet()) {
151 for (String serviceName : namespaceToServiceNameToRefNameToInstance.get(serviceNamespace).keySet()) {
153 String qnameOfService = getQname(ta, serviceNamespace, serviceName);
154 Map<String, Services.ServiceInstance> refNameToInstance = namespaceToServiceNameToRefNameToInstance
155 .get(serviceNamespace).get(serviceName);
157 for (String refName : refNameToInstance.keySet()) {
158 ObjectName on = refNameToInstance.get(refName).getObjectName(ta.getTransactionName());
160 ObjectName saved = ta.saveServiceReference(qnameOfService, refName, on);
161 logger.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
163 } catch (InstanceNotFoundException e) {
164 throw new NetconfDocumentedException(String.format("Unable to save ref name " + refName + " for instance " + on, e),
165 ErrorType.application,
166 ErrorTag.operation_failed,
167 ErrorSeverity.error);
174 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
175 return ta.getServiceInterfaceName(namespace, serviceName);
178 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
180 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
182 for (Map.Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
183 String moduleName = moduleToResolved.getKey();
185 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
186 String instanceName = moduleElementResolved.getInstanceName();
188 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
189 EditConfigStrategy strategy = ice.getEditStrategy();
190 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
195 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
196 EditConfigExecution execution) throws NetconfDocumentedException {
198 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
199 for (Map.Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
200 String moduleName = moduleToResolved.getKey();
202 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
204 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
205 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
210 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreSnapshot yangStoreSnapshot) {
211 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
212 yangStoreSnapshot.getModuleMXBeanEntryMap());
213 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
214 return new Config(factories, identitiesMap);
218 public static class IdentityMapping {
219 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
222 this.identityNameToSchemaNode = Maps.newHashMap();
225 void addIdSchemaNode(IdentitySchemaNode node) {
226 String name = node.getQName().getLocalName();
227 Preconditions.checkState(!identityNameToSchemaNode.containsKey(name));
228 identityNameToSchemaNode.put(name, node);
231 public boolean containsIdName(String idName) {
232 return identityNameToSchemaNode.containsKey(idName);
235 // FIXME method never used
236 public IdentitySchemaNode getIdentitySchemaNode(String idName) {
237 Preconditions.checkState(identityNameToSchemaNode.containsKey(idName), "No identity under name %s", idName);
238 return identityNameToSchemaNode.get(idName);
242 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
243 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
244 for (Module module : modules) {
245 String namespace = module.getNamespace().toString();
246 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
247 if(revisionsByNamespace == null) {
248 revisionsByNamespace = Maps.newHashMap();
249 mappedIds.put(namespace, revisionsByNamespace);
252 Date revision = module.getRevision();
253 Preconditions.checkState(!revisionsByNamespace.containsKey(revision),
254 "Duplicate revision %s for namespace %s", revision, namespace);
256 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
257 if(identityMapping == null) {
258 identityMapping = new IdentityMapping();
259 revisionsByNamespace.put(revision, identityMapping);
262 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
263 identityMapping.addIdSchemaNode(identitySchemaNode);
271 public static Map<String/* Namespace from yang file */,
272 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
273 (final ConfigRegistryClient configRegistryClient, Map<String/* Namespace from yang file */,
274 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
276 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
278 for (String namespace : mBeanEntries.keySet()) {
279 for (Map.Entry<String, ModuleMXBeanEntry> moduleNameToMbe : mBeanEntries.get(namespace).entrySet()) {
280 String moduleName = moduleNameToMbe.getKey();
281 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
283 ModuleConfig moduleConfig = new ModuleConfig(moduleName, new InstanceConfig(configRegistryClient,
284 moduleMXBeanEntry.getAttributes()), moduleMXBeanEntry
285 .getProvidedServices().values());
287 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespace);
288 if(moduleNameToModuleConfig == null) {
289 moduleNameToModuleConfig = Maps.newHashMap();
290 namespaceToModuleNameToModuleConfig.put(namespace, moduleNameToModuleConfig);
293 moduleNameToModuleConfig.put(moduleName, moduleConfig);
297 return namespaceToModuleNameToModuleConfig;
301 protected String getOperationName() {
302 return EditConfigXmlParser.EDIT_CONFIG;
306 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
308 EditConfigXmlParser.EditConfigExecution editConfigExecution;
309 Config cfg = getConfigMapping(getConfigRegistryClient(), yangStoreSnapshot);
310 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg, transactionProvider, getConfigRegistryClient());
312 Element responseInternal;
313 responseInternal = getResponseInternal(document, editConfigExecution);
314 return responseInternal;