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