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.annotations.Beta;
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;
21 import java.io.IOException;
22 import java.lang.reflect.Field;
23 import java.lang.reflect.Method;
24 import java.lang.reflect.ParameterizedType;
25 import java.lang.reflect.Type;
26 import java.lang.reflect.WildcardType;
27 import java.time.Instant;
28 import java.util.ArrayList;
29 import java.util.Collection;
30 import java.util.HashMap;
31 import java.util.LinkedList;
32 import java.util.List;
34 import java.util.Map.Entry;
35 import java.util.Optional;
36 import java.util.ServiceLoader;
37 import java.util.concurrent.ExecutionException;
38 import javax.inject.Inject;
39 import javax.inject.Singleton;
40 import org.eclipse.jdt.annotation.NonNull;
41 import org.eclipse.jdt.annotation.Nullable;
42 import org.kohsuke.MetaInfServices;
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.impl.NodeCodecContext.CodecContextFactory;
49 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
50 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
51 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
52 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
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.Delegator;
57 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
58 import org.opendaylight.yangtools.concepts.Immutable;
59 import org.opendaylight.yangtools.util.ClassLoaderUtils;
60 import org.opendaylight.yangtools.yang.binding.Action;
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.Identifiable;
65 import org.opendaylight.yangtools.yang.binding.Identifier;
66 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
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.schema.ChoiceNode;
75 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
76 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
77 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
79 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
80 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
81 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
82 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
83 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
84 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
85 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
86 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
87 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
88 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.TypeAware;
90 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
91 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
92 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
93 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
94 import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
95 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
96 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
97 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
98 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
99 import org.slf4j.Logger;
100 import org.slf4j.LoggerFactory;
103 @MetaInfServices(value = BindingDOMCodecServices.class)
105 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
106 implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry {
107 private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
108 private final @NonNull DataObjectStreamer<?> delegate;
110 DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
111 this.delegate = requireNonNull(delegate);
115 public DataObjectStreamer<?> getDelegate() {
120 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
121 delegate.serialize(BindingCodecContext.this, obj, stream);
125 private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
127 private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
128 new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
130 public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
131 final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
133 final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
134 return (DataObjectStreamer<?>) instance.get(null);
137 private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
138 new CacheLoader<Class<?>, DataObjectSerializer>() {
140 public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
141 return new DataObjectSerializerProxy(streamers.get(key));
145 private final @NonNull CodecClassLoader loader = CodecClassLoader.create();
146 private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
147 private final @NonNull IdentityCodec identityCodec;
148 private final @NonNull BindingRuntimeContext context;
149 private final SchemaRootCodecContext<?> root;
151 public BindingCodecContext() {
152 this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
153 .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
157 public BindingCodecContext(final BindingRuntimeContext context) {
158 this.context = requireNonNull(context, "Binding Runtime Context is required.");
159 root = SchemaRootCodecContext.create(this);
160 identityCodec = new IdentityCodec(context);
161 instanceIdentifierCodec = new InstanceIdentifierCodec(this);
165 public BindingRuntimeContext getRuntimeContext() {
170 public CodecClassLoader getLoader() {
175 public IdentityCodec getIdentityCodec() {
176 return identityCodec;
180 public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
181 return instanceIdentifierCodec;
185 public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
186 return serializers.getUnchecked(type);
190 public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
191 return streamers.getUnchecked(type);
195 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
196 return serializers.getUnchecked(type);
200 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
201 final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
202 final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
203 final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
204 return Map.entry(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
208 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
209 final NormalizedNodeStreamWriter domWriter) {
210 return getCodecContextNode(path, null).createWriter(domWriter);
214 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
215 final NormalizedNodeStreamWriter domWriter) {
216 return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
220 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
221 final NormalizedNodeStreamWriter domWriter) {
222 return root.getNotification(notification).createWriter(domWriter);
226 public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
227 final NormalizedNodeStreamWriter domWriter) {
228 return getActionCodec(action).input().createWriter(domWriter);
232 public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
233 final NormalizedNodeStreamWriter domWriter) {
234 return getActionCodec(action).output().createWriter(domWriter);
237 DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
238 final List<YangInstanceIdentifier.PathArgument> builder) {
239 DataContainerCodecContext<?,?> currentNode = root;
240 for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
241 currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
242 checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
248 * Multi-purpose utility function. Traverse the codec tree, looking for
249 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
250 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
251 * into the supplied collection.
253 * @param dom {@link YangInstanceIdentifier} which is to be translated
254 * @param bindingArguments Collection for traversed path arguments
255 * @return Codec for target node, or @null if the node does not have a
256 * binding representation (choice, case, leaf).
259 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
260 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
261 NodeCodecContext currentNode = root;
262 ListNodeCodecContext<?> currentList = null;
264 for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
265 checkArgument(currentNode instanceof DataContainerCodecContext,
266 "Unexpected child of non-container node %s", currentNode);
267 final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
268 final NodeCodecContext nextNode = previous.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 ListNodeCodecContext) {
290 // We enter list, we do not update current Node yet,
291 // since we need to verify
292 currentList = (ListNodeCodecContext<?>) nextNode;
293 } else if (nextNode instanceof ChoiceNodeCodecContext) {
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 DataContainerCodecContext) {
298 if (bindingArguments != null) {
299 bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).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 ChoiceNodeCodecContext) {
311 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
314 if (currentNode instanceof CaseNodeCodecContext) {
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 Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
349 for (var stmt : schema.effectiveSubstatements()) {
350 if (stmt instanceof TypedDataSchemaNode) {
351 putLeaf(getterToLeafSchema, (TypedDataSchemaNode) stmt);
352 } else if (stmt instanceof AnydataSchemaNode) {
353 putLeaf(getterToLeafSchema, (AnydataSchemaNode) stmt);
354 } else if (stmt instanceof AnyxmlSchemaNode) {
355 putLeaf(getterToLeafSchema, (AnyxmlSchemaNode) stmt);
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 Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
368 for (final Method 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) {
375 final LeafSchemaNode leafSchema = (LeafSchemaNode) schema;
377 // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
379 final Class<?> valueType = method.getReturnType();
380 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
381 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
382 context.getEffectiveModelContext());
383 } else if (schema instanceof LeafListSchemaNode) {
384 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
385 method.getGenericReturnType());
386 checkState(optType.isPresent(), "Failed to find return type for %s", method);
388 final Class<?> valueType;
389 final Type genericType = optType.get();
390 if (genericType instanceof Class<?>) {
391 valueType = (Class<?>) genericType;
392 } else if (genericType instanceof ParameterizedType) {
393 valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
394 } else if (genericType instanceof WildcardType) {
395 // FIXME: MDSAL-670: this is not right as we need to find a concrete type
396 valueType = Object.class;
398 throw new IllegalStateException("Unexpected return type " + genericType);
401 final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
402 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
403 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
404 } else if (schema instanceof AnyxmlSchemaNode) {
405 valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
406 opaqueReturnType(method), loader);
407 } else if (schema instanceof AnydataSchemaNode) {
408 valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
409 opaqueReturnType(method), loader);
411 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
412 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
416 leaves.put(method, valueNode);
419 return ImmutableMap.copyOf(leaves);
422 // FIXME: this is probably not right w.r.t. nulls
423 IllegalArgumentCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
424 if (Class.class.equals(valueType)) {
425 @SuppressWarnings({ "unchecked", "rawtypes" })
426 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) identityCodec;
428 } else if (InstanceIdentifier.class.equals(valueType)) {
429 @SuppressWarnings({ "unchecked", "rawtypes" })
430 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) instanceIdentifierCodec;
432 } else if (BindingReflections.isBindingClass(valueType)) {
433 return getCodecForBindingClass(valueType, instantiatedType);
435 // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
436 // valueType=Object.class
437 return SchemaUnawareCodec.NOOP_CODEC;
440 @SuppressWarnings("checkstyle:illegalCatch")
441 // FIXME: this is probably not right w.r.t. nulls
442 private IllegalArgumentCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
443 final TypeDefinition<?> typeDef) {
444 if (typeDef instanceof IdentityrefTypeDefinition) {
445 return new CompositeValueCodec(valueType, identityCodec);
446 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
447 return new CompositeValueCodec(valueType, instanceIdentifierCodec);
448 } else if (typeDef instanceof UnionTypeDefinition) {
450 return UnionTypeCodec.of(valueType, (UnionTypeDefinition) typeDef, this);
451 } catch (Exception e) {
452 throw new IllegalStateException("Unable to load codec for " + valueType, e);
454 } else if (typeDef instanceof LeafrefTypeDefinition) {
455 final var typeWithSchema = context.getTypeWithSchema(valueType);
456 final var schema = typeWithSchema.statement();
457 final TypeDefinition<?> def;
458 if (schema instanceof TypeDefinitionAware) {
459 def = ((TypeDefinitionAware) schema).getTypeDefinition();
460 } else if (schema instanceof TypeAware) {
461 def = ((TypeAware) schema).getType();
463 throw new IllegalStateException("Unexpected schema " + schema);
465 return getCodec(valueType, def);
467 return SchemaUnawareCodec.of(valueType, typeDef);
471 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
472 final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
474 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
476 final Class<Identifier<?>> identifier = optIdentifier.get();
477 final Map<QName, ValueContext> valueCtx = new HashMap<>();
478 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
479 final QName name = leaf.getDomPathArgument().getNodeType();
480 valueCtx.put(name, new ValueContext(identifier, leaf));
482 return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
486 public <E extends DataObject> BindingDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
487 return root.streamChild(childClass);
491 @SuppressWarnings("unchecked")
492 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
493 // TODO Do we need defensive check here?
494 return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
498 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
499 return getCodecContextNode(path, null);
503 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
504 throw new UnsupportedOperationException("Not implemented yet.");
508 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
509 return instanceIdentifierCodec.fromBinding(binding);
513 public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
514 return instanceIdentifierCodec.toBinding(dom);
518 public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
519 final InstanceIdentifier<T> path, final T data) {
520 final NormalizedNodeResult result = new NormalizedNodeResult();
521 // We create DOM stream writer which produces normalized nodes
522 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
524 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
525 final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = newWriterAndIdentifier(path,
528 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
530 getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
531 } catch (final IOException e) {
532 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
533 throw new IllegalStateException("Failed to create normalized node", e);
535 return Map.entry(writeCtx.getKey(), result.getResult());
539 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
540 final NormalizedNode data) {
541 if (notBindingRepresentable(data)) {
545 final List<PathArgument> builder = new ArrayList<>();
546 final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
549 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
555 final DataObject lazyObj = codec.deserialize(data);
556 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
557 return Map.entry(bindingPath, lazyObj);
561 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
562 return getNotificationContext(path).deserialize(data);
566 public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
567 final Instant eventInstant) {
568 return eventInstant == null ? fromNormalizedNodeNotification(path, data)
569 : getNotificationContext(path).deserialize(data, eventInstant);
573 public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
574 return getRpcInputCodec(containerPath).deserialize(data);
578 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
579 final ContainerNode input) {
580 return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
584 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
585 final ContainerNode output) {
586 return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
590 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
591 public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
592 // FIXME: Should the cast to DataObject be necessary?
593 return serializeDataObject((DataObject) data,
594 (ctx, iface, domWriter) -> ctx.newNotificationWriter(
595 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
599 public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
600 checkArgument(data instanceof DataObject, "Unexpected data %s", data);
601 @SuppressWarnings("rawtypes")
602 final NotificationCodecContext notifContext = getNotificationContext(path);
603 @SuppressWarnings("unchecked")
604 final var result = notifContext.serialize((DataObject) data);
605 verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
606 return (ContainerNode) result;
610 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
611 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
612 // FIXME: Should the cast to DataObject be necessary?
613 return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
617 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
618 final RpcInput input) {
619 return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
623 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
624 final RpcOutput output) {
625 return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
628 private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
629 final WriterFactoryMethod<T> newWriter) {
630 final NormalizedNodeResult result = new NormalizedNodeResult();
631 // We create DOM stream writer which produces normalized nodes
632 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
633 final Class<? extends DataObject> type = data.implementedInterface();
634 @SuppressWarnings("unchecked")
635 final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
637 getSerializer(type).serialize(data, writer);
638 } catch (final IOException e) {
639 LOG.error("Unexpected failure while serializing data {}", data, e);
640 throw new IllegalStateException("Failed to create normalized node", e);
642 return (ContainerNode) result.getResult();
646 private static boolean notBindingRepresentable(final NormalizedNode data) {
647 // ValueNode covers LeafNode and LeafSetEntryNode
648 return data instanceof ValueNode
649 || data instanceof MapNode || data instanceof UnkeyedListNode
650 || data instanceof ChoiceNode
651 || data instanceof LeafSetNode;
654 @SuppressWarnings("rawtypes")
655 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
656 final Class<?> valueType = method.getReturnType();
657 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
658 return valueType.asSubclass(OpaqueObject.class);
662 private interface WriterFactoryMethod<T extends DataContainer> {
663 BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
664 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);