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.osgi;
11 import java.util.HashSet;
12 import java.util.List;
16 import org.opendaylight.controller.config.api.LookupRegistry;
17 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
18 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
19 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
20 import org.opendaylight.controller.netconf.confignetconfconnector.util.Util;
21 import org.opendaylight.controller.netconf.mapping.api.Capability;
22 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
23 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
24 import org.opendaylight.yangtools.yang.model.api.Module;
26 import com.google.common.annotations.VisibleForTesting;
27 import com.google.common.base.Optional;
28 import com.google.common.base.Preconditions;
29 import com.google.common.collect.Sets;
32 * Manages life cycle of {@link YangStoreSnapshot}.
34 public class NetconfOperationServiceImpl implements NetconfOperationService {
36 private final YangStoreSnapshot yangStoreSnapshot;
37 private final NetconfOperationProvider operationProvider;
38 private final Set<Capability> capabilities;
39 private final TransactionProvider transactionProvider;
41 public NetconfOperationServiceImpl(YangStoreService yangStoreService, ConfigRegistryJMXClient jmxClient,
42 String netconfSessionIdForReporting) throws YangStoreException {
44 yangStoreSnapshot = yangStoreService.getYangStoreSnapshot();
45 checkConsistencyBetweenYangStoreAndConfig(jmxClient, yangStoreSnapshot);
47 transactionProvider = new TransactionProvider(jmxClient, netconfSessionIdForReporting);
48 operationProvider = new NetconfOperationProvider(yangStoreSnapshot, jmxClient, transactionProvider,
49 netconfSessionIdForReporting);
50 capabilities = setupCapabilities(yangStoreSnapshot);
55 static void checkConsistencyBetweenYangStoreAndConfig(LookupRegistry jmxClient, YangStoreSnapshot yangStoreSnapshot) {
56 Set<String> missingModulesFromConfig = Sets.newHashSet();
58 Set<String> modulesSeenByConfig = jmxClient.getAvailableModuleFactoryQNames();
59 Map<String, Map<String, ModuleMXBeanEntry>> moduleMXBeanEntryMap = yangStoreSnapshot.getModuleMXBeanEntryMap();
61 for (Map<String, ModuleMXBeanEntry> moduleNameToMBE : moduleMXBeanEntryMap.values()) {
62 for (ModuleMXBeanEntry moduleMXBeanEntry : moduleNameToMBE.values()) {
63 String moduleSeenByYangStore = moduleMXBeanEntry.getYangModuleQName().toString();
64 if(modulesSeenByConfig.contains(moduleSeenByYangStore) == false)
65 missingModulesFromConfig.add(moduleSeenByYangStore);
71 missingModulesFromConfig.isEmpty(),
72 "There are inconsistencies between configuration subsystem and yangstore in terms of discovered yang modules, yang modules missing from config subsystem but present in yangstore: %s, %sAll modules present in config: %s",
73 missingModulesFromConfig, System.lineSeparator(), modulesSeenByConfig);
79 yangStoreSnapshot.close();
80 transactionProvider.close();
84 public Set<Capability> getCapabilities() {
89 public Set<NetconfOperation> getNetconfOperations() {
90 return operationProvider.getOperations();
93 private static Set<Capability> setupCapabilities(YangStoreSnapshot yangStoreSnapshot) {
94 Set<Capability> capabilities = new HashSet<>();
95 // [RFC6241] 8.3. Candidate Configuration Capability
96 capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
97 // [RFC6241] 8.5. Rollback-on-Error Capability
98 capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
100 Set<Module> modules = yangStoreSnapshot.getModules();
101 for (Module module : modules) {
102 capabilities.add(new YangStoreCapability(module, yangStoreSnapshot.getModuleSource(module)));
108 private static class BasicCapability implements Capability {
110 private final String capability;
112 private BasicCapability(String capability) {
113 this.capability = capability;
117 public String getCapabilityUri() {
122 public Optional<String> getModuleNamespace() {
123 return Optional.absent();
127 public Optional<String> getModuleName() {
128 return Optional.absent();
132 public Optional<String> getRevision() {
133 return Optional.absent();
137 public Optional<String> getCapabilitySchema() {
138 return Optional.absent();
142 public Optional<List<String>> getLocation() {
143 return Optional.absent();
147 public String toString() {
152 private static class YangStoreCapability extends BasicCapability {
154 private final String content;
155 private final String revision;
156 private final String moduleName;
157 private final String moduleNamespace;
159 public YangStoreCapability(Module module, String moduleContent) {
160 super(toCapabilityURI(module));
161 this.content = moduleContent;
162 this.moduleName = module.getName();
163 this.moduleNamespace = module.getNamespace().toString();
164 this.revision = Util.writeDate(module.getRevision());
168 public Optional<String> getCapabilitySchema() {
169 return Optional.of(content);
172 private static String toCapabilityURI(Module module) {
173 return String.valueOf(module.getNamespace()) + "?module="
174 + module.getName() + "&revision=" + Util.writeDate(module.getRevision());
178 public Optional<String> getModuleName() {
179 return Optional.of(moduleName);
183 public Optional<String> getModuleNamespace() {
184 return Optional.of(moduleNamespace);
188 public Optional<String> getRevision() {
189 return Optional.of(revision);