binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/DataContainerCodecContext.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableCollection;
  14 import com.google.common.collect.ImmutableSet;
  15 import java.io.IOException;
  16 import java.lang.invoke.MethodHandles;
  17 import java.lang.invoke.VarHandle;
  18 import java.lang.reflect.Method;
  19 import java.lang.reflect.Modifier;
  20 import java.lang.reflect.ParameterizedType;
  21 import java.util.Arrays;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import java.util.Set;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
  31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
  32 import org.opendaylight.mdsal.binding.dom.codec.api.IncorrectNestingException;
  33 import org.opendaylight.mdsal.binding.dom.codec.api.MissingClassInLoadingStrategyException;
  34 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
  35 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaForClassException;
  36 import org.opendaylight.mdsal.binding.model.api.Type;
  37 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  38 import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
  39 import org.opendaylight.mdsal.binding.runtime.api.RuntimeTypeContainer;
  40 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  41 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  42 import org.opendaylight.yangtools.yang.binding.Augmentation;
  43 import org.opendaylight.yangtools.yang.binding.BindingObject;
  44 import org.opendaylight.yangtools.yang.binding.DataContainer;
  45 import org.opendaylight.yangtools.yang.binding.DataObject;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  47 import org.opendaylight.yangtools.yang.common.QName;
  48 import org.opendaylight.yangtools.yang.common.QNameModule;
  49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 abstract class DataContainerCodecContext<D extends DataObject, T extends RuntimeTypeContainer> extends NodeCodecContext
  59         implements BindingDataObjectCodecTreeNode<D>  {
  60     private static final Logger LOG = LoggerFactory.getLogger(DataContainerCodecContext.class);
  61     private static final VarHandle EVENT_STREAM_SERIALIZER;
  62
  63     static {
  64         try {
  65             EVENT_STREAM_SERIALIZER = MethodHandles.lookup().findVarHandle(DataContainerCodecContext.class,
  66                 "eventStreamSerializer", DataObjectSerializer.class);
  67         } catch (NoSuchFieldException | IllegalAccessException e) {
  68             throw new ExceptionInInitializerError(e);
  69         }
  70     }
  71
  72     private final @NonNull DataContainerCodecPrototype<T> prototype;
  73
  74     // Accessed via a VarHandle
  75     @SuppressWarnings("unused")
  76     private volatile DataObjectSerializer eventStreamSerializer;
  77
  78     DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
  79         this.prototype = requireNonNull(prototype);
  80     }
  81
  82     public final @NonNull T getType() {
  83         return prototype.getType();
  84     }
  85
  86     @Override
  87     public final ChildAddressabilitySummary getChildAddressabilitySummary() {
  88         return prototype.getChildAddressabilitySummary();
  89     }
  90
  91     protected final QNameModule namespace() {
  92         return prototype.getNamespace();
  93     }
  94
  95     protected final CodecContextFactory factory() {
  96         return prototype.getFactory();
  97     }
  98
  99     @Override
 100     protected YangInstanceIdentifier.PathArgument getDomPathArgument() {
 101         return prototype.getYangArg();
 102     }
 103
 104     /**
 105      * Returns nested node context using supplied YANG Instance Identifier.
 106      *
 107      * @param arg Yang Instance Identifier Argument
 108      * @return Context of child
 109      * @throws IllegalArgumentException If supplied argument does not represent valid child.
 110      */
 111     @Override
 112     public abstract NodeCodecContext yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
 113
 114     /**
 115      * Returns nested node context using supplied Binding Instance Identifier
 116      * and adds YANG instance identifiers to supplied list.
 117      *
 118      * @param arg Binding Instance Identifier Argument
 119      * @return Context of child or null if supplied {@code arg} does not represent valid child.
 120      * @throws IllegalArgumentException If supplied argument does not represent valid child.
 121      */
 122     @Override
 123     public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final PathArgument arg,
 124             final List<YangInstanceIdentifier.PathArgument> builder) {
 125         final DataContainerCodecContext<?,?> child = streamChild(arg.getType());
 126         if (builder != null) {
 127             child.addYangPathArgument(arg,builder);
 128         }
 129         return child;
 130     }
 131
 132     /**
 133      * Returns deserialized Binding Path Argument from YANG instance identifier.
 134      */
 135     protected PathArgument getBindingPathArgument(final YangInstanceIdentifier.PathArgument domArg) {
 136         return bindingArg();
 137     }
 138
 139     protected final PathArgument bindingArg() {
 140         return prototype.getBindingArg();
 141     }
 142
 143     @SuppressWarnings("unchecked")
 144     @Override
 145     public final Class<D> getBindingClass() {
 146         return Class.class.cast(prototype.getBindingClass());
 147     }
 148
 149     @Override
 150     public abstract <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
 151
 152     /**
 153      * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
 154      * must issue getChild(ChoiceClass).getChild(CaseClass).
 155      *
 156      * @param childClass child class
 157      * @return Context of child or Optional.empty is supplied class is not applicable in context.
 158      */
 159     @Override
 160     public abstract <C extends DataObject> Optional<DataContainerCodecContext<C,?>> possibleStreamChild(
 161             Class<C> childClass);
 162
 163     @Override
 164     public String toString() {
 165         return getClass().getSimpleName() + " [" + prototype.getBindingClass() + "]";
 166     }
 167
 168     @Override
 169     public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
 170             final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
 171         if (cacheSpecifier.isEmpty()) {
 172             return new NonCachingCodec<>(this);
 173         }
 174         return new CachingNormalizedNodeCodec<>(this, ImmutableSet.copyOf(cacheSpecifier));
 175     }
 176
 177     protected final <V> @NonNull V childNonNull(final @Nullable V nullable,
 178             final YangInstanceIdentifier.PathArgument child, final String message, final Object... args) {
 179         if (nullable == null) {
 180             throw childNullException(extractName(child), message, args);
 181         }
 182         return nullable;
 183     }
 184
 185     protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final QName child, final String message,
 186             final Object... args) {
 187         if (nullable == null) {
 188             throw childNullException(child, message, args);
 189         }
 190         return nullable;
 191     }
 192
 193     protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final Class<?> childClass,
 194             final String message, final Object... args) {
 195         if (nullable == null) {
 196             throw childNullException(childClass, message, args);
 197         }
 198         return nullable;
 199     }
 200
 201     private IllegalArgumentException childNullException(final QName child, final String message, final Object... args) {
 202         final QNameModule module = child.getModule();
 203         if (!factory().getRuntimeContext().getEffectiveModelContext().findModule(module).isPresent()) {
 204             throw new MissingSchemaException("Module " + module + " is not present in current schema context.");
 205         }
 206         throw IncorrectNestingException.create(message, args);
 207     }
 208
 209     private IllegalArgumentException childNullException(final Class<?> childClass, final String message,
 210             final Object... args) {
 211         final BindingRuntimeContext runtimeContext = factory().getRuntimeContext();
 212         final CompositeRuntimeType schema;
 213         if (Augmentation.class.isAssignableFrom(childClass)) {
 214             schema = runtimeContext.getAugmentationDefinition(childClass.asSubclass(Augmentation.class));
 215         } else {
 216             schema = runtimeContext.getSchemaDefinition(childClass);
 217         }
 218         if (schema == null) {
 219             throw new MissingSchemaForClassException(childClass);
 220         }
 221
 222         try {
 223             runtimeContext.loadClass(Type.of(childClass));
 224         } catch (final ClassNotFoundException e) {
 225             throw new MissingClassInLoadingStrategyException(
 226                 "User supplied class " + childClass.getName() + " is not available in " + runtimeContext, e);
 227         }
 228
 229         throw IncorrectNestingException.create(message, args);
 230     }
 231
 232     private static QName extractName(final YangInstanceIdentifier.PathArgument child) {
 233         if (child instanceof AugmentationIdentifier) {
 234             final Set<QName> children = ((AugmentationIdentifier) child).getPossibleChildNames();
 235             checkArgument(!children.isEmpty(), "Augmentation without childs must not be used in data");
 236             return children.iterator().next();
 237         }
 238         return child.getNodeType();
 239     }
 240
 241     final DataObjectSerializer eventStreamSerializer() {
 242         final DataObjectSerializer existing = (DataObjectSerializer) EVENT_STREAM_SERIALIZER.getAcquire(this);
 243         return existing != null ? existing : loadEventStreamSerializer();
 244     }
 245
 246     // Split out to aid inlining
 247     private DataObjectSerializer loadEventStreamSerializer() {
 248         final DataObjectSerializer loaded = factory().getEventStreamSerializer(getBindingClass());
 249         final Object witness = EVENT_STREAM_SERIALIZER.compareAndExchangeRelease(this, null, loaded);
 250         return witness == null ? loaded : (DataObjectSerializer) witness;
 251     }
 252
 253     @Override
 254     public NormalizedNode serialize(final D data) {
 255         final NormalizedNodeResult result = new NormalizedNodeResult();
 256         // We create DOM stream writer which produces normalized nodes
 257         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 258         writeAsNormalizedNode(data, domWriter);
 259         return result.getResult();
 260     }
 261
 262     @Override
 263     public void writeAsNormalizedNode(final D data, final NormalizedNodeStreamWriter writer) {
 264         try {
 265             eventStreamSerializer().serialize(data, new BindingToNormalizedStreamWriter(this, writer));
 266         } catch (final IOException e) {
 267             throw new IllegalStateException("Failed to serialize Binding DTO",e);
 268         }
 269     }
 270
 271     static final <T extends NormalizedNode> @NonNull T checkDataArgument(final @NonNull Class<T> expectedType,
 272             final NormalizedNode data) {
 273         try {
 274             return expectedType.cast(requireNonNull(data));
 275         } catch (ClassCastException e) {
 276             throw new IllegalArgumentException("Expected " + expectedType.getSimpleName(), e);
 277         }
 278     }
 279
 280     // FIXME: MDSAL-780 replace this method with BindingRuntimeTypes-driven logic
 281     static final Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
 282             final String prefix) {
 283         final String methodName = method.getName();
 284         if ("getClass".equals(methodName) || !methodName.startsWith(prefix) || method.getParameterCount() > 0) {
 285             return Optional.empty();
 286         }
 287
 288         final Class<?> returnType = method.getReturnType();
 289         if (DataContainer.class.isAssignableFrom(returnType)) {
 290             return optionalDataContainer(returnType);
 291         } else if (List.class.isAssignableFrom(returnType)) {
 292             return getYangModeledReturnType(method, 0);
 293         } else if (Map.class.isAssignableFrom(returnType)) {
 294             return getYangModeledReturnType(method, 1);
 295         }
 296         return Optional.empty();
 297     }
 298
 299     @SuppressWarnings("checkstyle:illegalCatch")
 300     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
 301             final int parameterOffset) {
 302         try {
 303             return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(),
 304                 () -> genericParameter(method.getGenericReturnType(), parameterOffset)
 305                     .flatMap(result -> result instanceof Class ? optionalCast((Class<?>) result) : Optional.empty()));
 306         } catch (Exception e) {
 307             /*
 308              * It is safe to log this this exception on debug, since this
 309              * method should not fail. Only failures are possible if the
 310              * runtime / backing.
 311              */
 312             LOG.debug("Unable to find YANG modeled return type for {}", method, e);
 313         }
 314         return Optional.empty();
 315     }
 316
 317     private static Optional<java.lang.reflect.Type> genericParameter(final java.lang.reflect.Type type,
 318             final int offset) {
 319         if (type instanceof ParameterizedType parameterized) {
 320             final var parameters = parameterized.getActualTypeArguments();
 321             if (parameters.length > offset) {
 322                 return Optional.of(parameters[offset]);
 323             }
 324         }
 325         return Optional.empty();
 326     }
 327
 328     private static Optional<Class<? extends DataContainer>> optionalCast(final Class<?> type) {
 329         return DataContainer.class.isAssignableFrom(type) ? optionalDataContainer(type) : Optional.empty();
 330     }
 331
 332
 333     // FIXME: MDSAL-780: remove this method
 334     static final Optional<Class<? extends DataContainer>> optionalDataContainer(final Class<?> type) {
 335         return Optional.of(type.asSubclass(DataContainer.class));
 336     }
 337
 338
 339     /**
 340      * Determines if two augmentation classes or case classes represents same data.
 341      *
 342      * <p>
 343      * Two augmentations or cases could be substituted only if and if:
 344      * <ul>
 345      *   <li>Both implements same interfaces</li>
 346      *   <li>Both have same children</li>
 347      *   <li>If augmentations: Both have same augmentation target class. Target class was generated for data node in a
 348      *       grouping.</li>
 349      *   <li>If cases: Both are from same choice. Choice class was generated for data node in grouping.</li>
 350      * </ul>
 351      *
 352      * <p>
 353      * <b>Explanation:</b>
 354      * Binding Specification reuses classes generated for groupings as part of normal data tree, this classes from
 355      * grouping could be used at various locations and user may not be aware of it and may use incorrect case or
 356      * augmentation in particular subtree (via copy constructors, etc).
 357      *
 358      * @param potential Class which is potential substitution
 359      * @param target Class which should be used at particular subtree
 360      * @return true if and only if classes represents same data.
 361      * @throws NullPointerException if any argument is {@code null}
 362      */
 363     // FIXME: MDSAL-785: this really should live in BindingRuntimeTypes and should not be based on reflection. The only
 364     //                   user is binding-dom-codec and the logic could easily be performed on GeneratedType instead. For
 365     //                   a particular world this boils down to a matrix, which can be calculated either on-demand or
 366     //                   when we create BindingRuntimeTypes. Achieving that will bring us one step closer to being able
 367     //                   to have a pre-compiled Binding Runtime.
 368     @SuppressWarnings({ "rawtypes", "unchecked" })
 369     static boolean isSubstitutionFor(final Class potential, final Class target) {
 370         Set<Class> subImplemented = new HashSet<>(Arrays.asList(potential.getInterfaces()));
 371         Set<Class> targetImplemented = new HashSet<>(Arrays.asList(target.getInterfaces()));
 372         if (!subImplemented.equals(targetImplemented)) {
 373             return false;
 374         }
 375         if (Augmentation.class.isAssignableFrom(potential)
 376                 && !BindingReflections.findAugmentationTarget(potential).equals(
 377                         BindingReflections.findAugmentationTarget(target))) {
 378             return false;
 379         }
 380         for (Method potentialMethod : potential.getMethods()) {
 381             if (Modifier.isStatic(potentialMethod.getModifiers())) {
 382                 // Skip any static methods, as we are not interested in those
 383                 continue;
 384             }
 385
 386             try {
 387                 Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
 388                 if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
 389                     return false;
 390                 }
 391             } catch (NoSuchMethodException e) {
 392                 // Counterpart method is missing, so classes could not be substituted.
 393                 return false;
 394             } catch (SecurityException e) {
 395                 throw new IllegalStateException("Could not compare methods", e);
 396             }
 397         }
 398         return true;
 399     }
 400 }