opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/osgi/YangStoreSnapshot.java

   1 /*
   2  * Copyright (c) 2015, 2017 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.config.facade.xml.osgi;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.BiMap;
  14 import com.google.common.collect.Maps;
  15 import com.google.common.collect.Sets;
  16 import com.google.common.io.ByteStreams;
  17 import com.google.common.util.concurrent.CheckedFuture;
  18 import java.io.IOException;
  19 import java.io.InputStream;
  20 import java.lang.ref.SoftReference;
  21 import java.nio.charset.StandardCharsets;
  22 import java.util.Collections;
  23 import java.util.HashMap;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26 import java.util.Objects;
  27 import java.util.Set;
  28 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
  29 import org.opendaylight.controller.config.yangjmxgenerator.PackageTranslator;
  30 import org.opendaylight.controller.config.yangjmxgenerator.ServiceInterfaceEntry;
  31 import org.opendaylight.controller.config.yangjmxgenerator.TypeProviderWrapper;
  32 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  33 import org.opendaylight.mdsal.binding.yang.types.TypeProviderImpl;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.Module;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  38 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException;
  39 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  40 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  41 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 public final class YangStoreSnapshot implements YangStoreContext, EnumResolver {
  46     private static final class MXBeans {
  47         private final Map<String /* Namespace from yang file */,
  48                 Map<String /* Name of module entry from yang file */, ModuleMXBeanEntry>> moduleMXBeanEntryMap;
  49         private final Map<QName, Map<String, ModuleMXBeanEntry>> namesToIdentitiesToModuleMXBeanEntries;
  50
  51         MXBeans(final SchemaContext schemaContext) {
  52             LOG.trace("Resolved modules:{}", schemaContext.getModules());
  53
  54             // JMX generator
  55             final Map<String, String> namespaceToPackageMapping = Maps.newHashMap();
  56             final PackageTranslator packageTranslator = new PackageTranslator(namespaceToPackageMapping);
  57             final Map<QName, ServiceInterfaceEntry> qNamesToSIEs = new HashMap<>();
  58             final Map<IdentitySchemaNode, ServiceInterfaceEntry> knownSEITracker = new HashMap<>();
  59             // create SIE structure qNamesToSIEs
  60             for (final Module module : schemaContext.getModules()) {
  61                 final String packageName = packageTranslator.getPackageName(module);
  62                 final Map<QName, ServiceInterfaceEntry> namesToSIEntries = ServiceInterfaceEntry
  63                         .create(module, packageName, knownSEITracker);
  64                 for (final Entry<QName, ServiceInterfaceEntry> sieEntry : namesToSIEntries.entrySet()) {
  65                     // merge value into qNamesToSIEs
  66                     if (!qNamesToSIEs.containsKey(sieEntry.getKey())) {
  67                         qNamesToSIEs.put(sieEntry.getKey(), sieEntry.getValue());
  68                     } else {
  69                         throw new IllegalStateException("Cannot add two SIE with same qname "
  70                                 + sieEntry.getValue());
  71                     }
  72                 }
  73             }
  74
  75             final Map<String, Map<String, ModuleMXBeanEntry>> moduleMXBeanEntries = Maps.newHashMap();
  76
  77             final Map<QName, Map<String /* identity local name */,
  78                 ModuleMXBeanEntry>> qNamesToIdentitiesToModuleMXBeanEntries = new HashMap<>();
  79
  80
  81             for (final Module module : schemaContext.getModules()) {
  82                 final String packageName = packageTranslator.getPackageName(module);
  83                 final TypeProviderWrapper typeProviderWrapper = new TypeProviderWrapper(
  84                         new TypeProviderImpl(schemaContext));
  85
  86                 final QName qName = QName.create(module.getNamespace(), module.getRevision(), module.getName());
  87
  88                 final Map<String /* MB identity local name */, ModuleMXBeanEntry> namesToMBEs =
  89                         Collections.unmodifiableMap(ModuleMXBeanEntry.create(module, qNamesToSIEs, schemaContext,
  90                                 typeProviderWrapper, packageName));
  91                 moduleMXBeanEntries.put(module.getNamespace().toString(), namesToMBEs);
  92
  93                 qNamesToIdentitiesToModuleMXBeanEntries.put(qName, namesToMBEs);
  94             }
  95             this.moduleMXBeanEntryMap = Collections.unmodifiableMap(moduleMXBeanEntries);
  96             this.namesToIdentitiesToModuleMXBeanEntries =
  97                     Collections.unmodifiableMap(qNamesToIdentitiesToModuleMXBeanEntries);
  98         }
  99     }
 100
 101     private static final Logger LOG = LoggerFactory.getLogger(YangStoreSnapshot.class);
 102     private final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 103     private final BindingRuntimeContext bindingContextProvider;
 104
 105     /**
 106      * We want to lazily compute the context of the MXBean class and have it only softly-attached to this instance,
 107      * so it can be garbage collected when the memory gets tight. If the schema context changes as we are computing
 108      * things, YangStoreService will detect that and retry, so we do not have to worry about that.
 109      */
 110     private volatile SoftReference<MXBeans> ref = new SoftReference<>(null);
 111
 112     public YangStoreSnapshot(final BindingRuntimeContext bindingContextProvider,
 113         final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
 114         this.bindingContextProvider = Preconditions.checkNotNull(bindingContextProvider);
 115         this.sourceProvider = Preconditions.checkNotNull(sourceProvider);
 116     }
 117
 118     private MXBeans getMXBeans() {
 119         MXBeans mxBean = this.ref.get();
 120
 121         if (mxBean == null) {
 122             synchronized (this) {
 123                 mxBean = this.ref.get();
 124                 if (mxBean == null) {
 125                     mxBean = new MXBeans(this.bindingContextProvider.getSchemaContext());
 126                     this.ref = new SoftReference<>(mxBean);
 127                 }
 128             }
 129         }
 130
 131         return mxBean;
 132     }
 133
 134     @Override
 135     public Map<String, Map<String, ModuleMXBeanEntry>> getModuleMXBeanEntryMap() {
 136         return getMXBeans().moduleMXBeanEntryMap;
 137     }
 138
 139     @Override
 140     public Map<QName, Map<String, ModuleMXBeanEntry>> getQNamesToIdentitiesToModuleMXBeanEntries() {
 141         return getMXBeans().namesToIdentitiesToModuleMXBeanEntries;
 142     }
 143
 144     @Override
 145     public Set<Module> getModules() {
 146         final Set<Module> modules = Sets.newHashSet(this.bindingContextProvider.getSchemaContext().getModules());
 147         for (final Module module : this.bindingContextProvider.getSchemaContext().getModules()) {
 148             modules.addAll(module.getSubmodules());
 149         }
 150         return modules;
 151     }
 152
 153     @Override
 154     public String getModuleSource(final org.opendaylight.yangtools.yang.model.api.ModuleIdentifier moduleIdentifier) {
 155         final CheckedFuture<? extends YangTextSchemaSource, SchemaSourceException> source = this.sourceProvider
 156                 .getSource(SourceIdentifier.create(moduleIdentifier.getName(),
 157                         Optional.fromNullable(QName.formattedRevision(moduleIdentifier.getRevision()))));
 158
 159         try {
 160             final YangTextSchemaSource yangTextSchemaSource = source.checkedGet();
 161             try (InputStream inStream = yangTextSchemaSource.openStream()) {
 162                 return new String(ByteStreams.toByteArray(inStream), StandardCharsets.UTF_8);
 163             }
 164         } catch (SchemaSourceException | IOException e) {
 165             LOG.warn("Unable to provide source for {}", moduleIdentifier, e);
 166             throw new IllegalArgumentException("Unable to provide source for " + moduleIdentifier, e);
 167         }
 168     }
 169
 170     @Override
 171     public EnumResolver getEnumResolver() {
 172         return this;
 173     }
 174
 175     @Override
 176     public boolean equals(final Object obj) {
 177         if (this == obj) {
 178             return true;
 179         }
 180         if (!(obj instanceof YangStoreSnapshot)) {
 181             return false;
 182         }
 183
 184         final YangStoreSnapshot other = (YangStoreSnapshot) obj;
 185         return Objects.equals(this.bindingContextProvider, other.bindingContextProvider);
 186     }
 187
 188     @Override
 189     public int hashCode() {
 190         return Objects.hashCode(this.bindingContextProvider);
 191     }
 192
 193     @Override
 194     public String fromYang(final String enumClass, final String enumYangValue) {
 195         Preconditions.checkState(this.bindingContextProvider != null, "Binding context provider was not set yet");
 196         final BiMap<String, String> enumMapping = this.bindingContextProvider.getEnumMapping(enumClass);
 197         final String javaName = enumMapping.get(enumYangValue);
 198         return Preconditions.checkNotNull(javaName,
 199                 "Unable to resolve enum value %s for enum class %s with assumed enum mapping: %s", enumYangValue,
 200                 enumClass, enumMapping);
 201     }
 202
 203     @Override
 204     public String toYang(final String enumClass, final String enumJavaValue) {
 205         Preconditions.checkState(this.bindingContextProvider != null, "Binding context provider was not set yet");
 206         final BiMap<String, String> enumMapping = this.bindingContextProvider.getEnumMapping(enumClass);
 207         final String javaName = enumMapping.inverse().get(enumJavaValue);
 208         return Preconditions.checkNotNull(javaName,
 209             "Unable to map enum value %s for enum class %s with assumed enum mapping: %s", enumJavaValue, enumClass,
 210             enumMapping.inverse());
 211     }
 212 }