2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.collect.ImmutableCollection;
13 import com.google.common.collect.ImmutableSet;
14 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
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;
25 import java.util.Optional;
27 import org.eclipse.jdt.annotation.NonNull;
28 import org.eclipse.jdt.annotation.Nullable;
29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCodec;
31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
32 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
33 import org.opendaylight.mdsal.binding.dom.codec.api.IncorrectNestingException;
34 import org.opendaylight.mdsal.binding.dom.codec.api.MissingClassInLoadingStrategyException;
35 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
36 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaForClassException;
37 import org.opendaylight.mdsal.binding.model.api.Type;
38 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
39 import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
40 import org.opendaylight.mdsal.binding.runtime.api.RuntimeTypeContainer;
41 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
42 import org.opendaylight.yangtools.util.ClassLoaderUtils;
43 import org.opendaylight.yangtools.yang.binding.Augmentation;
44 import org.opendaylight.yangtools.yang.binding.BindingObject;
45 import org.opendaylight.yangtools.yang.binding.DataContainer;
46 import org.opendaylight.yangtools.yang.binding.DataObject;
47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
48 import org.opendaylight.yangtools.yang.common.QName;
49 import org.opendaylight.yangtools.yang.common.QNameModule;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
53 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
54 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
55 import org.slf4j.Logger;
56 import org.slf4j.LoggerFactory;
58 abstract sealed class DataContainerCodecContext<D extends DataObject, T extends RuntimeTypeContainer>
59 extends CodecContext implements CommonDataObjectCodecTreeNode<D>
60 permits AbstractDataObjectCodecContext, ChoiceCodecContext, RootCodecContext {
61 private static final Logger LOG = LoggerFactory.getLogger(DataContainerCodecContext.class);
62 private static final VarHandle EVENT_STREAM_SERIALIZER;
66 EVENT_STREAM_SERIALIZER = MethodHandles.lookup().findVarHandle(DataContainerCodecContext.class,
67 "eventStreamSerializer", DataObjectSerializer.class);
68 } catch (NoSuchFieldException | IllegalAccessException e) {
69 throw new ExceptionInInitializerError(e);
73 final @NonNull DataContainerCodecPrototype<T> prototype;
75 // Accessed via a VarHandle
76 @SuppressWarnings("unused")
77 private volatile DataObjectSerializer eventStreamSerializer;
79 DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
80 this.prototype = requireNonNull(prototype);
83 public final @NonNull T getType() {
84 return prototype.getType();
88 public final ChildAddressabilitySummary getChildAddressabilitySummary() {
89 return prototype.getChildAddressabilitySummary();
92 protected final QNameModule namespace() {
93 return prototype.getNamespace();
96 protected final CodecContextFactory factory() {
97 return prototype.getFactory();
101 protected NodeIdentifier getDomPathArgument() {
102 return prototype.getYangArg();
106 * Returns nested node context using supplied YANG Instance Identifier.
108 * @param arg Yang Instance Identifier Argument
109 * @return Context of child
110 * @throws IllegalArgumentException If supplied argument does not represent valid child.
113 public abstract CodecContext yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
116 * Returns nested node context using supplied Binding Instance Identifier
117 * and adds YANG instance identifiers to supplied list.
119 * @param arg Binding Instance Identifier Argument
120 * @return Context of child or null if supplied {@code arg} does not represent valid child.
121 * @throws IllegalArgumentException If supplied argument does not represent valid child.
124 public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final PathArgument arg,
125 final List<YangInstanceIdentifier.PathArgument> builder) {
126 final DataContainerCodecContext<?, ?> child = streamChild(arg.getType());
127 if (builder != null) {
128 child.addYangPathArgument(arg, builder);
134 * Serializes supplied Binding Path Argument and adds all necessary YANG instance identifiers to supplied list.
136 * @param arg Binding Path Argument
137 * @param builder DOM Path argument.
139 void addYangPathArgument(final PathArgument arg, final List<YangInstanceIdentifier.PathArgument> builder) {
140 if (builder != null) {
141 final var yangArg = getDomPathArgument();
142 if (yangArg != null) {
143 builder.add(yangArg);
149 * Returns deserialized Binding Path Argument from YANG instance identifier.
151 protected PathArgument getBindingPathArgument(final YangInstanceIdentifier.PathArgument domArg) {
155 protected final PathArgument bindingArg() {
156 return prototype.getBindingArg();
159 @SuppressWarnings("unchecked")
161 public final Class<D> getBindingClass() {
162 return Class.class.cast(prototype.getBindingClass());
166 public abstract <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
169 * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
170 * must issue getChild(ChoiceClass).getChild(CaseClass).
172 * @param childClass child class
173 * @return Context of child or Optional.empty is supplied class is not applicable in context.
176 public abstract <C extends DataObject> Optional<DataContainerCodecContext<C,?>> possibleStreamChild(
177 Class<C> childClass);
180 public String toString() {
181 return getClass().getSimpleName() + " [" + prototype.getBindingClass() + "]";
184 static final <T extends DataObject, C extends DataContainerCodecContext<T, ?> & BindingNormalizedNodeCodec<T>>
185 @NonNull BindingNormalizedNodeCachingCodec<T> createCachingCodec(final C context,
186 final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
187 return cacheSpecifier.isEmpty() ? new NonCachingCodec<>(context)
188 : new CachingNormalizedNodeCodec<>(context, ImmutableSet.copyOf(cacheSpecifier));
191 protected final <V> @NonNull V childNonNull(final @Nullable V nullable,
192 final YangInstanceIdentifier.PathArgument child, final String message, final Object... args) {
193 if (nullable == null) {
194 throw childNullException(child.getNodeType(), message, args);
199 protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final QName child, final String message,
200 final Object... args) {
201 if (nullable == null) {
202 throw childNullException(child, message, args);
207 protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final Class<?> childClass,
208 final String message, final Object... args) {
209 if (nullable == null) {
210 throw childNullException(childClass, message, args);
216 private IllegalArgumentException childNullException(final QName child, final String message, final Object... args) {
217 final QNameModule module = child.getModule();
218 if (!factory().getRuntimeContext().getEffectiveModelContext().findModule(module).isPresent()) {
219 return new MissingSchemaException("Module " + module + " is not present in current schema context.");
221 return new IncorrectNestingException(message, args);
225 private @NonNull IllegalArgumentException childNullException(final Class<?> childClass, final String message,
226 final Object... args) {
227 return childNullException(factory().getRuntimeContext(), childClass, message, args);
231 static @NonNull IllegalArgumentException childNullException(final BindingRuntimeContext runtimeContext,
232 final Class<?> childClass, final String message, final Object... args) {
233 final CompositeRuntimeType schema;
234 if (Augmentation.class.isAssignableFrom(childClass)) {
235 schema = runtimeContext.getAugmentationDefinition(childClass.asSubclass(Augmentation.class));
237 schema = runtimeContext.getSchemaDefinition(childClass);
239 if (schema == null) {
240 return new MissingSchemaForClassException(childClass);
244 runtimeContext.loadClass(Type.of(childClass));
245 } catch (final ClassNotFoundException e) {
246 return new MissingClassInLoadingStrategyException(
247 "User supplied class " + childClass.getName() + " is not available in " + runtimeContext, e);
250 return new IncorrectNestingException(message, args);
253 final DataObjectSerializer eventStreamSerializer() {
254 final DataObjectSerializer existing = (DataObjectSerializer) EVENT_STREAM_SERIALIZER.getAcquire(this);
255 return existing != null ? existing : loadEventStreamSerializer();
258 // Split out to aid inlining
259 private DataObjectSerializer loadEventStreamSerializer() {
260 final DataObjectSerializer loaded = factory().getEventStreamSerializer(getBindingClass());
261 final Object witness = EVENT_STREAM_SERIALIZER.compareAndExchangeRelease(this, null, loaded);
262 return witness == null ? loaded : (DataObjectSerializer) witness;
265 final @NonNull NormalizedNode serializeImpl(final @NonNull D data) {
266 final var result = new NormalizationResultHolder();
267 // We create DOM stream writer which produces normalized nodes
268 final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
270 eventStreamSerializer().serialize(data, new BindingToNormalizedStreamWriter(this, domWriter));
271 } catch (final IOException e) {
272 throw new IllegalStateException("Failed to serialize Binding DTO",e);
274 return result.getResult().data();
277 static final <T extends NormalizedNode> @NonNull T checkDataArgument(final @NonNull Class<T> expectedType,
278 final NormalizedNode data) {
280 return expectedType.cast(requireNonNull(data));
281 } catch (ClassCastException e) {
282 throw new IllegalArgumentException("Expected " + expectedType.getSimpleName(), e);
286 // FIXME: MDSAL-780 replace this method with BindingRuntimeTypes-driven logic
287 static final Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
288 final String prefix) {
289 final String methodName = method.getName();
290 if ("getClass".equals(methodName) || !methodName.startsWith(prefix) || method.getParameterCount() > 0) {
291 return Optional.empty();
294 final Class<?> returnType = method.getReturnType();
295 if (DataContainer.class.isAssignableFrom(returnType)) {
296 return optionalDataContainer(returnType);
297 } else if (List.class.isAssignableFrom(returnType)) {
298 return getYangModeledReturnType(method, 0);
299 } else if (Map.class.isAssignableFrom(returnType)) {
300 return getYangModeledReturnType(method, 1);
302 return Optional.empty();
305 @SuppressWarnings("checkstyle:illegalCatch")
306 private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method,
307 final int parameterOffset) {
309 return ClassLoaderUtils.callWithClassLoader(method.getDeclaringClass().getClassLoader(),
310 () -> genericParameter(method.getGenericReturnType(), parameterOffset)
311 .flatMap(result -> result instanceof Class ? optionalCast((Class<?>) result) : Optional.empty()));
312 } catch (Exception e) {
314 * It is safe to log this this exception on debug, since this
315 * method should not fail. Only failures are possible if the
318 LOG.debug("Unable to find YANG modeled return type for {}", method, e);
320 return Optional.empty();
323 private static Optional<java.lang.reflect.Type> genericParameter(final java.lang.reflect.Type type,
325 if (type instanceof ParameterizedType parameterized) {
326 final var parameters = parameterized.getActualTypeArguments();
327 if (parameters.length > offset) {
328 return Optional.of(parameters[offset]);
331 return Optional.empty();
334 private static Optional<Class<? extends DataContainer>> optionalCast(final Class<?> type) {
335 return DataContainer.class.isAssignableFrom(type) ? optionalDataContainer(type) : Optional.empty();
338 // FIXME: MDSAL-780: remove this method
339 static final Optional<Class<? extends DataContainer>> optionalDataContainer(final Class<?> type) {
340 return Optional.of(type.asSubclass(DataContainer.class));
344 * Determines if two augmentation classes or case classes represents same data.
347 * Two augmentations or cases could be substituted only if and if:
349 * <li>Both implements same interfaces</li>
350 * <li>Both have same children</li>
351 * <li>If augmentations: Both have same augmentation target class. Target class was generated for data node in a
353 * <li>If cases: Both are from same choice. Choice class was generated for data node in grouping.</li>
357 * <b>Explanation:</b>
358 * Binding Specification reuses classes generated for groupings as part of normal data tree, this classes from
359 * grouping could be used at various locations and user may not be aware of it and may use incorrect case or
360 * augmentation in particular subtree (via copy constructors, etc).
362 * @param potential Class which is potential substitution
363 * @param target Class which should be used at particular subtree
364 * @return true if and only if classes represents same data.
365 * @throws NullPointerException if any argument is {@code null}
367 // FIXME: MDSAL-785: this really should live in BindingRuntimeTypes and should not be based on reflection. The only
368 // user is binding-dom-codec and the logic could easily be performed on GeneratedType instead. For
369 // a particular world this boils down to a matrix, which can be calculated either on-demand or
370 // when we create BindingRuntimeTypes. Achieving that will bring us one step closer to being able
371 // to have a pre-compiled Binding Runtime.
372 @SuppressWarnings({ "rawtypes", "unchecked" })
373 static final boolean isSubstitutionFor(final Class potential, final Class target) {
374 Set<Class> subImplemented = new HashSet<>(Arrays.asList(potential.getInterfaces()));
375 Set<Class> targetImplemented = new HashSet<>(Arrays.asList(target.getInterfaces()));
376 if (!subImplemented.equals(targetImplemented)) {
379 if (Augmentation.class.isAssignableFrom(potential)
380 && !BindingReflections.findAugmentationTarget(potential).equals(
381 BindingReflections.findAugmentationTarget(target))) {
384 for (Method potentialMethod : potential.getMethods()) {
385 if (Modifier.isStatic(potentialMethod.getModifiers())) {
386 // Skip any static methods, as we are not interested in those
391 Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
392 if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
395 } catch (NoSuchMethodException e) {
396 // Counterpart method is missing, so classes could not be substituted.
398 } catch (SecurityException e) {
399 throw new IllegalStateException("Could not compare methods", e);