binding/mdsal-binding-runtime-spi/src/main/java/org/opendaylight/mdsal/binding/runtime/spi/ModuleInfoSnapshotBuilder.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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 package org.opendaylight.mdsal.binding.runtime.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.Throwables;
  14 import com.google.common.collect.HashMultimap;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.Multimaps;
  19 import com.google.common.collect.SetMultimap;
  20 import java.io.IOException;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.mdsal.binding.runtime.api.ModuleInfoSnapshot;
  27 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  28 import org.opendaylight.yangtools.yang.binding.BindingObject;
  29 import org.opendaylight.yangtools.yang.binding.DataRoot;
  30 import org.opendaylight.yangtools.yang.binding.YangFeature;
  31 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  32 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  33 import org.opendaylight.yangtools.yang.common.QName;
  34 import org.opendaylight.yangtools.yang.common.QNameModule;
  35 import org.opendaylight.yangtools.yang.model.repo.api.FeatureSet;
  36 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  37 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  38 import org.opendaylight.yangtools.yang.parser.api.YangParser;
  39 import org.opendaylight.yangtools.yang.parser.api.YangParserException;
  40 import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
  41 import org.opendaylight.yangtools.yang.parser.api.YangSyntaxErrorException;
  42
  43 @Beta
  44 public final class ModuleInfoSnapshotBuilder {
  45     private final SetMultimap<Class<? extends DataRoot>, YangFeature<?, ?>> moduleFeatures = HashMultimap.create();
  46     private final Set<YangModuleInfo> moduleInfos = new HashSet<>();
  47     private final YangParserFactory parserFactory;
  48
  49     public ModuleInfoSnapshotBuilder(final YangParserFactory parserFactory) {
  50         this.parserFactory = requireNonNull(parserFactory);
  51     }
  52
  53     @SuppressWarnings("checkstyle:illegalCatch")
  54     public @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject> clazz) {
  55         final YangModuleInfo moduleInfo;
  56         try {
  57             moduleInfo = BindingReflections.getModuleInfo(clazz);
  58         } catch (Exception e) {
  59             Throwables.throwIfUnchecked(e);
  60             throw new IllegalStateException("Failed to introspect " + clazz, e);
  61         }
  62
  63         return add(moduleInfo);
  64     }
  65
  66     @SuppressWarnings("unchecked")
  67     public @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject>... classes) {
  68         for (Class<? extends BindingObject> clazz : classes) {
  69             add(clazz);
  70         }
  71         return this;
  72     }
  73
  74     public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo info) {
  75         ModuleInfoSnapshotResolver.flatDependencies(moduleInfos, info);
  76         return this;
  77     }
  78
  79     public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo... infos) {
  80         for (YangModuleInfo info : infos) {
  81             add(info);
  82         }
  83         return this;
  84     }
  85
  86     public @NonNull ModuleInfoSnapshotBuilder add(final Iterable<? extends YangModuleInfo> infos) {
  87         for (YangModuleInfo info : infos) {
  88             add(info);
  89         }
  90         return this;
  91     }
  92
  93     public <R extends @NonNull DataRoot> @NonNull ModuleInfoSnapshotBuilder addModuleFeatures(final Class<R> module,
  94             final Set<? extends YangFeature<?, R>> supportedFeatures) {
  95         moduleFeatures.putAll(requireNonNull(module), ImmutableList.copyOf(supportedFeatures));
  96         return this;
  97     }
  98
  99     /**
 100      * Build {@link ModuleInfoSnapshot} from all {@code moduleInfos} in this builder.
 101      *
 102      * @return Resulting {@link ModuleInfoSnapshot}
 103      * @throws YangParserException if parsing any of the {@link YangModuleInfo} instances fails
 104      */
 105     public @NonNull ModuleInfoSnapshot build() throws YangParserException {
 106         final YangParser parser = parserFactory.createParser();
 107
 108         final Map<SourceIdentifier, YangModuleInfo> mappedInfos = new HashMap<>();
 109         final Map<String, ClassLoader> classLoaders = new HashMap<>();
 110         for (YangModuleInfo info : moduleInfos) {
 111             final YangTextSchemaSource source = ModuleInfoSnapshotResolver.toYangTextSource(info);
 112             mappedInfos.put(source.getIdentifier(), info);
 113
 114             final Class<?> infoClass = info.getClass();
 115             classLoaders.put(Naming.getModelRootPackageName(infoClass.getPackage().getName()),
 116                 infoClass.getClassLoader());
 117
 118             try {
 119                 parser.addSource(source);
 120             } catch (YangSyntaxErrorException | IOException e) {
 121                 throw new YangParserException("Failed to add source for " + info, e);
 122             }
 123         }
 124
 125         if (!moduleFeatures.isEmpty()) {
 126             final var featuresByModule =
 127                 ImmutableMap.<QNameModule, ImmutableSet<String>>builderWithExpectedSize(moduleFeatures.size());
 128             for (var entry : Multimaps.asMap(moduleFeatures).entrySet()) {
 129                 featuresByModule.put(BindingReflections.getQNameModule(entry.getKey()),
 130                     entry.getValue().stream().map(YangFeature::qname).map(QName::getLocalName).sorted()
 131                         .collect(ImmutableSet.toImmutableSet()));
 132             }
 133             parser.setSupportedFeatures(new FeatureSet(featuresByModule.build()));
 134         }
 135
 136         return new DefaultModuleInfoSnapshot(parser.buildEffectiveModel(), mappedInfos, classLoaders);
 137     }
 138 }