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