import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.annotations.Beta;
+import com.google.common.base.Throwables;
+import com.google.common.base.VerifyException;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodType;
import java.lang.invoke.VarHandle;
import java.lang.reflect.Method;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.binding.model.api.GeneratedType;
import org.opendaylight.mdsal.binding.model.api.Type;
import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
+import org.opendaylight.mdsal.binding.runtime.api.AugmentableRuntimeType;
import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
-import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
+import org.opendaylight.yangtools.yang.binding.Augmentable;
import org.opendaylight.yangtools.yang.binding.Augmentation;
import org.opendaylight.yangtools.yang.binding.BindingObject;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
* This class is an implementation detail. It is public only due to technical reasons and may change at any time.
*/
@Beta
-public abstract class DataObjectCodecContext<D extends DataObject, T extends CompositeRuntimeType>
- extends AbstractDataObjectCodecContext<D, T> implements BindingDataObjectCodecTreeNode<D> {
+public abstract sealed class DataObjectCodecContext<D extends DataObject, T extends CompositeRuntimeType>
+ extends AbstractDataObjectCodecContext<D, T> implements BindingDataObjectCodecTreeNode<D>
+ permits CaseCodecContext, ContainerLikeCodecContext, ListCodecContext, NotificationCodecContext {
private static final Logger LOG = LoggerFactory.getLogger(DataObjectCodecContext.class);
+ private static final MethodType CONSTRUCTOR_TYPE = MethodType.methodType(void.class,
+ AbstractDataObjectCodecContext.class, DataContainerNode.class);
+ private static final MethodType DATAOBJECT_TYPE = MethodType.methodType(DataObject.class,
+ DataObjectCodecContext.class, DataContainerNode.class);
private static final VarHandle MISMATCHED_AUGMENTED;
static {
}
}
- private final ImmutableMap<Class<?>, DataContainerCodecPrototype.Augmentation> augmentToPrototype;
+ private final ImmutableMap<Class<?>, AugmentationCodecPrototype> augmentToPrototype;
private final ImmutableMap<NodeIdentifier, Class<?>> yangToAugmentClass;
private final @NonNull Class<? extends CodecDataObject<?>> generatedClass;
+ private final MethodHandle proxyConstructor;
// Note this the content of this field depends only of invariants expressed as this class's fields or
// BindingRuntimeContext. It is only accessed via MISMATCHED_AUGMENTED above.
@SuppressWarnings("unused")
- private volatile ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> mismatchedAugmented = ImmutableMap.of();
+ @SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "https://github.com/spotbugs/spotbugs/issues/2749")
+ private volatile ImmutableMap<Class<?>, CommonDataObjectCodecPrototype<?>> mismatchedAugmented = ImmutableMap.of();
- DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype) {
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype) {
this(prototype, CodecItemFactory.of());
}
- DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype, final CodecItemFactory itemFactory) {
- this(prototype, new CodecDataObjectAnalysis<>(prototype, itemFactory, null));
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype, final CodecItemFactory itemFactory) {
+ this(prototype, new DataContainerAnalysis<>(prototype, itemFactory), null);
}
- DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype, final Method keyMethod) {
- this(prototype, new CodecDataObjectAnalysis<>(prototype, CodecItemFactory.of(), keyMethod));
+ DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype, final Method keyMethod) {
+ this(prototype, new DataContainerAnalysis<>(prototype, CodecItemFactory.of()), keyMethod);
}
- private DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype,
- final CodecDataObjectAnalysis<T> analysis) {
+ private DataObjectCodecContext(final CommonDataObjectCodecPrototype<T> prototype,
+ final DataContainerAnalysis<T> analysis, final Method keyMethod) {
super(prototype, analysis);
- // Inherit analysis stuff
- generatedClass = analysis.generatedClass;
+ final var bindingClass = getBindingClass();
+
+ // Final bits: generate the appropriate class, As a side effect we identify what Augmentations are possible
+ final List<AugmentRuntimeType> possibleAugmentations;
+ if (Augmentable.class.isAssignableFrom(bindingClass)) {
+ // Verify we have the appropriate backing runtimeType
+ final var runtimeType = prototype.runtimeType();
+ if (!(runtimeType instanceof AugmentableRuntimeType augmentableRuntimeType)) {
+ throw new VerifyException(
+ "Unexpected type %s backing augmenable %s".formatted(runtimeType, bindingClass));
+ }
+
+ possibleAugmentations = augmentableRuntimeType.augments();
+ generatedClass = CodecDataObjectGenerator.generateAugmentable(factory().getLoader(), bindingClass,
+ analysis.leafContexts, analysis.daoProperties, keyMethod);
+ } else {
+ possibleAugmentations = List.of();
+ generatedClass = CodecDataObjectGenerator.generate(factory().getLoader(), bindingClass,
+ analysis.leafContexts, analysis.daoProperties, keyMethod);
+ }
+
+ // All done: acquire the constructor: it is supposed to be public
+ final MethodHandle ctor;
+ try {
+ ctor = MethodHandles.publicLookup().findConstructor(generatedClass, CONSTRUCTOR_TYPE);
+ } catch (NoSuchMethodException | IllegalAccessException e) {
+ throw new LinkageError("Failed to find contructor for class " + generatedClass, e);
+ }
+
+ proxyConstructor = ctor.asType(DATAOBJECT_TYPE);
// Deal with augmentations, which are not something we analysis provides
final var augPathToBinding = new HashMap<NodeIdentifier, Class<?>>();
- final var augClassToProto = new HashMap<Class<?>, DataContainerCodecPrototype.Augmentation>();
- for (var augment : analysis.possibleAugmentations) {
+ final var augClassToProto = new HashMap<Class<?>, AugmentationCodecPrototype>();
+ for (var augment : possibleAugmentations) {
final var augProto = loadAugmentPrototype(augment);
if (augProto != null) {
- final var augBindingClass = augProto.getBindingClass();
+ final var augBindingClass = augProto.javaClass();
for (var childPath : augProto.getChildArgs()) {
augPathToBinding.putIfAbsent(childPath, augBindingClass);
}
}
@Override
- final DataContainerCodecPrototype<?> pathChildPrototype(final Class<? extends DataObject> argType) {
+ final CommonDataObjectCodecPrototype<?> pathChildPrototype(final Class<? extends DataObject> argType) {
final var child = super.pathChildPrototype(argType);
return child != null ? child : augmentToPrototype.get(argType);
}
@Override
- final DataContainerCodecPrototype<?> streamChildPrototype(final Class<?> childClass) {
+ final CommonDataObjectCodecPrototype<?> streamChildPrototype(final Class<?> childClass) {
final var child = super.streamChildPrototype(childClass);
if (child == null && Augmentation.class.isAssignableFrom(childClass)) {
return getAugmentationProtoByClass(childClass);
}
@Override
- final NodeContextSupplier yangChildSupplier(final NodeIdentifier arg) {
+ final CodecContextSupplier yangChildSupplier(final NodeIdentifier arg) {
final var child = super.yangChildSupplier(arg);
if (child == null) {
final var augClass = yangToAugmentClass.get(arg);
return child;
}
- private DataContainerCodecPrototype.@Nullable Augmentation getAugmentationProtoByClass(
- final @NonNull Class<?> augmClass) {
+ private @Nullable AugmentationCodecPrototype getAugmentationProtoByClass(final @NonNull Class<?> augmClass) {
final var childProto = augmentToPrototype.get(augmClass);
return childProto != null ? childProto : mismatchedAugmentationByClass(augmClass);
}
- private DataContainerCodecPrototype.@Nullable Augmentation mismatchedAugmentationByClass(
- final @NonNull Class<?> childClass) {
+ private @Nullable AugmentationCodecPrototype mismatchedAugmentationByClass(final @NonNull Class<?> childClass) {
/*
* It is potentially mismatched valid augmentation - we look up equivalent augmentation using reflection
* and walk all stream child and compare augmentations classes if they are equivalent. When we find a match
* we'll cache it so we do not need to perform reflection operations again.
*/
- final var local =
- (ImmutableMap<Class<?>, DataContainerCodecPrototype.Augmentation>) MISMATCHED_AUGMENTED.getAcquire(this);
+ final var local = (ImmutableMap<Class<?>, AugmentationCodecPrototype>) MISMATCHED_AUGMENTED.getAcquire(this);
final var mismatched = local.get(childClass);
return mismatched != null ? mismatched : loadMismatchedAugmentation(local, childClass);
}
- private DataContainerCodecPrototype.@Nullable Augmentation loadMismatchedAugmentation(
- final ImmutableMap<Class<?>, DataContainerCodecPrototype.Augmentation> oldMismatched,
+ private @Nullable AugmentationCodecPrototype loadMismatchedAugmentation(
+ final ImmutableMap<Class<?>, AugmentationCodecPrototype> oldMismatched,
final @NonNull Class<?> childClass) {
@SuppressWarnings("rawtypes")
- final Class<?> augTarget = BindingReflections.findAugmentationTarget((Class) childClass);
+ final Class<?> augTarget = findAugmentationTarget((Class) childClass);
// Do not bother with proposals which are not augmentations of our class, or do not match what the runtime
// context would load.
if (getBindingClass().equals(augTarget) && belongsToRuntimeContext(childClass)) {
for (var realChild : augmentToPrototype.values()) {
- if (Augmentation.class.isAssignableFrom(realChild.getBindingClass())
- && isSubstitutionFor(childClass, realChild.getBindingClass())) {
+ final var realClass = realChild.javaClass();
+ if (Augmentation.class.isAssignableFrom(realClass) && isSubstitutionFor(childClass, realClass)) {
return cacheMismatched(oldMismatched, childClass, realChild);
}
}
return null;
}
- private DataContainerCodecPrototype.@NonNull Augmentation cacheMismatched(
- final @NonNull ImmutableMap<Class<?>, DataContainerCodecPrototype.Augmentation> oldMismatched,
- final @NonNull Class<?> childClass, final DataContainerCodecPrototype.@NonNull Augmentation prototype) {
-
+ private @NonNull AugmentationCodecPrototype cacheMismatched(
+ final @NonNull ImmutableMap<Class<?>, AugmentationCodecPrototype> oldMismatched,
+ final @NonNull Class<?> childClass, final @NonNull AugmentationCodecPrototype prototype) {
var expected = oldMismatched;
while (true) {
final var newMismatched =
- ImmutableMap.<Class<?>, DataContainerCodecPrototype<?>>builderWithExpectedSize(expected.size() + 1)
+ ImmutableMap.<Class<?>, CommonDataObjectCodecPrototype<?>>builderWithExpectedSize(expected.size() + 1)
.putAll(expected)
.put(childClass, prototype)
.build();
- final var witness = (ImmutableMap<Class<?>, DataContainerCodecPrototype.Augmentation>)
+ final var witness = (ImmutableMap<Class<?>, AugmentationCodecPrototype>)
MISMATCHED_AUGMENTED.compareAndExchangeRelease(this, expected, newMismatched);
if (witness == expected) {
LOG.trace("Cached mismatched augmentation {} -> {} in {}", childClass, prototype, this);
return cls.equals(loaded);
}
- private DataContainerCodecPrototype.@Nullable Augmentation loadAugmentPrototype(final AugmentRuntimeType augment) {
+ private @Nullable AugmentationCodecPrototype loadAugmentPrototype(final AugmentRuntimeType augment) {
// FIXME: in face of deviations this code should be looking at declared view, i.e. all possibilities at augment
// declaration site
final var childPaths = augment.statement()
.map(stmt -> new NodeIdentifier((QName) stmt.argument()))
.collect(ImmutableSet.toImmutableSet());
- final var it = childPaths.iterator();
- if (!it.hasNext()) {
+ if (childPaths.isEmpty()) {
return null;
}
- final var namespace = it.next().getNodeType().getModule();
final var factory = factory();
final GeneratedType javaType = augment.javaType();
throw new IllegalStateException(
"RuntimeContext references type " + javaType + " but failed to load its class", e);
}
- return new DataContainerCodecPrototype.Augmentation(augClass, namespace, augment, factory, childPaths);
+ return new AugmentationCodecPrototype(augClass, augment, factory, childPaths);
}
@Override
@SuppressWarnings("unchecked")
- Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(
- final DistinctNodeContainer<PathArgument, NormalizedNode> data) {
+ Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(final DataContainerNode data) {
/**
* Due to augmentation fields are at same level as direct children the data of each augmentation needs to be
* aggregated into own container node, then only deserialized using associated prototype.
final var bindingClass = entry.getKey();
final var codecProto = augmentToPrototype.get(bindingClass);
if (codecProto != null) {
- map.put(bindingClass, codecProto.get().deserializeObject(entry.getValue().build()));
+ final var bindingObj = codecProto.getCodecContext().deserializeObject(entry.getValue().build());
+ if (bindingObj != null) {
+ map.put(bindingClass, bindingObj);
+ }
}
}
return map;
}
- final @NonNull Class<? extends CodecDataObject<?>> generatedClass() {
- return generatedClass;
- }
-
@Override
public InstanceIdentifier.PathArgument deserializePathArgument(final PathArgument arg) {
checkArgument(getDomPathArgument().equals(arg));
final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
return createCachingCodec(this, cacheSpecifier);
}
+
+ final @NonNull Class<? extends CodecDataObject<?>> generatedClass() {
+ return generatedClass;
+ }
+
+ @SuppressWarnings("checkstyle:illegalCatch")
+ final @NonNull D createBindingProxy(final DataContainerNode node) {
+ try {
+ return (D) proxyConstructor.invokeExact(this, node);
+ } catch (final Throwable e) {
+ Throwables.throwIfUnchecked(e);
+ throw new IllegalStateException(e);
+ }
+ }
}