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 java.io.IOException;
  15 import java.util.HashMap;
  16 import java.util.HashSet;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.mdsal.binding.runtime.api.ModuleInfoSnapshot;
  21 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  22 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  23 import org.opendaylight.yangtools.yang.binding.BindingObject;
  24 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  25 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  26 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  27 import org.opendaylight.yangtools.yang.parser.api.YangParser;
  28 import org.opendaylight.yangtools.yang.parser.api.YangParserException;
  29 import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
  30 import org.opendaylight.yangtools.yang.parser.api.YangSyntaxErrorException;
  31
  32 @Beta
  33 public final class ModuleInfoSnapshotBuilder {
  34     private final Set<YangModuleInfo> moduleInfos = new HashSet<>();
  35     private final YangParserFactory parserFactory;
  36
  37     public ModuleInfoSnapshotBuilder(final YangParserFactory parserFactory) {
  38         this.parserFactory = requireNonNull(parserFactory);
  39     }
  40
  41     @SuppressWarnings("checkstyle:illegalCatch")
  42     public @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject> clazz) {
  43         final YangModuleInfo moduleInfo;
  44         try {
  45             moduleInfo = BindingReflections.getModuleInfo(clazz);
  46         } catch (Exception e) {
  47             Throwables.throwIfUnchecked(e);
  48             throw new IllegalStateException("Failed to introspect " + clazz, e);
  49         }
  50
  51         return add(moduleInfo);
  52     }
  53
  54     @SuppressWarnings("unchecked")
  55     public @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject>... classes) {
  56         for (Class<? extends BindingObject> clazz : classes) {
  57             add(clazz);
  58         }
  59         return this;
  60     }
  61
  62     public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo info) {
  63         ModuleInfoSnapshotResolver.flatDependencies(moduleInfos, info);
  64         return this;
  65     }
  66
  67     public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo... infos) {
  68         for (YangModuleInfo info : infos) {
  69             add(info);
  70         }
  71         return this;
  72     }
  73
  74     public @NonNull ModuleInfoSnapshotBuilder add(final Iterable<? extends YangModuleInfo> infos) {
  75         for (YangModuleInfo info : infos) {
  76             add(info);
  77         }
  78         return this;
  79     }
  80
  81     /**
  82      * Build {@link ModuleInfoSnapshot} from all {@code moduleInfos} in this builder.
  83      *
  84      * @return Resulting {@link ModuleInfoSnapshot}
  85      * @throws YangParserException if parsing any of the {@link YangModuleInfo} instances fails
  86      */
  87     public @NonNull ModuleInfoSnapshot build() throws YangParserException {
  88         final YangParser parser = parserFactory.createParser();
  89         final Map<SourceIdentifier, YangModuleInfo> mappedInfos = new HashMap<>();
  90         final Map<String, ClassLoader> classLoaders = new HashMap<>();
  91         for (YangModuleInfo info : moduleInfos) {
  92             final YangTextSchemaSource source = ModuleInfoSnapshotResolver.toYangTextSource(info);
  93             mappedInfos.put(source.getIdentifier(), info);
  94
  95             final Class<?> infoClass = info.getClass();
  96             classLoaders.put(BindingMapping.getModelRootPackageName(infoClass.getPackage().getName()),
  97                 infoClass.getClassLoader());
  98
  99             try {
 100                 parser.addSource(source);
 101             } catch (YangSyntaxErrorException | IOException e) {
 102                 throw new YangParserException("Failed to add source for " + info, e);
 103             }
 104         }
 105
 106         return new DefaultModuleInfoSnapshot(parser.buildEffectiveModel(), mappedInfos, classLoaders);
 107     }
 108 }