binding/mdsal-binding-runtime-spi/src/main/java/org/opendaylight/mdsal/binding/runtime/spi/BindingRuntimeHelpers.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 com.google.common.annotations.Beta;
  11 import com.google.common.base.Throwables;
  12 import java.util.Arrays;
  13 import java.util.Collection;
  14 import java.util.stream.Collectors;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  17 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeGenerator;
  18 import org.opendaylight.mdsal.binding.runtime.api.DefaultBindingRuntimeContext;
  19 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  20 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  21 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  22 import org.opendaylight.yangtools.yang.model.parser.api.YangParserFactory;
  23
  24 /**
  25  * Simple helpers to help with reconstruction of BindingRuntimeContext from generated binding classes. These involve
  26  * reflection and YANG model assembly, hence should not be used without any caching whatsoever or any support for
  27  * dynamic schema updates.
  28  */
  29 @Beta
  30 public final class BindingRuntimeHelpers {
  31     private BindingRuntimeHelpers() {
  32
  33     }
  34
  35     public static @NonNull EffectiveModelContext createEffectiveModel(final Class<?>... classes) {
  36         return createEffectiveModel(Arrays.stream(classes)
  37             .map(BindingRuntimeHelpers::extractYangModuleInfo)
  38             .collect(Collectors.toList()));
  39     }
  40
  41     public static @NonNull EffectiveModelContext createEffectiveModel(
  42             final Iterable<? extends YangModuleInfo> moduleInfos) {
  43         return createEffectiveModel(ServiceLoaderState.ParserFactory.INSTANCE, moduleInfos);
  44     }
  45
  46     public static @NonNull EffectiveModelContext createEffectiveModel(final YangParserFactory parserFactory,
  47             final Iterable<? extends YangModuleInfo> moduleInfos) {
  48         return prepareContext(parserFactory, moduleInfos).tryToCreateModelContext().orElseThrow();
  49     }
  50
  51     public static @NonNull BindingRuntimeContext createRuntimeContext() {
  52         final ModuleInfoBackedContext ctx = prepareContext(ServiceLoaderState.ParserFactory.INSTANCE,
  53             BindingReflections.loadModuleInfos());
  54         return DefaultBindingRuntimeContext.create(ServiceLoaderState.Generator.INSTANCE.generateTypeMapping(
  55             ctx.tryToCreateModelContext().orElseThrow()), ctx);
  56     }
  57
  58     public static @NonNull BindingRuntimeContext createRuntimeContext(final Class<?>... classes) {
  59         return createRuntimeContext(ServiceLoaderState.ParserFactory.INSTANCE, ServiceLoaderState.Generator.INSTANCE,
  60             classes);
  61     }
  62
  63     public static @NonNull BindingRuntimeContext createRuntimeContext(final YangParserFactory parserFactory,
  64             final BindingRuntimeGenerator generator, final Class<?>... classes) {
  65         return createRuntimeContext(parserFactory, generator, Arrays.asList(classes));
  66     }
  67
  68     public static @NonNull BindingRuntimeContext createRuntimeContext(final YangParserFactory parserFactory,
  69             final BindingRuntimeGenerator generator, final Collection<Class<?>> classes) {
  70         final ModuleInfoBackedContext ctx = prepareContext(parserFactory, classes.stream()
  71             .map(BindingRuntimeHelpers::extractYangModuleInfo)
  72             .collect(Collectors.toList()));
  73         return DefaultBindingRuntimeContext.create(
  74             generator.generateTypeMapping(ctx.tryToCreateModelContext().orElseThrow()), ctx);
  75     }
  76
  77     @SuppressWarnings("checkstyle:IllegalCatch")
  78     static @NonNull YangModuleInfo extractYangModuleInfo(final Class<?> clazz) {
  79         try {
  80             return BindingReflections.getModuleInfo(clazz);
  81         } catch (Exception e) {
  82             Throwables.throwIfUnchecked(e);
  83             throw new IllegalStateException("Failed to extract module info from " + clazz, e);
  84         }
  85     }
  86
  87     private static @NonNull ModuleInfoBackedContext prepareContext(final YangParserFactory parserFactory,
  88             final Iterable<? extends YangModuleInfo> moduleInfos) {
  89         final ModuleInfoBackedContext ctx = ModuleInfoBackedContext.create("helper", parserFactory);
  90         ctx.registerModuleInfos(moduleInfos);
  91         return ctx;
  92     }
  93 }