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