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 java.util.Objects.requireNonNull;
15 import com.google.common.base.Strings;
16 import com.google.common.cache.CacheBuilder;
17 import com.google.common.cache.CacheLoader;
18 import com.google.common.cache.LoadingCache;
19 import com.google.common.collect.ImmutableMap;
20 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
22 import java.io.IOException;
23 import java.lang.reflect.Field;
24 import java.lang.reflect.Method;
25 import java.lang.reflect.ParameterizedType;
26 import java.lang.reflect.Type;
27 import java.lang.reflect.WildcardType;
28 import java.time.Instant;
29 import java.util.ArrayList;
30 import java.util.Collection;
31 import java.util.HashMap;
32 import java.util.LinkedList;
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.BindingCodecTreeNode;
43 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
44 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
45 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
47 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
48 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
49 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
50 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
51 import org.opendaylight.mdsal.binding.loader.BindingClassLoader;
52 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
53 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
54 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
55 import org.opendaylight.yangtools.concepts.Delegator;
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.BaseIdentity;
60 import org.opendaylight.yangtools.yang.binding.BaseNotification;
61 import org.opendaylight.yangtools.yang.binding.DataContainer;
62 import org.opendaylight.yangtools.yang.binding.DataObject;
63 import org.opendaylight.yangtools.yang.binding.Identifiable;
64 import org.opendaylight.yangtools.yang.binding.Identifier;
65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
66 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
67 import org.opendaylight.yangtools.yang.binding.Notification;
68 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
69 import org.opendaylight.yangtools.yang.binding.RpcInput;
70 import org.opendaylight.yangtools.yang.binding.RpcOutput;
71 import org.opendaylight.yangtools.yang.common.QName;
72 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
73 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
74 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
75 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
76 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
77 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
79 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
81 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
82 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
83 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
84 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.TypeAware;
89 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
90 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
91 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
92 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
93 import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
94 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
95 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
98 import org.slf4j.Logger;
99 import org.slf4j.LoggerFactory;
101 @MetaInfServices(value = BindingDOMCodecServices.class)
102 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
103 implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry {
104 private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
105 private final @NonNull DataObjectStreamer<?> delegate;
107 DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
108 this.delegate = requireNonNull(delegate);
112 public DataObjectStreamer<?> getDelegate() {
117 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
118 delegate.serialize(BindingCodecContext.this, obj, stream);
122 private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
123 private static final File BYTECODE_DIRECTORY;
126 final String dir = System.getProperty("org.opendaylight.mdsal.binding.dom.codec.loader.bytecodeDumpDirectory");
127 BYTECODE_DIRECTORY = Strings.isNullOrEmpty(dir) ? null : new File(dir);
130 private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
131 new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
133 public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
134 final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
136 final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
137 return (DataObjectStreamer<?>) instance.get(null);
140 private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
141 new CacheLoader<Class<?>, DataObjectSerializer>() {
143 public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
144 return new DataObjectSerializerProxy(streamers.get(key));
148 private final @NonNull BindingClassLoader loader =
149 BindingClassLoader.create(BindingCodecContext.class, BYTECODE_DIRECTORY);
150 private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
151 private final @NonNull IdentityCodec identityCodec;
152 private final @NonNull BindingRuntimeContext context;
153 private final SchemaRootCodecContext<?> root;
155 public BindingCodecContext() {
156 this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
157 .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
160 public BindingCodecContext(final BindingRuntimeContext context) {
161 this.context = requireNonNull(context, "Binding Runtime Context is required.");
162 root = SchemaRootCodecContext.create(this);
163 identityCodec = new IdentityCodec(context);
164 instanceIdentifierCodec = new InstanceIdentifierCodec(this);
168 public BindingRuntimeContext getRuntimeContext() {
173 public BindingClassLoader getLoader() {
178 public IdentityCodec getIdentityCodec() {
179 return identityCodec;
183 public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
184 return instanceIdentifierCodec;
188 public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
189 return serializers.getUnchecked(type);
193 public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
194 return streamers.getUnchecked(type);
198 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
199 return serializers.getUnchecked(type);
203 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
204 final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
205 final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
206 final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
207 return Map.entry(YangInstanceIdentifier.create(yangArgs),
208 new BindingToNormalizedStreamWriter(codecContext, domWriter));
212 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
213 final NormalizedNodeStreamWriter domWriter) {
214 return new BindingToNormalizedStreamWriter(getCodecContextNode(path, null), domWriter);
218 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
219 final NormalizedNodeStreamWriter domWriter) {
220 return new BindingToNormalizedStreamWriter(root.getRpc(rpcInputOrOutput), domWriter);
224 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
225 final NormalizedNodeStreamWriter domWriter) {
226 return new BindingToNormalizedStreamWriter(root.getNotification(notification), domWriter);
230 public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
231 final NormalizedNodeStreamWriter domWriter) {
232 return new BindingToNormalizedStreamWriter(getActionCodec(action).input(), domWriter);
236 public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
237 final NormalizedNodeStreamWriter domWriter) {
238 return new BindingToNormalizedStreamWriter(getActionCodec(action).output(), domWriter);
241 DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
242 final List<YangInstanceIdentifier.PathArgument> builder) {
243 DataContainerCodecContext<?,?> currentNode = root;
244 for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
245 currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
246 checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
252 * Multi-purpose utility function. Traverse the codec tree, looking for
253 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
254 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
255 * into the supplied collection.
257 * @param dom {@link YangInstanceIdentifier} which is to be translated
258 * @param bindingArguments Collection for traversed path arguments
259 * @return Codec for target node, or @null if the node does not have a
260 * binding representation (choice, case, leaf).
263 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
264 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
265 NodeCodecContext currentNode = root;
266 ListNodeCodecContext<?> currentList = null;
268 for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
269 checkArgument(currentNode instanceof DataContainerCodecContext,
270 "Unexpected child of non-container node %s", currentNode);
271 final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
272 final NodeCodecContext nextNode = previous.yangPathArgumentChild(domArg);
275 * List representation in YANG Instance Identifier consists of two
276 * arguments: first is list as a whole, second is list as an item so
277 * if it is /list it means list as whole, if it is /list/list - it
278 * is wildcarded and if it is /list/list[key] it is concrete item,
279 * all this variations are expressed in Binding Aware Instance
280 * Identifier as Item or IdentifiableItem
282 if (currentList != null) {
283 checkArgument(currentList == nextNode,
284 "List should be referenced two times in YANG Instance Identifier %s", dom);
286 // We entered list, so now we have all information to emit
287 // list path using second list argument.
288 if (bindingArguments != null) {
289 bindingArguments.add(currentList.getBindingPathArgument(domArg));
292 currentNode = nextNode;
293 } else if (nextNode instanceof ListNodeCodecContext) {
294 // We enter list, we do not update current Node yet,
295 // since we need to verify
296 currentList = (ListNodeCodecContext<?>) nextNode;
297 } else if (nextNode instanceof ChoiceNodeCodecContext) {
298 // We do not add path argument for choice, since
299 // it is not supported by binding instance identifier.
300 currentNode = nextNode;
301 } else if (nextNode instanceof DataContainerCodecContext) {
302 if (bindingArguments != null) {
303 bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
305 currentNode = nextNode;
306 } else if (nextNode instanceof ValueNodeCodecContext) {
307 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
312 // Algorithm ended in list as whole representation
313 // we sill need to emit identifier for list
314 if (currentNode instanceof ChoiceNodeCodecContext) {
315 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
318 if (currentNode instanceof CaseNodeCodecContext) {
319 LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
323 if (currentList != null) {
324 if (bindingArguments != null) {
325 bindingArguments.add(currentList.getBindingPathArgument(null));
329 if (currentNode != null) {
330 verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
332 return (BindingDataObjectCodecTreeNode<?>) currentNode;
337 NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
338 return root.getNotification(notification);
341 RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
342 return root.getRpc(containerPath);
345 ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
346 return root.getAction(action);
350 public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
351 final EffectiveStatement<?, ?> schema) {
352 final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
353 for (var stmt : schema.effectiveSubstatements()) {
354 if (stmt instanceof TypedDataSchemaNode) {
355 putLeaf(getterToLeafSchema, (TypedDataSchemaNode) stmt);
356 } else if (stmt instanceof AnydataSchemaNode) {
357 putLeaf(getterToLeafSchema, (AnydataSchemaNode) stmt);
358 } else if (stmt instanceof AnyxmlSchemaNode) {
359 putLeaf(getterToLeafSchema, (AnyxmlSchemaNode) stmt);
362 return getLeafNodesUsingReflection(type, getterToLeafSchema);
365 private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
366 map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
369 private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
370 final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
371 final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
372 for (final Method method : parentClass.getMethods()) {
373 // Only consider non-bridge methods with no arguments
374 if (method.getParameterCount() == 0 && !method.isBridge()) {
375 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
377 final ValueNodeCodecContext valueNode;
378 if (schema instanceof LeafSchemaNode leafSchema) {
379 // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
381 final Class<?> valueType = method.getReturnType();
382 final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
383 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
384 context.getEffectiveModelContext());
385 } else if (schema instanceof LeafListSchemaNode) {
386 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
387 method.getGenericReturnType());
388 checkState(optType.isPresent(), "Failed to find return type for %s", method);
390 final Class<?> valueType;
391 final Type genericType = optType.orElseThrow();
392 if (genericType instanceof Class<?> clazz) {
394 } else if (genericType instanceof ParameterizedType parameterized) {
395 valueType = (Class<?>) parameterized.getRawType();
396 } else if (genericType instanceof WildcardType) {
397 // FIXME: MDSAL-670: this is not right as we need to find a concrete type
398 valueType = Object.class;
400 throw new IllegalStateException("Unexpected return type " + genericType);
403 final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
404 final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
405 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
406 } else if (schema instanceof AnyxmlSchemaNode) {
407 valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
408 opaqueReturnType(method), loader);
409 } else if (schema instanceof AnydataSchemaNode) {
410 valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
411 opaqueReturnType(method), loader);
413 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
414 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
418 leaves.put(method, valueNode);
421 return ImmutableMap.copyOf(leaves);
424 // FIXME: this is probably not right w.r.t. nulls
425 ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
426 if (BaseIdentity.class.isAssignableFrom(valueType)) {
427 @SuppressWarnings({ "unchecked", "rawtypes" })
428 final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
430 } else if (InstanceIdentifier.class.equals(valueType)) {
431 @SuppressWarnings({ "unchecked", "rawtypes" })
432 final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
434 } else if (BindingReflections.isBindingClass(valueType)) {
435 return getCodecForBindingClass(valueType, instantiatedType);
437 // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
438 // valueType=Object.class
439 return SchemaUnawareCodec.NOOP_CODEC;
442 @SuppressWarnings("checkstyle:illegalCatch")
443 // FIXME: this is probably not right w.r.t. nulls
444 private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
445 final TypeDefinition<?> typeDef) {
446 if (typeDef instanceof IdentityrefTypeDefinition) {
447 return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
448 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
449 return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
450 } else if (typeDef instanceof UnionTypeDefinition) {
452 return UnionTypeCodec.of(valueType, (UnionTypeDefinition) typeDef, this);
453 } catch (Exception e) {
454 throw new IllegalStateException("Unable to load codec for " + valueType, e);
456 } else if (typeDef instanceof LeafrefTypeDefinition) {
457 final var typeWithSchema = context.getTypeWithSchema(valueType);
458 final var schema = typeWithSchema.statement();
459 final TypeDefinition<?> def;
460 if (schema instanceof TypeDefinitionAware) {
461 def = ((TypeDefinitionAware) schema).getTypeDefinition();
462 } else if (schema instanceof TypeAware) {
463 def = ((TypeAware) schema).getType();
465 throw new IllegalStateException("Unexpected schema " + schema);
467 return getCodec(valueType, def);
469 return SchemaUnawareCodec.of(valueType, typeDef);
473 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
474 final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
476 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
478 final Class<Identifier<?>> identifier = optIdentifier.orElseThrow();
479 final Map<QName, ValueContext> valueCtx = new HashMap<>();
480 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
481 final QName name = leaf.getDomPathArgument().getNodeType();
482 valueCtx.put(name, new ValueContext(identifier, leaf));
484 return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
488 public <E extends DataObject> BindingDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
489 return root.streamChild(childClass);
493 @SuppressWarnings("unchecked")
494 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
495 // TODO Do we need defensive check here?
496 return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
500 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
501 return getCodecContextNode(path, null);
505 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
506 throw new UnsupportedOperationException("Not implemented yet.");
510 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
511 return instanceIdentifierCodec.fromBinding(binding);
515 public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
516 return instanceIdentifierCodec.toBinding(dom);
520 public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
521 final InstanceIdentifier<T> path, final T data) {
522 final NormalizedNodeResult result = new NormalizedNodeResult();
523 // We create DOM stream writer which produces normalized nodes
524 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
526 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
527 final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = newWriterAndIdentifier(path,
530 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
532 getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
533 } catch (final IOException e) {
534 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
535 throw new IllegalStateException("Failed to create normalized node", e);
537 return Map.entry(writeCtx.getKey(), result.getResult());
541 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
542 final NormalizedNode data) {
543 if (notBindingRepresentable(data)) {
547 final List<PathArgument> builder = new ArrayList<>();
548 final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
551 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
557 final DataObject lazyObj = codec.deserialize(data);
558 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
559 return Map.entry(bindingPath, lazyObj);
563 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
564 return getNotificationContext(path).deserialize(data);
568 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
569 final Instant eventInstant) {
570 return eventInstant == null ? fromNormalizedNodeNotification(path, data)
571 : getNotificationContext(path).deserialize(data, eventInstant);
575 public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
576 return getRpcInputCodec(containerPath).deserialize(data);
580 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
581 final ContainerNode input) {
582 return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
586 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
587 final ContainerNode output) {
588 return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
592 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
593 public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
594 // FIXME: Should the cast to DataObject be necessary?
595 return serializeDataObject((DataObject) data,
596 (ctx, iface, domWriter) -> ctx.newNotificationWriter(
597 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
601 public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
602 checkArgument(data instanceof DataObject, "Unexpected data %s", data);
603 @SuppressWarnings("rawtypes")
604 final NotificationCodecContext notifContext = getNotificationContext(path);
605 @SuppressWarnings("unchecked")
606 final var result = notifContext.serialize((DataObject) data);
607 verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
608 return (ContainerNode) result;
612 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
613 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
614 // FIXME: Should the cast to DataObject be necessary?
615 return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
619 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
620 final RpcInput input) {
621 return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
625 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
626 final RpcOutput output) {
627 return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
630 private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
631 final WriterFactoryMethod<T> newWriter) {
632 final NormalizedNodeResult result = new NormalizedNodeResult();
633 // We create DOM stream writer which produces normalized nodes
634 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
635 final Class<? extends DataObject> type = data.implementedInterface();
636 @SuppressWarnings("unchecked")
637 final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
639 getSerializer(type).serialize(data, writer);
640 } catch (final IOException e) {
641 LOG.error("Unexpected failure while serializing data {}", data, e);
642 throw new IllegalStateException("Failed to create normalized node", e);
644 return (ContainerNode) result.getResult();
648 private static boolean notBindingRepresentable(final NormalizedNode data) {
649 // ValueNode covers LeafNode and LeafSetEntryNode
650 return data instanceof ValueNode
651 || data instanceof MapNode || data instanceof UnkeyedListNode
652 || data instanceof ChoiceNode
653 || data instanceof LeafSetNode;
656 @SuppressWarnings("rawtypes")
657 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
658 final Class<?> valueType = method.getReturnType();
659 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
660 return valueType.asSubclass(OpaqueObject.class);
664 private interface WriterFactoryMethod<T extends DataContainer> {
665 BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
666 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);