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.Verify.verify;
  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.Map;
  23 import java.util.Map.Entry;
  24 import java.util.concurrent.ConcurrentHashMap;
  25 import java.util.concurrent.ConcurrentMap;
  26 import java.util.stream.Collectors;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.opendaylight.mdsal.binding.api.ActionSpec;
  30 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  31 import org.opendaylight.mdsal.binding.api.InstanceNotificationSpec;
  32 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  33 import org.opendaylight.mdsal.binding.dom.codec.spi.ForwardingBindingDOMCodecServices;
  34 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  35 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  36 import org.opendaylight.mdsal.binding.runtime.api.InputRuntimeType;
  37 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  38 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  39 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  40 import org.opendaylight.yangtools.yang.binding.DataObject;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.binding.RpcService;
  43 import org.opendaylight.yangtools.yang.common.QName;
  44 import org.opendaylight.yangtools.yang.common.QNameModule;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  48 import org.opendaylight.yangtools.yang.model.api.Module;
  49 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  54 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 @Beta
  59 @VisibleForTesting
  60 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
  61     private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
  62
  63     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  64             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  65                 @Override
  66                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  67                     return toYangInstanceIdentifier(key);
  68                 }
  69             });
  70
  71     private final ConcurrentMap<JavaTypeName, ContextReferenceExtractor> extractors = new ConcurrentHashMap<>();
  72     private final @NonNull BindingDOMCodecServices delegate;
  73
  74     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  75         this.delegate = requireNonNull(delegate);
  76     }
  77
  78     @Override
  79     protected BindingDOMCodecServices delegate() {
  80         return delegate;
  81     }
  82
  83     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  84         return cache.getUnchecked(path);
  85     }
  86
  87     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  88         return verifyNotNull(fromYangInstanceIdentifier(dom));
  89     }
  90
  91     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
  92         return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
  93     }
  94
  95     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
  96         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
  97     }
  98
  99     @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
 100         final var entry = resolvePath(spec.path());
 101         final var stack = entry.getKey();
 102         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 103         verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
 104         return stack.toSchemaNodeIdentifier();
 105     }
 106
 107     @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
 108         final var entry = resolvePath(spec.path());
 109         final var stack = entry.getKey();
 110         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 111         verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
 112             spec, stmt);
 113         return stack.toSchemaNodeIdentifier();
 114     }
 115
 116     @Nullable ContextReferenceExtractor findExtractor(final @NonNull InputRuntimeType inputType) {
 117         final var inputName = inputType.getIdentifier();
 118         final var cached = extractors.get(inputName);
 119         if (cached != null) {
 120             return cached;
 121         }
 122
 123         // Load the class
 124         final Class<?> inputClass;
 125         try {
 126             inputClass = getRuntimeContext().loadClass(inputName);
 127         } catch (ClassNotFoundException e) {
 128             throw new IllegalArgumentException("Failed to load class for " + inputType, e);
 129         }
 130
 131         // Check if there is an extractor at all
 132         final var created = ContextReferenceExtractor.of(inputClass);
 133         if (created == null) {
 134             return null;
 135         }
 136
 137         // Reconcile with cache
 138         final var raced = extractors.putIfAbsent(inputName, created);
 139         return raced != null ? raced : created;
 140     }
 141
 142     private @NonNull Entry<SchemaInferenceStack, QNameModule> resolvePath(final @NonNull InstanceIdentifier<?> path) {
 143         final var stack = SchemaInferenceStack.of(getRuntimeContext().getEffectiveModelContext());
 144         final var it = toYangInstanceIdentifier(path).getPathArguments().iterator();
 145         verify(it.hasNext(), "Unexpected empty instance identifier for %s", path);
 146
 147         QNameModule lastNamespace;
 148         do {
 149             final var arg = it.next();
 150             if (arg instanceof AugmentationIdentifier) {
 151                 final var augChildren = ((AugmentationIdentifier) arg).getPossibleChildNames();
 152                 verify(!augChildren.isEmpty(), "Invalid empty augmentation %s", arg);
 153                 lastNamespace = augChildren.iterator().next().getModule();
 154                 continue;
 155             }
 156
 157             final var qname = arg.getNodeType();
 158             final var stmt = stack.enterDataTree(qname);
 159             lastNamespace = qname.getModule();
 160             if (stmt instanceof ListEffectiveStatement) {
 161                 // Lists have two steps
 162                 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
 163                 // Verify just to make sure we are doing the right thing
 164                 final var skipped = it.next();
 165                 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
 166                 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
 167                     path);
 168             }
 169         } while (it.hasNext());
 170
 171         return Map.entry(stack, lastNamespace);
 172     }
 173
 174     // FIXME: This should be probably part of Binding Runtime context
 175     ImmutableBiMap<Method, QName> getRpcMethodToQName(final Class<? extends RpcService> key) {
 176         final Module module = getModule(key);
 177         final ImmutableBiMap.Builder<Method, QName> ret = ImmutableBiMap.builder();
 178         try {
 179             for (final RpcDefinition rpcDef : module.getRpcs()) {
 180                 final Method method = findRpcMethod(key, rpcDef);
 181                 ret.put(method,rpcDef.getQName());
 182             }
 183         } catch (final NoSuchMethodException e) {
 184             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 185         }
 186         return ret.build();
 187     }
 188
 189     private Module getModule(final Class<?> modeledClass) {
 190         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 191         final BindingRuntimeContext localRuntimeContext = getRuntimeContext();
 192         final Module module = localRuntimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
 193         if (module != null) {
 194             return module;
 195         }
 196
 197         LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 198                 modeledClass, moduleName, localRuntimeContext);
 199         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
 200                 + "full BindingRuntimeContext available in trace log", modeledClass, moduleName));
 201     }
 202
 203     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 204             throws NoSuchMethodException {
 205         final var rpcName = rpcDef.getQName();
 206         final var inputClz = getRuntimeContext().getRpcInput(rpcName);
 207         return key.getMethod(BindingMapping.getRpcMethodName(rpcName), inputClz);
 208     }
 209 }