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