binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/CurrentAdapterSerializer.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.dom.adapter;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.annotations.VisibleForTesting;
  16 import com.google.common.cache.CacheBuilder;
  17 import com.google.common.cache.CacheLoader;
  18 import com.google.common.cache.LoadingCache;
  19 import com.google.common.collect.ImmutableBiMap;
  20 import java.lang.reflect.Method;
  21 import java.util.Collection;
  22 import java.util.stream.Collectors;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  25 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  26 import org.opendaylight.mdsal.binding.dom.codec.spi.ForwardingBindingDOMCodecServices;
  27 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  28 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  29 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  30 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  31 import org.opendaylight.yangtools.yang.binding.Action;
  32 import org.opendaylight.yangtools.yang.binding.DataObject;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.binding.RpcService;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.common.QNameModule;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.model.api.Module;
  39 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 @Beta
  45 @VisibleForTesting
  46 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
  47     private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
  48
  49     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  50             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  51                 @Override
  52                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  53                     return toYangInstanceIdentifier(key);
  54                 }
  55             });
  56
  57     private final @NonNull BindingDOMCodecServices delegate;
  58
  59     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  60         this.delegate = requireNonNull(delegate);
  61     }
  62
  63     @Override
  64     protected BindingDOMCodecServices delegate() {
  65         return delegate;
  66     }
  67
  68     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  69         return cache.getUnchecked(path);
  70     }
  71
  72     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  73         return verifyNotNull(fromYangInstanceIdentifier(dom));
  74     }
  75
  76     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
  77         return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
  78     }
  79
  80     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
  81         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
  82     }
  83
  84     @NonNull Absolute getActionPath(final @NonNull Class<? extends Action<?, ?, ?>> type) {
  85         final Absolute identifier = getRuntimeContext().getActionIdentifier(type);
  86         checkArgument(identifier != null, "Failed to find schema for %s", type);
  87         return identifier;
  88     }
  89
  90     // FIXME: This should be probably part of Binding Runtime context
  91     ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
  92         final Module module = getModule(key);
  93         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
  94         try {
  95             for (final RpcDefinition rpcDef : module.getRpcs()) {
  96                 final Method method = findRpcMethod(key, rpcDef);
  97                 ret.put(method, rpcDef);
  98             }
  99         } catch (final NoSuchMethodException e) {
 100             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 101         }
 102         return ret.build();
 103     }
 104
 105     // FIXME: This should be probably part of Binding Runtime context
 106     ImmutableBiMap<Method, QName> getRpcMethodToQName(final Class<? extends RpcService> key) {
 107         final Module module = getModule(key);
 108         final ImmutableBiMap.Builder<Method, QName> ret = ImmutableBiMap.builder();
 109         try {
 110             for (final RpcDefinition rpcDef : module.getRpcs()) {
 111                 final Method method = findRpcMethod(key, rpcDef);
 112                 ret.put(method,rpcDef.getQName());
 113             }
 114         } catch (final NoSuchMethodException e) {
 115             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 116         }
 117         return ret.build();
 118     }
 119
 120     private Module getModule(final Class<?> modeledClass) {
 121         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 122         final BindingRuntimeContext localRuntimeContext = getRuntimeContext();
 123         final Module module = localRuntimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
 124         if (module != null) {
 125             return module;
 126         }
 127
 128         LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 129                 modeledClass, moduleName, localRuntimeContext);
 130         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
 131                 + "full BindingRuntimeContext available in trace log", modeledClass, moduleName));
 132     }
 133
 134     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 135             throws NoSuchMethodException {
 136         final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
 137         final Class<?> inputClz = getRuntimeContext().getClassForSchema(rpcDef.getInput());
 138         return key.getMethod(methodName, inputClz);
 139     }
 140 }