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 java.util.Collection;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import java.util.concurrent.ConcurrentHashMap;
  23 import java.util.concurrent.ConcurrentMap;
  24 import java.util.stream.Collectors;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.opendaylight.mdsal.binding.api.ActionSpec;
  28 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  29 import org.opendaylight.mdsal.binding.api.InstanceNotificationSpec;
  30 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  31 import org.opendaylight.mdsal.binding.dom.codec.spi.ForwardingBindingDOMCodecServices;
  32 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  33 import org.opendaylight.mdsal.binding.runtime.api.InputRuntimeType;
  34 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  35 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  36 import org.opendaylight.yangtools.yang.binding.DataObject;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.common.QNameModule;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  41 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  42 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  43 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
  44 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  45 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 @Beta
  50 @VisibleForTesting
  51 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
  52     private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
  53
  54     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  55             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  56                 @Override
  57                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  58                     return toYangInstanceIdentifier(key);
  59                 }
  60             });
  61
  62     private final ConcurrentMap<JavaTypeName, ContextReferenceExtractor> extractors = new ConcurrentHashMap<>();
  63     private final @NonNull BindingDOMCodecServices delegate;
  64
  65     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  66         this.delegate = requireNonNull(delegate);
  67     }
  68
  69     @Override
  70     protected BindingDOMCodecServices delegate() {
  71         return delegate;
  72     }
  73
  74     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  75         return cache.getUnchecked(path);
  76     }
  77
  78     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  79         return verifyNotNull(fromYangInstanceIdentifier(dom));
  80     }
  81
  82     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
  83         return DOMDataTreeIdentifier.of(path.datastore(), toYangInstanceIdentifier(path.path()));
  84     }
  85
  86     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
  87         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
  88     }
  89
  90     @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
  91         final var entry = resolvePath(spec.path());
  92         final var stack = entry.getKey();
  93         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
  94         verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
  95         return stack.toSchemaNodeIdentifier();
  96     }
  97
  98     @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
  99         final var entry = resolvePath(spec.path());
 100         final var stack = entry.getKey();
 101         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 102         verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
 103             spec, stmt);
 104         return stack.toSchemaNodeIdentifier();
 105     }
 106
 107     @Nullable ContextReferenceExtractor findExtractor(final @NonNull InputRuntimeType inputType) {
 108         final var inputName = inputType.getIdentifier();
 109         final var cached = extractors.get(inputName);
 110         if (cached != null) {
 111             return cached;
 112         }
 113
 114         // Load the class
 115         final Class<?> inputClass;
 116         try {
 117             inputClass = getRuntimeContext().loadClass(inputName);
 118         } catch (ClassNotFoundException e) {
 119             throw new IllegalArgumentException("Failed to load class for " + inputType, e);
 120         }
 121
 122         // Check if there is an extractor at all
 123         final var created = ContextReferenceExtractor.of(inputClass);
 124         if (created == null) {
 125             return null;
 126         }
 127
 128         // Reconcile with cache
 129         final var raced = extractors.putIfAbsent(inputName, created);
 130         return raced != null ? raced : created;
 131     }
 132
 133     private @NonNull Entry<SchemaInferenceStack, QNameModule> resolvePath(final @NonNull InstanceIdentifier<?> path) {
 134         final var stack = SchemaInferenceStack.of(getRuntimeContext().getEffectiveModelContext());
 135         final var it = toYangInstanceIdentifier(path).getPathArguments().iterator();
 136         verify(it.hasNext(), "Unexpected empty instance identifier for %s", path);
 137
 138         QNameModule lastNamespace;
 139         do {
 140             final var arg = it.next();
 141             final var qname = arg.getNodeType();
 142             final var stmt = stack.enterDataTree(qname);
 143             lastNamespace = qname.getModule();
 144             if (stmt instanceof ListEffectiveStatement) {
 145                 // Lists have two steps
 146                 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
 147                 // Verify just to make sure we are doing the right thing
 148                 final var skipped = it.next();
 149                 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
 150                 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
 151                     path);
 152             }
 153         } while (it.hasNext());
 154
 155         return Map.entry(stack, lastNamespace);
 156     }
 157 }