opendaylight/netconf/config-netconf-connector/src/main/java/org/opendaylight/controller/netconf/confignetconfconnector/osgi/NetconfOperationServiceImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.netconf.confignetconfconnector.osgi;
  10
  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.Sets;
  15 import org.opendaylight.controller.config.api.LookupRegistry;
  16 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
  17 import org.opendaylight.controller.config.yang.store.api.YangStoreException;
  18 import org.opendaylight.controller.config.yang.store.api.YangStoreService;
  19 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
  20 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  21 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
  22 import org.opendaylight.controller.netconf.confignetconfconnector.util.Util;
  23 import org.opendaylight.controller.netconf.mapping.api.Capability;
  24 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
  25 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilter;
  26 import org.opendaylight.controller.netconf.mapping.api.NetconfOperationService;
  27 import org.opendaylight.yangtools.yang.model.api.Module;
  28
  29 import java.util.Collections;
  30 import java.util.HashSet;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34
  35 /**
  36  * Manages life cycle of {@link YangStoreSnapshot}.
  37  */
  38 public class NetconfOperationServiceImpl implements NetconfOperationService {
  39
  40     private final YangStoreSnapshot yangStoreSnapshot;
  41     private final NetconfOperationProvider operationProvider;
  42     private final Set<Capability> capabilities;
  43     private final TransactionProvider transactionProvider;
  44
  45     public NetconfOperationServiceImpl(YangStoreService yangStoreService, ConfigRegistryJMXClient jmxClient,
  46             String netconfSessionIdForReporting) throws YangStoreException {
  47
  48         yangStoreSnapshot = yangStoreService.getYangStoreSnapshot();
  49         checkConsistencyBetweenYangStoreAndConfig(jmxClient, yangStoreSnapshot);
  50
  51         transactionProvider = new TransactionProvider(jmxClient, netconfSessionIdForReporting);
  52         operationProvider = new NetconfOperationProvider(yangStoreSnapshot, jmxClient, transactionProvider,
  53                 netconfSessionIdForReporting);
  54         capabilities = setupCapabilities(yangStoreSnapshot);
  55     }
  56
  57
  58     @VisibleForTesting
  59     static void checkConsistencyBetweenYangStoreAndConfig(LookupRegistry jmxClient, YangStoreSnapshot yangStoreSnapshot) {
  60         Set<String> missingModulesFromConfig = Sets.newHashSet();
  61
  62         Set<String> modulesSeenByConfig = jmxClient.getAvailableModuleFactoryQNames();
  63         Map<String, Map<String, ModuleMXBeanEntry>> moduleMXBeanEntryMap = yangStoreSnapshot.getModuleMXBeanEntryMap();
  64
  65         for (Map<String, ModuleMXBeanEntry> moduleNameToMBE : moduleMXBeanEntryMap.values()) {
  66             for (ModuleMXBeanEntry moduleMXBeanEntry : moduleNameToMBE.values()) {
  67                 String moduleSeenByYangStore = moduleMXBeanEntry.getYangModuleQName().toString();
  68                 if(modulesSeenByConfig.contains(moduleSeenByYangStore) == false)
  69                     missingModulesFromConfig.add(moduleSeenByYangStore);
  70             }
  71         }
  72
  73         Preconditions
  74                 .checkState(
  75                         missingModulesFromConfig.isEmpty(),
  76                         "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",
  77                         missingModulesFromConfig, System.lineSeparator(), modulesSeenByConfig);
  78
  79     }
  80
  81     @Override
  82     public void close() {
  83         yangStoreSnapshot.close();
  84         transactionProvider.close();
  85     }
  86
  87     @Override
  88     public Set<Capability> getCapabilities() {
  89         return capabilities;
  90     }
  91
  92     @Override
  93     public Set<NetconfOperation> getNetconfOperations() {
  94         return operationProvider.getOperations();
  95     }
  96
  97     @Override
  98     public Set<NetconfOperationFilter> getFilters() {
  99         return Collections.emptySet();
 100     }
 101
 102     private static Set<Capability> setupCapabilities(YangStoreSnapshot yangStoreSnapshot) {
 103         Set<Capability> capabilities = new HashSet<>();
 104         // [RFC6241] 8.3.  Candidate Configuration Capability
 105         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
 106         // [RFC6241] 8.5.  Rollback-on-Error Capability
 107         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
 108
 109         Set<Module> modules = yangStoreSnapshot.getModules();
 110         for (Module module : modules) {
 111             capabilities.add(new YangStoreCapability(module, yangStoreSnapshot.getModuleSource(module)));
 112         }
 113
 114         return capabilities;
 115     }
 116
 117     private static class BasicCapability implements Capability {
 118
 119         private final String capability;
 120
 121         private BasicCapability(String capability) {
 122             this.capability = capability;
 123         }
 124
 125         @Override
 126         public String getCapabilityUri() {
 127             return capability;
 128         }
 129
 130         @Override
 131         public Optional<String> getModuleNamespace() {
 132             return Optional.absent();
 133         }
 134
 135         @Override
 136         public Optional<String> getModuleName() {
 137             return Optional.absent();
 138         }
 139
 140         @Override
 141         public Optional<String> getRevision() {
 142             return Optional.absent();
 143         }
 144
 145         @Override
 146         public Optional<String> getCapabilitySchema() {
 147             return Optional.absent();
 148         }
 149
 150         @Override
 151         public Optional<List<String>> getLocation() {
 152             return Optional.absent();
 153         }
 154     }
 155
 156     private static class YangStoreCapability extends BasicCapability {
 157
 158         private final String content;
 159         private final String revision;
 160         private final String moduleName;
 161         private final String moduleNamespace;
 162
 163         public YangStoreCapability(Module module, String moduleContent) {
 164             super(getAsString(module));
 165             this.content = moduleContent;
 166             this.moduleName = module.getName();
 167             this.moduleNamespace = module.getNamespace().toString();
 168             this.revision = Util.writeDate(module.getRevision());
 169         }
 170
 171         @Override
 172         public Optional<String> getCapabilitySchema() {
 173             return Optional.of(content);
 174         }
 175
 176         private static String getAsString(Module module) {
 177             final StringBuffer capabilityContent = new StringBuffer();
 178             capabilityContent.append(module.getNamespace());
 179             capabilityContent.append("?module=");
 180             capabilityContent.append(module.getName());
 181             capabilityContent.append("&revision=");
 182             capabilityContent.append(Util.writeDate(module.getRevision()));
 183             return capabilityContent.toString();
 184         }
 185
 186         @Override
 187         public Optional<String> getModuleName() {
 188             return Optional.of(moduleName);
 189         }
 190
 191         @Override
 192         public Optional<String> getModuleNamespace() {
 193             return Optional.of(moduleNamespace);
 194         }
 195
 196         @Override
 197         public Optional<String> getRevision() {
 198             return Optional.of(revision);
 199         }
 200     }
 201 }