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 com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static com.google.common.base.Verify.verify;
13 import static com.google.common.base.Verify.verifyNotNull;
14 import static java.util.Objects.requireNonNull;
16 import com.google.common.base.Strings;
17 import com.google.common.cache.CacheBuilder;
18 import com.google.common.cache.CacheLoader;
19 import com.google.common.cache.LoadingCache;
20 import com.google.common.collect.ImmutableList;
21 import com.google.common.collect.ImmutableMap;
22 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
24 import java.io.IOException;
25 import java.lang.reflect.Method;
26 import java.lang.reflect.ParameterizedType;
27 import java.lang.reflect.Type;
28 import java.lang.reflect.WildcardType;
29 import java.time.Instant;
30 import java.util.ArrayList;
31 import java.util.Collection;
32 import java.util.HashMap;
33 import java.util.List;
35 import java.util.Map.Entry;
36 import java.util.Optional;
37 import java.util.ServiceLoader;
38 import java.util.concurrent.ExecutionException;
39 import org.eclipse.jdt.annotation.NonNull;
40 import org.eclipse.jdt.annotation.Nullable;
41 import org.kohsuke.MetaInfServices;
42 import org.opendaylight.mdsal.binding.dom.codec.api.BindingAugmentationCodecTreeNode;
43 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
44 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
45 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
47 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
48 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
49 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
50 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
51 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
52 import org.opendaylight.mdsal.binding.loader.BindingClassLoader;
53 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
54 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
55 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
56 import org.opendaylight.yangtools.concepts.Immutable;
57 import org.opendaylight.yangtools.util.ClassLoaderUtils;
58 import org.opendaylight.yangtools.yang.binding.Action;
59 import org.opendaylight.yangtools.yang.binding.Augmentation;
60 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
61 import org.opendaylight.yangtools.yang.binding.BaseNotification;
62 import org.opendaylight.yangtools.yang.binding.DataContainer;
63 import org.opendaylight.yangtools.yang.binding.DataObject;
64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
66 import org.opendaylight.yangtools.yang.binding.Key;
67 import org.opendaylight.yangtools.yang.binding.KeyAware;
68 import org.opendaylight.yangtools.yang.binding.Notification;
69 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
70 import org.opendaylight.yangtools.yang.binding.RpcInput;
71 import org.opendaylight.yangtools.yang.binding.RpcOutput;
72 import org.opendaylight.yangtools.yang.common.QName;
73 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
75 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
76 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
77 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
79 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
82 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
83 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
84 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
85 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
90 import org.opendaylight.yangtools.yang.model.api.TypeAware;
91 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
92 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
93 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
94 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
95 import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
96 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
98 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
99 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
100 import org.slf4j.Logger;
101 import org.slf4j.LoggerFactory;
103 @MetaInfServices(value = BindingDOMCodecServices.class)
104 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
105 implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataContainerSerializerRegistry {
106 private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
107 private static final @NonNull NodeIdentifier FAKE_NODEID = new NodeIdentifier(QName.create("fake", "fake"));
108 private static final File BYTECODE_DIRECTORY;
111 final String dir = System.getProperty("org.opendaylight.mdsal.binding.dom.codec.loader.bytecodeDumpDirectory");
112 BYTECODE_DIRECTORY = Strings.isNullOrEmpty(dir) ? null : new File(dir);
115 private final LoadingCache<Class<?>, DataContainerStreamer<?>> streamers = CacheBuilder.newBuilder()
116 .build(new CacheLoader<>() {
118 public DataContainerStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
119 final var streamer = DataContainerStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
121 final var instance = streamer.getDeclaredField(DataContainerStreamerGenerator.INSTANCE_FIELD);
122 return (DataContainerStreamer<?>) instance.get(null);
125 private final LoadingCache<Class<?>, DataContainerSerializer> serializers = CacheBuilder.newBuilder()
126 .build(new CacheLoader<>() {
128 public DataContainerSerializer load(final Class<?> key) throws ExecutionException {
129 return new DataContainerSerializer(BindingCodecContext.this, streamers.get(key));
133 private final @NonNull BindingClassLoader loader =
134 BindingClassLoader.create(BindingCodecContext.class, BYTECODE_DIRECTORY);
135 private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
136 private final @NonNull IdentityCodec identityCodec;
137 private final @NonNull BindingRuntimeContext context;
138 private final @NonNull RootCodecContext<?> root;
140 public BindingCodecContext() {
141 this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
142 .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
145 public BindingCodecContext(final BindingRuntimeContext context) {
146 this.context = requireNonNull(context, "Binding Runtime Context is required.");
147 root = new RootCodecContext<>(this);
148 identityCodec = new IdentityCodec(context);
149 instanceIdentifierCodec = new InstanceIdentifierCodec(this);
153 public BindingRuntimeContext getRuntimeContext() {
158 public BindingClassLoader getLoader() {
163 public IdentityCodec getIdentityCodec() {
164 return identityCodec;
168 public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
169 return instanceIdentifierCodec;
173 public DataContainerSerializer getEventStreamSerializer(final Class<?> type) {
174 return serializers.getUnchecked(type);
178 public DataContainerStreamer<?> getDataContainerStreamer(final Class<?> type) {
179 return streamers.getUnchecked(type);
183 public DataContainerSerializer getSerializer(final Class<? extends DataContainer> type) {
184 return serializers.getUnchecked(type);
188 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
189 final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
190 final var yangArgs = new ArrayList<YangInstanceIdentifier.PathArgument>();
191 final var codecContext = getCodecContextNode(path, yangArgs);
192 return Map.entry(YangInstanceIdentifier.of(yangArgs),
193 new BindingToNormalizedStreamWriter(codecContext, domWriter));
197 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
198 final NormalizedNodeStreamWriter domWriter) {
199 return new BindingToNormalizedStreamWriter(getCodecContextNode(path, null), domWriter);
203 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
204 final NormalizedNodeStreamWriter domWriter) {
205 return new BindingToNormalizedStreamWriter(root.getRpc(rpcInputOrOutput), domWriter);
209 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
210 final NormalizedNodeStreamWriter domWriter) {
211 return new BindingToNormalizedStreamWriter(root.getNotification(notification), domWriter);
215 public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
216 final NormalizedNodeStreamWriter domWriter) {
217 return new BindingToNormalizedStreamWriter(getActionCodec(action).input(), domWriter);
221 public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
222 final NormalizedNodeStreamWriter domWriter) {
223 return new BindingToNormalizedStreamWriter(getActionCodec(action).output(), domWriter);
226 @NonNull DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
227 final List<YangInstanceIdentifier.PathArgument> builder) {
228 DataContainerCodecContext<?, ?> current = root;
229 for (var bindingArg : binding.getPathArguments()) {
230 current = current.bindingPathArgumentChild(bindingArg, builder);
236 * Multi-purpose utility function. Traverse the codec tree, looking for
237 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
238 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
239 * into the supplied collection.
241 * @param dom {@link YangInstanceIdentifier} which is to be translated
242 * @param bindingArguments Collection for traversed path arguments
243 * @return Codec for target node, or @null if the node does not have a
244 * binding representation (choice, case, leaf).
247 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
248 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
249 CodecContext currentNode = root;
250 ListCodecContext<?> currentList = null;
252 for (var domArg : dom.getPathArguments()) {
253 checkArgument(currentNode instanceof DataContainerCodecContext,
254 "Unexpected child of non-container node %s", currentNode);
255 final var previous = (DataContainerCodecContext<?, ?>) currentNode;
256 var nextNode = previous.yangPathArgumentChild(domArg);
259 * Compatibility case: if it's determined the node belongs to augmentation
260 * then insert augmentation path argument in between.
262 if (nextNode instanceof AugmentationCodecContext<?> augmContext) {
263 if (bindingArguments != null) {
264 bindingArguments.add(augmContext.bindingArg());
266 currentNode = nextNode;
267 nextNode = augmContext.yangPathArgumentChild(domArg);
271 * List representation in YANG Instance Identifier consists of two
272 * arguments: first is list as a whole, second is list as an item so
273 * if it is /list it means list as whole, if it is /list/list - it
274 * is wildcarded and if it is /list/list[key] it is concrete item,
275 * all this variations are expressed in Binding Aware Instance
276 * Identifier as Item or IdentifiableItem
278 if (currentList != null) {
279 checkArgument(currentList == nextNode,
280 "List should be referenced two times in YANG Instance Identifier %s", dom);
282 // We entered list, so now we have all information to emit
283 // list path using second list argument.
284 if (bindingArguments != null) {
285 bindingArguments.add(currentList.getBindingPathArgument(domArg));
288 currentNode = nextNode;
289 } else if (nextNode instanceof ListCodecContext<?> listNode) {
290 // We enter list, we do not update current Node yet,
291 // since we need to verify
292 currentList = listNode;
293 } else if (nextNode instanceof ChoiceCodecContext) {
294 // We do not add path argument for choice, since
295 // it is not supported by binding instance identifier.
296 currentNode = nextNode;
297 } else if (nextNode instanceof CommonDataObjectCodecContext<?, ?> containerNode) {
298 if (bindingArguments != null) {
299 bindingArguments.add(containerNode.getBindingPathArgument(domArg));
301 currentNode = nextNode;
302 } else if (nextNode instanceof ValueNodeCodecContext) {
303 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
308 // Algorithm ended in list as whole representation
309 // we sill need to emit identifier for list
310 if (currentNode instanceof ChoiceCodecContext) {
311 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
314 if (currentNode instanceof CaseCodecContext) {
315 LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
319 if (currentList != null) {
320 if (bindingArguments != null) {
321 bindingArguments.add(currentList.getBindingPathArgument(null));
325 if (currentNode != null) {
326 verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
328 return (BindingDataObjectCodecTreeNode<?>) currentNode;
333 NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
334 return root.getNotification(notification);
337 RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
338 return root.getRpc(containerPath);
341 ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
342 return root.getAction(action);
346 public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
347 final EffectiveStatement<?, ?> schema) {
348 final var getterToLeafSchema = new HashMap<String, DataSchemaNode>();
349 for (var stmt : schema.effectiveSubstatements()) {
350 if (stmt instanceof TypedDataSchemaNode typedSchema) {
351 putLeaf(getterToLeafSchema, typedSchema);
352 } else if (stmt instanceof AnydataSchemaNode anydataSchema) {
353 putLeaf(getterToLeafSchema, anydataSchema);
354 } else if (stmt instanceof AnyxmlSchemaNode anyxmlSchema) {
355 putLeaf(getterToLeafSchema, anyxmlSchema);
358 return getLeafNodesUsingReflection(type, getterToLeafSchema);
361 private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
362 map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
365 private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
366 final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
367 final var leaves = new HashMap<Method, ValueNodeCodecContext>();
368 for (var method : parentClass.getMethods()) {
369 // Only consider non-bridge methods with no arguments
370 if (method.getParameterCount() == 0 && !method.isBridge()) {
371 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
373 final ValueNodeCodecContext valueNode;
374 if (schema instanceof LeafSchemaNode leafSchema) {
375 // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
377 final Class<?> valueType = method.getReturnType();
378 final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
379 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
380 context.getEffectiveModelContext());
381 } else if (schema instanceof LeafListSchemaNode leafListSchema) {
382 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
383 method.getGenericReturnType());
384 checkState(optType.isPresent(), "Failed to find return type for %s", method);
386 final Class<?> valueType;
387 final Type genericType = optType.orElseThrow();
388 if (genericType instanceof Class<?> clazz) {
390 } else if (genericType instanceof ParameterizedType parameterized) {
391 valueType = (Class<?>) parameterized.getRawType();
392 } else if (genericType instanceof WildcardType) {
393 // FIXME: MDSAL-670: this is not right as we need to find a concrete type
394 valueType = Object.class;
396 throw new IllegalStateException("Unexpected return type " + genericType);
399 final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
400 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
401 } else if (schema instanceof AnyxmlSchemaNode anyxmlSchema) {
402 valueNode = new AnyxmlCodecContext<>(anyxmlSchema, method.getName(), opaqueReturnType(method),
404 } else if (schema instanceof AnydataSchemaNode anydataSchema) {
405 valueNode = new AnydataCodecContext<>(anydataSchema, method.getName(), opaqueReturnType(method),
408 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
409 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
413 leaves.put(method, valueNode);
416 return ImmutableMap.copyOf(leaves);
419 // FIXME: this is probably not right w.r.t. nulls
420 ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
421 if (BaseIdentity.class.isAssignableFrom(valueType)) {
422 @SuppressWarnings({ "unchecked", "rawtypes" })
423 final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
425 } else if (InstanceIdentifier.class.equals(valueType)) {
426 @SuppressWarnings({ "unchecked", "rawtypes" })
427 final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
429 } else if (BindingReflections.isBindingClass(valueType)) {
430 return getCodecForBindingClass(valueType, instantiatedType);
432 // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
433 // valueType=Object.class
434 return SchemaUnawareCodec.NOOP_CODEC;
437 @SuppressWarnings("checkstyle:illegalCatch")
438 // FIXME: this is probably not right w.r.t. nulls
439 private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
440 final TypeDefinition<?> typeDef) {
441 if (typeDef instanceof IdentityrefTypeDefinition) {
442 return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
443 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
444 return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
445 } else if (typeDef instanceof UnionTypeDefinition unionType) {
447 return UnionTypeCodec.of(valueType, unionType, this);
448 } catch (Exception e) {
449 throw new IllegalStateException("Unable to load codec for " + valueType, e);
451 } else if (typeDef instanceof LeafrefTypeDefinition) {
452 final var typeWithSchema = context.getTypeWithSchema(valueType);
453 final var schema = typeWithSchema.statement();
454 final TypeDefinition<?> def;
455 if (schema instanceof TypeDefinitionAware typeDefAware) {
456 def = typeDefAware.getTypeDefinition();
457 } else if (schema instanceof TypeAware typeAware) {
458 def = typeAware.getType();
460 throw new IllegalStateException("Unexpected schema " + schema);
462 return getCodec(valueType, def);
464 return SchemaUnawareCodec.of(valueType, typeDef);
468 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
469 final Optional<Class<Key<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
471 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
473 final Class<Key<?>> identifier = optIdentifier.orElseThrow();
474 final Map<QName, ValueContext> valueCtx = new HashMap<>();
475 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
476 final QName name = leaf.getDomPathArgument().getNodeType();
477 valueCtx.put(name, new ValueContext(identifier, leaf));
479 return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
483 public <E extends DataObject> CommonDataObjectCodecTreeNode<E> getStreamChild(final Class<E> childClass) {
484 return root.getStreamChild(childClass);
488 @SuppressWarnings("unchecked")
489 public <A extends Augmentation<?>> BindingAugmentationCodecTreeNode<A> getAugmentationCodec(
490 final InstanceIdentifier<A> path) {
491 final var codecContext = getCodecContextNode(path, null);
492 if (codecContext instanceof BindingAugmentationCodecTreeNode) {
493 return (BindingAugmentationCodecTreeNode<A>) codecContext;
495 throw new IllegalArgumentException(path + " does not refer to an Augmentation");
499 @SuppressWarnings("unchecked")
500 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getDataObjectCodec(
501 final InstanceIdentifier<T> path) {
502 final var codecContext = getCodecContextNode(path, null);
503 if (codecContext instanceof BindingDataObjectCodecTreeNode) {
504 return (BindingDataObjectCodecTreeNode<T>) codecContext;
506 throw new IllegalArgumentException(path + " does not refer to a plain DataObject");
510 @SuppressWarnings("unchecked")
511 public <T extends DataObject> CodecWithPath<T> getSubtreeCodecWithPath(final InstanceIdentifier<T> path) {
512 final var yangArgs = new ArrayList<YangInstanceIdentifier.PathArgument>();
513 final var codecContext = getCodecContextNode(path, yangArgs);
515 // TODO Do we need defensive check here?
516 return new CodecWithPath<>((CommonDataObjectCodecTreeNode<T>) codecContext,
517 YangInstanceIdentifier.of(yangArgs));
521 @SuppressWarnings("unchecked")
522 public <T extends DataObject> CommonDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
523 // TODO Do we need defensive check here?
524 return (CommonDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
528 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
529 return getCodecContextNode(path, null);
533 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
534 throw new UnsupportedOperationException("Not implemented yet.");
538 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
539 return instanceIdentifierCodec.fromBinding(binding);
543 public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
544 return instanceIdentifierCodec.toBinding(dom);
548 public <A extends Augmentation<?>> AugmentationResult toNormalizedAugmentation(final InstanceIdentifier<A> path,
550 final var result = toNormalizedNode(path, data);
551 if (result instanceof AugmentationResult augment) {
554 throw new IllegalArgumentException(path + " does not identify an Augmentation");
558 public <T extends DataObject> NodeResult toNormalizedDataObject(final InstanceIdentifier<T> path, final T data) {
559 final var result = toNormalizedNode(path, data);
560 if (result instanceof NodeResult node) {
563 throw new IllegalArgumentException(path + " does not identify a plain DataObject");
567 public <T extends DataObject> NormalizedResult toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
568 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
569 final var yangArgs = new ArrayList<YangInstanceIdentifier.PathArgument>();
570 final var codecContext = getCodecContextNode(path, yangArgs);
571 final var yangPath = YangInstanceIdentifier.of(yangArgs);
573 // We create DOM stream writer which produces normalized nodes
574 final var result = new NormalizationResultHolder();
575 final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
576 final var bindingWriter = new BindingToNormalizedStreamWriter(codecContext, domWriter);
577 final var augment = codecContext instanceof BindingAugmentationCodecTreeNode<?> augmentNode ? augmentNode
581 // Augmentations do not have a representation, so we are faking a ContainerNode as the parent and we will be
582 // extracting the resulting children.
583 if (augment != null) {
584 domWriter.startContainerNode(FAKE_NODEID, NormalizedNodeStreamWriter.UNKNOWN_SIZE);
587 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
588 getSerializer(path.getTargetType()).serialize(data, bindingWriter);
590 if (augment != null) {
593 } catch (final IOException e) {
594 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
595 throw new IllegalStateException("Failed to create normalized node", e);
598 // Terminate the fake container and extract it to the result
599 if (augment != null) {
600 return new AugmentationResult(yangPath, augment.childPathArguments(),
601 ImmutableList.copyOf(((ContainerNode) result.getResult().data()).body()));
603 return new NodeResult(yangPath, result.getResult().data());
607 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
608 final NormalizedNode data) {
609 if (notBindingRepresentable(data)) {
613 final List<PathArgument> builder = new ArrayList<>();
614 final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
617 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
623 final DataObject lazyObj = codec.deserialize(data);
624 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
625 return Map.entry(bindingPath, lazyObj);
629 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
630 return getNotificationContext(path).deserialize(data);
634 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
635 final Instant eventInstant) {
636 return eventInstant == null ? fromNormalizedNodeNotification(path, data)
637 : getNotificationContext(path).deserialize(data, eventInstant);
641 public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
642 return getRpcInputCodec(containerPath).deserialize(data);
646 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
647 final ContainerNode input) {
648 return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
652 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
653 final ContainerNode output) {
654 return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
658 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
659 public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
660 // FIXME: Should the cast to DataObject be necessary?
661 return serializeDataObject((DataObject) data,
662 (ctx, iface, domWriter) -> ctx.newNotificationWriter(
663 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
667 public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
668 checkArgument(data instanceof DataObject, "Unexpected data %s", data);
669 @SuppressWarnings("rawtypes")
670 final NotificationCodecContext notifContext = getNotificationContext(path);
671 @SuppressWarnings("unchecked")
672 final var result = notifContext.serialize((DataObject) data);
673 verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
674 return (ContainerNode) result;
678 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
679 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
680 // FIXME: Should the cast to DataObject be necessary?
681 return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
685 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
686 final RpcInput input) {
687 return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
691 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
692 final RpcOutput output) {
693 return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
697 protected NodeIdentifier actionInputName(final Class<? extends Action<?, ?, ?>> action) {
698 return verifyNotNull(getActionCodec(action).input().getDomPathArgument());
702 protected NodeIdentifier actionOutputName(final Class<? extends Action<?, ?, ?>> action) {
703 return verifyNotNull(getActionCodec(action).output().getDomPathArgument());
706 private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
707 final WriterFactoryMethod<T> newWriter) {
708 final var result = new NormalizationResultHolder();
709 // We create DOM stream writer which produces normalized nodes
710 final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
711 final Class<? extends DataObject> type = data.implementedInterface();
712 @SuppressWarnings("unchecked")
713 final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
715 getSerializer(type).serialize(data, writer);
716 } catch (final IOException e) {
717 LOG.error("Unexpected failure while serializing data {}", data, e);
718 throw new IllegalStateException("Failed to create normalized node", e);
720 return (ContainerNode) result.getResult().data();
723 private static boolean notBindingRepresentable(final NormalizedNode data) {
724 // ValueNode covers LeafNode and LeafSetEntryNode
725 return data instanceof ValueNode
726 || data instanceof MapNode || data instanceof UnkeyedListNode
727 || data instanceof ChoiceNode
728 || data instanceof LeafSetNode;
731 @SuppressWarnings("rawtypes")
732 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
733 final Class<?> valueType = method.getReturnType();
734 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
735 return valueType.asSubclass(OpaqueObject.class);
739 private interface WriterFactoryMethod<T extends DataContainer> {
740 BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
741 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);