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.mapping.config.Services.ServiceInstance;
40 import org.opendaylight.controller.netconf.confignetconfconnector.operations.AbstractConfigNetconfOperation;
41 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfigXmlParser.EditConfigExecution;
42 import org.opendaylight.controller.netconf.confignetconfconnector.osgi.YangStoreContext;
43 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
44 import org.opendaylight.controller.netconf.util.xml.XmlElement;
45 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
46 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.Module;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
50 import org.w3c.dom.Document;
51 import org.w3c.dom.Element;
53 public class EditConfig extends AbstractConfigNetconfOperation {
55 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
57 private final YangStoreContext yangStoreSnapshot;
59 private final TransactionProvider transactionProvider;
60 private EditConfigXmlParser editConfigXmlParser;
62 public EditConfig(YangStoreContext 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(getConfigRegistryClient(), editConfigExecution);
78 if (editConfigExecution.shouldSet()) {
79 executeSet(getConfigRegistryClient(), editConfigExecution);
82 LOG.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 LOG.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 LOG.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 LOG.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 (Map.Entry<String, Map<String, Map<String, Services.ServiceInstance>>> namespaceToServiceToRefEntry : namespaceToServiceNameToRefNameToInstance.entrySet()) {
151 for (Map.Entry<String, Map<String, Services.ServiceInstance>> serviceToRefEntry : namespaceToServiceToRefEntry.getValue().entrySet()) {
153 String qnameOfService = getQname(ta, namespaceToServiceToRefEntry.getKey(), serviceToRefEntry.getKey());
154 Map<String, Services.ServiceInstance> refNameToInstance = serviceToRefEntry.getValue();
156 for (Map.Entry<String, Services.ServiceInstance> refNameToServiceEntry : refNameToInstance.entrySet()) {
157 ObjectName on = refNameToServiceEntry.getValue().getObjectName(ta.getTransactionName());
159 if (ServiceInstance.EMPTY_SERVICE_INSTANCE == refNameToServiceEntry.getValue()) {
160 ta.removeServiceReference(qnameOfService, refNameToServiceEntry.getKey());
161 LOG.debug("Removing service {} with name {}", qnameOfService, refNameToServiceEntry.getKey());
163 ObjectName saved = ta.saveServiceReference(qnameOfService, refNameToServiceEntry.getKey(), on);
164 LOG.debug("Saving service {} with on {} under name {} with service on {}", qnameOfService,
165 on, refNameToServiceEntry.getKey(), saved);
167 } catch (InstanceNotFoundException e) {
168 throw new NetconfDocumentedException(String.format("Unable to edit ref name " + refNameToServiceEntry.getKey() + " for instance " + on, e),
169 ErrorType.application,
170 ErrorTag.operation_failed,
171 ErrorSeverity.error);
178 private String getQname(ConfigTransactionClient ta, String namespace, String serviceName) {
179 return ta.getServiceInterfaceName(namespace, serviceName);
182 private void setOnTransaction(ConfigTransactionClient ta, EditConfigExecution execution) throws NetconfDocumentedException {
184 for (Multimap<String, ModuleElementResolved> modulesToResolved : execution.getResolvedXmlElements(ta).values()) {
186 for (Map.Entry<String, ModuleElementResolved> moduleToResolved : modulesToResolved.entries()) {
187 String moduleName = moduleToResolved.getKey();
189 ModuleElementResolved moduleElementResolved = moduleToResolved.getValue();
190 String instanceName = moduleElementResolved.getInstanceName();
192 InstanceConfigElementResolved ice = moduleElementResolved.getInstanceConfigElementResolved();
193 EditConfigStrategy strategy = ice.getEditStrategy();
194 strategy.executeConfiguration(moduleName, instanceName, ice.getConfiguration(), ta, execution.getServiceRegistryWrapper(ta));
199 private void handleMisssingInstancesOnTransaction(ConfigTransactionClient ta,
200 EditConfigExecution execution) throws NetconfDocumentedException {
202 for (Multimap<String,ModuleElementDefinition> modulesToResolved : execution.getModulesDefinition(ta).values()) {
203 for (Map.Entry<String, ModuleElementDefinition> moduleToResolved : modulesToResolved.entries()) {
204 String moduleName = moduleToResolved.getKey();
206 ModuleElementDefinition moduleElementDefinition = moduleToResolved.getValue();
208 EditConfigStrategy strategy = moduleElementDefinition.getEditStrategy();
209 strategy.executeConfiguration(moduleName, moduleElementDefinition.getInstanceName(), null, ta, execution.getServiceRegistryWrapper(ta));
214 public static Config getConfigMapping(ConfigRegistryClient configRegistryClient, YangStoreContext yangStoreSnapshot) {
215 Map<String, Map<String, ModuleConfig>> factories = transformMbeToModuleConfigs(configRegistryClient,
216 yangStoreSnapshot.getModuleMXBeanEntryMap());
217 Map<String, Map<Date, IdentityMapping>> identitiesMap = transformIdentities(yangStoreSnapshot.getModules());
218 return new Config(factories, identitiesMap, yangStoreSnapshot.getEnumResolver());
222 public static class IdentityMapping {
223 private final Map<String, IdentitySchemaNode> identityNameToSchemaNode;
226 this.identityNameToSchemaNode = Maps.newHashMap();
229 void addIdSchemaNode(IdentitySchemaNode node) {
230 String name = node.getQName().getLocalName();
231 Preconditions.checkState(!identityNameToSchemaNode.containsKey(name));
232 identityNameToSchemaNode.put(name, node);
235 public boolean containsIdName(String idName) {
236 return identityNameToSchemaNode.containsKey(idName);
241 private static Map<String, Map<Date, IdentityMapping>> transformIdentities(Set<Module> modules) {
242 Map<String, Map<Date, IdentityMapping>> mappedIds = Maps.newHashMap();
243 for (Module module : modules) {
244 String namespace = module.getNamespace().toString();
245 Map<Date, IdentityMapping> revisionsByNamespace= mappedIds.get(namespace);
246 if(revisionsByNamespace == null) {
247 revisionsByNamespace = Maps.newHashMap();
248 mappedIds.put(namespace, revisionsByNamespace);
251 Date revision = module.getRevision();
253 IdentityMapping identityMapping = revisionsByNamespace.get(revision);
254 if(identityMapping == null) {
255 identityMapping = new IdentityMapping();
256 revisionsByNamespace.put(revision, identityMapping);
259 for (IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
260 identityMapping.addIdSchemaNode(identitySchemaNode);
268 public static Map<String/* Namespace from yang file */,
269 Map<String /* Name of module entry from yang file */, ModuleConfig>> transformMbeToModuleConfigs
270 (final BeanReader configRegistryClient, Map<String/* Namespace from yang file */,
271 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> mBeanEntries) {
273 Map<String, Map<String, ModuleConfig>> namespaceToModuleNameToModuleConfig = Maps.newHashMap();
275 for (Map.Entry<String, Map<String, ModuleMXBeanEntry>> namespaceToModuleToMbe : mBeanEntries.entrySet()) {
276 for (Map.Entry<String, ModuleMXBeanEntry> moduleNameToMbe : namespaceToModuleToMbe.getValue().entrySet()) {
277 String moduleName = moduleNameToMbe.getKey();
278 ModuleMXBeanEntry moduleMXBeanEntry = moduleNameToMbe.getValue();
280 ModuleConfig moduleConfig = new ModuleConfig(moduleName,
281 new InstanceConfig(configRegistryClient,moduleMXBeanEntry.getAttributes(), moduleMXBeanEntry.getNullableDummyContainerName()));
283 Map<String, ModuleConfig> moduleNameToModuleConfig = namespaceToModuleNameToModuleConfig.get(namespaceToModuleToMbe.getKey());
284 if(moduleNameToModuleConfig == null) {
285 moduleNameToModuleConfig = Maps.newHashMap();
286 namespaceToModuleNameToModuleConfig.put(namespaceToModuleToMbe.getKey(), moduleNameToModuleConfig);
289 moduleNameToModuleConfig.put(moduleName, moduleConfig);
293 return namespaceToModuleNameToModuleConfig;
297 protected String getOperationName() {
298 return EditConfigXmlParser.EDIT_CONFIG;
302 protected Element handleWithNoSubsequentOperations(Document document, XmlElement xml) throws NetconfDocumentedException {
303 EditConfigXmlParser.EditConfigExecution editConfigExecution;
304 Config cfg = getConfigMapping(getConfigRegistryClient(), yangStoreSnapshot);
305 editConfigExecution = editConfigXmlParser.fromXml(xml, cfg);
307 Element responseInternal;
308 responseInternal = getResponseInternal(document, editConfigExecution);
309 return responseInternal;