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.Collection;
  30 import java.util.Collections;
  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 = Sets.newHashSet();
 104
 105         // [RFC6241] 8.3.  Candidate Configuration Capability
 106         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
 107         // [RFC6241] 8.5.  Rollback-on-Error Capability
 108         capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
 109
 110         final Collection<Map.Entry<Module, String>> modulesAndContents = yangStoreSnapshot.getModuleMap().values();
 111         for (Map.Entry<Module, String> moduleAndContent : modulesAndContents) {
 112             capabilities.add(new YangStoreCapability(moduleAndContent));
 113         }
 114
 115         return capabilities;
 116     }
 117
 118     private static class BasicCapability implements Capability {
 119
 120         private final String capability;
 121
 122         private BasicCapability(String capability) {
 123             this.capability = capability;
 124         }
 125
 126         @Override
 127         public String getCapabilityUri() {
 128             return capability;
 129         }
 130
 131         @Override
 132         public Optional<String> getModuleNamespace() {
 133             return Optional.absent();
 134         }
 135
 136         @Override
 137         public Optional<String> getModuleName() {
 138             return Optional.absent();
 139         }
 140
 141         @Override
 142         public Optional<String> getRevision() {
 143             return Optional.absent();
 144         }
 145
 146         @Override
 147         public Optional<String> getCapabilitySchema() {
 148             return Optional.absent();
 149         }
 150
 151         @Override
 152         public Optional<List<String>> getLocation() {
 153             return Optional.absent();
 154         }
 155     }
 156
 157     private static class YangStoreCapability extends BasicCapability {
 158
 159         private final String content;
 160         private final String revision;
 161         private final String moduleName;
 162         private final String moduleNamespace;
 163
 164         public YangStoreCapability(Map.Entry<Module, String> moduleAndContent) {
 165             super(getAsString(moduleAndContent.getKey()));
 166             this.content = moduleAndContent.getValue();
 167             Module module = moduleAndContent.getKey();
 168             this.moduleName = module.getName();
 169             this.moduleNamespace = module.getNamespace().toString();
 170             this.revision = Util.writeDate(module.getRevision());
 171         }
 172
 173         @Override
 174         public Optional<String> getCapabilitySchema() {
 175             return Optional.of(content);
 176         }
 177
 178         private static String getAsString(Module module) {
 179             final StringBuffer capabilityContent = new StringBuffer();
 180             capabilityContent.append(module.getNamespace());
 181             capabilityContent.append("?module=");
 182             capabilityContent.append(module.getName());
 183             capabilityContent.append("&revision=");
 184             capabilityContent.append(Util.writeDate(module.getRevision()));
 185             return capabilityContent.toString();
 186         }
 187
 188         @Override
 189         public Optional<String> getModuleName() {
 190             return Optional.of(moduleName);
 191         }
 192
 193         @Override
 194         public Optional<String> getModuleNamespace() {
 195             return Optional.of(moduleNamespace);
 196         }
 197
 198         @Override
 199         public Optional<String> getRevision() {
 200             return Optional.of(revision);
 201         }
 202     }
 203 }