2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.runtime.spi;
10 import static java.util.Objects.requireNonNull;
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.ImmutableSet;
17 import com.google.common.collect.Multimaps;
18 import com.google.common.collect.SetMultimap;
19 import java.io.IOException;
20 import java.util.HashMap;
21 import java.util.HashSet;
23 import org.eclipse.jdt.annotation.NonNull;
24 import org.opendaylight.mdsal.binding.runtime.api.ModuleInfoSnapshot;
25 import org.opendaylight.yangtools.yang.binding.BindingObject;
26 import org.opendaylight.yangtools.yang.binding.DataRoot;
27 import org.opendaylight.yangtools.yang.binding.YangFeature;
28 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
29 import org.opendaylight.yangtools.yang.binding.contract.Naming;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.QNameModule;
32 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
33 import org.opendaylight.yangtools.yang.model.api.stmt.FeatureSet;
34 import org.opendaylight.yangtools.yang.parser.api.YangParser;
35 import org.opendaylight.yangtools.yang.parser.api.YangParserException;
36 import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
37 import org.opendaylight.yangtools.yang.parser.api.YangSyntaxErrorException;
40 public final class ModuleInfoSnapshotBuilder {
41 private final SetMultimap<Class<? extends DataRoot>, YangFeature<?, ?>> moduleFeatures = HashMultimap.create();
42 private final Set<YangModuleInfo> moduleInfos = new HashSet<>();
43 private final YangParserFactory parserFactory;
45 public ModuleInfoSnapshotBuilder(final YangParserFactory parserFactory) {
46 this.parserFactory = requireNonNull(parserFactory);
49 @SuppressWarnings("checkstyle:illegalCatch")
50 public @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject> clazz) {
51 final YangModuleInfo moduleInfo;
53 moduleInfo = BindingRuntimeHelpers.getYangModuleInfo(clazz);
54 } catch (Exception e) {
55 Throwables.throwIfUnchecked(e);
56 throw new IllegalStateException("Failed to introspect " + clazz, e);
59 return add(moduleInfo);
63 public final @NonNull ModuleInfoSnapshotBuilder add(final Class<? extends BindingObject>... classes) {
64 for (var clazz : classes) {
70 public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo info) {
71 ModuleInfoSnapshotResolver.flatDependencies(moduleInfos, info);
75 public @NonNull ModuleInfoSnapshotBuilder add(final YangModuleInfo... infos) {
76 for (var info : infos) {
82 public @NonNull ModuleInfoSnapshotBuilder add(final Iterable<? extends YangModuleInfo> infos) {
83 for (YangModuleInfo info : infos) {
89 public <R extends @NonNull DataRoot> @NonNull ModuleInfoSnapshotBuilder addModuleFeatures(final Class<R> module,
90 final Set<? extends YangFeature<?, R>> supportedFeatures) {
91 moduleFeatures.putAll(requireNonNull(module), ImmutableList.copyOf(supportedFeatures));
96 * Build {@link ModuleInfoSnapshot} from all {@code moduleInfos} in this builder.
98 * @return Resulting {@link ModuleInfoSnapshot}
99 * @throws YangParserException if parsing any of the {@link YangModuleInfo} instances fails
101 public @NonNull ModuleInfoSnapshot build() throws YangParserException {
102 final YangParser parser = parserFactory.createParser();
104 final var mappedInfos = new HashMap<SourceIdentifier, YangModuleInfo>();
105 final var classLoaders = new HashMap<String, ClassLoader>();
106 final var namespaces = new HashMap<String, QNameModule>();
108 for (var info : moduleInfos) {
109 final var source = ModuleInfoSnapshotResolver.toYangTextSource(info);
110 mappedInfos.put(source.sourceId(), info);
112 final Class<?> infoClass = info.getClass();
113 final String infoRoot = Naming.getModelRootPackageName(infoClass.getPackage().getName())
114 .replace(Naming.SVC_PACKAGE_PREFIX, Naming.PACKAGE_PREFIX);
115 classLoaders.put(infoRoot, infoClass.getClassLoader());
116 namespaces.put(infoRoot, info.getName().getModule());
119 parser.addSource(source);
120 } catch (YangSyntaxErrorException | IOException e) {
121 throw new YangParserException("Failed to add source for " + info, e);
125 if (!moduleFeatures.isEmpty()) {
126 final var featuresByModule = FeatureSet.builder();
127 for (var entry : Multimaps.asMap(moduleFeatures).entrySet()) {
128 final var moduleData = entry.getKey();
129 final var moduleRoot = Naming.getModelRootPackageName(moduleData.getPackage().getName());
130 final var moduleNamespace = namespaces.get(moduleRoot);
131 if (moduleNamespace == null) {
132 throw new YangParserException("Failed to resolve namespace of " + moduleData);
135 featuresByModule.addModuleFeatures(moduleNamespace, entry.getValue().stream()
136 .map(YangFeature::qname)
137 .map(QName::getLocalName)
139 .collect(ImmutableSet.toImmutableSet()));
141 parser.setSupportedFeatures(featuresByModule.build());
144 return new DefaultModuleInfoSnapshot(parser.buildEffectiveModel(), mappedInfos, classLoaders);