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.AbstractMap.SimpleEntry;
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.Callable;
39 import java.util.concurrent.ExecutionException;
40 import javax.inject.Inject;
41 import javax.inject.Singleton;
42 import org.eclipse.jdt.annotation.NonNull;
43 import org.eclipse.jdt.annotation.Nullable;
44 import org.kohsuke.MetaInfServices;
45 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
47 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
48 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
49 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
50 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
51 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
52 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
53 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
54 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
55 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
56 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
57 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
58 import org.opendaylight.yangtools.concepts.Delegator;
59 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
60 import org.opendaylight.yangtools.concepts.Immutable;
61 import org.opendaylight.yangtools.util.ClassLoaderUtils;
62 import org.opendaylight.yangtools.yang.binding.Action;
63 import org.opendaylight.yangtools.yang.binding.DataContainer;
64 import org.opendaylight.yangtools.yang.binding.DataObject;
65 import org.opendaylight.yangtools.yang.binding.Identifiable;
66 import org.opendaylight.yangtools.yang.binding.Identifier;
67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
69 import org.opendaylight.yangtools.yang.binding.Notification;
70 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
71 import org.opendaylight.yangtools.yang.binding.RpcInput;
72 import org.opendaylight.yangtools.yang.binding.RpcOutput;
73 import org.opendaylight.yangtools.yang.common.QName;
74 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
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.NormalizedNodeResult;
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.DataNodeContainer;
88 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
89 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
90 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
91 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
92 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
93 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
94 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
95 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
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;
104 @MetaInfServices(value = BindingDOMCodecServices.class)
106 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
107 implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry {
108 private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
109 private final @NonNull DataObjectStreamer<?> delegate;
111 DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
112 this.delegate = requireNonNull(delegate);
116 public DataObjectStreamer<?> getDelegate() {
121 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
122 delegate.serialize(BindingCodecContext.this, obj, stream);
126 private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
128 private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
129 new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
131 public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
132 final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
134 final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
135 return (DataObjectStreamer<?>) instance.get(null);
138 private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
139 new CacheLoader<Class<?>, DataObjectSerializer>() {
141 public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
142 return new DataObjectSerializerProxy(streamers.get(key));
146 private final @NonNull CodecClassLoader loader = CodecClassLoader.create();
147 private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
148 private final @NonNull IdentityCodec identityCodec;
149 private final @NonNull BindingRuntimeContext context;
150 private final SchemaRootCodecContext<?> root;
152 public BindingCodecContext() {
153 this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
154 .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
158 public BindingCodecContext(final BindingRuntimeContext context) {
159 this.context = requireNonNull(context, "Binding Runtime Context is required.");
160 this.root = SchemaRootCodecContext.create(this);
161 this.identityCodec = new IdentityCodec(context);
162 this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
166 public BindingRuntimeContext getRuntimeContext() {
171 public CodecClassLoader getLoader() {
176 public IdentityCodec getIdentityCodec() {
177 return identityCodec;
181 public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
182 return instanceIdentifierCodec;
186 public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
187 return serializers.getUnchecked(type);
191 public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
192 return streamers.getUnchecked(type);
196 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
197 return serializers.getUnchecked(type);
201 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
202 final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
203 final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
204 final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
205 return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
209 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
210 final NormalizedNodeStreamWriter domWriter) {
211 return getCodecContextNode(path, null).createWriter(domWriter);
215 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
216 final NormalizedNodeStreamWriter domWriter) {
217 return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
221 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
222 final NormalizedNodeStreamWriter domWriter) {
223 return root.getNotification(notification).createWriter(domWriter);
227 public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
228 final NormalizedNodeStreamWriter domWriter) {
229 return getActionCodec(action).input().createWriter(domWriter);
233 public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
234 final NormalizedNodeStreamWriter domWriter) {
235 return getActionCodec(action).output().createWriter(domWriter);
238 DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
239 final List<YangInstanceIdentifier.PathArgument> builder) {
240 DataContainerCodecContext<?,?> currentNode = root;
241 for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
242 currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
243 checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
249 * Multi-purpose utility function. Traverse the codec tree, looking for
250 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
251 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
252 * into the supplied collection.
254 * @param dom {@link YangInstanceIdentifier} which is to be translated
255 * @param bindingArguments Collection for traversed path arguments
256 * @return Codec for target node, or @null if the node does not have a
257 * binding representation (choice, case, leaf).
260 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
261 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
262 NodeCodecContext currentNode = root;
263 ListNodeCodecContext<?> currentList = null;
265 for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
266 checkArgument(currentNode instanceof DataContainerCodecContext,
267 "Unexpected child of non-container node %s", currentNode);
268 final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
269 final NodeCodecContext nextNode = previous.yangPathArgumentChild(domArg);
272 * List representation in YANG Instance Identifier consists of two
273 * arguments: first is list as a whole, second is list as an item so
274 * if it is /list it means list as whole, if it is /list/list - it
275 * is wildcarded and if it is /list/list[key] it is concrete item,
276 * all this variations are expressed in Binding Aware Instance
277 * Identifier as Item or IdentifiableItem
279 if (currentList != null) {
280 checkArgument(currentList == nextNode,
281 "List should be referenced two times in YANG Instance Identifier %s", dom);
283 // We entered list, so now we have all information to emit
284 // list path using second list argument.
285 if (bindingArguments != null) {
286 bindingArguments.add(currentList.getBindingPathArgument(domArg));
289 currentNode = nextNode;
290 } else if (nextNode instanceof ListNodeCodecContext) {
291 // We enter list, we do not update current Node yet,
292 // since we need to verify
293 currentList = (ListNodeCodecContext<?>) nextNode;
294 } else if (nextNode instanceof ChoiceNodeCodecContext) {
295 // We do not add path argument for choice, since
296 // it is not supported by binding instance identifier.
297 currentNode = nextNode;
298 } else if (nextNode instanceof DataContainerCodecContext) {
299 if (bindingArguments != null) {
300 bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
302 currentNode = nextNode;
303 } else if (nextNode instanceof ValueNodeCodecContext) {
304 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
309 // Algorithm ended in list as whole representation
310 // we sill need to emit identifier for list
311 if (currentNode instanceof ChoiceNodeCodecContext) {
312 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
315 if (currentNode instanceof CaseNodeCodecContext) {
316 LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
320 if (currentList != null) {
321 if (bindingArguments != null) {
322 bindingArguments.add(currentList.getBindingPathArgument(null));
326 if (currentNode != null) {
327 verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
329 return (BindingDataObjectCodecTreeNode<?>) currentNode;
334 NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
335 return root.getNotification(notification);
338 RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
339 return root.getRpc(containerPath);
342 ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
343 return root.getAction(action);
347 public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> parentClass,
348 final DataNodeContainer childSchema) {
349 final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
350 for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
351 if (leaf instanceof TypedDataSchemaNode || leaf instanceof AnyxmlSchemaNode
352 || leaf instanceof AnydataSchemaNode) {
353 getterToLeafSchema.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
356 return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
359 private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
360 final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
361 final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
362 for (final Method method : parentClass.getMethods()) {
363 // Only consider non-bridge methods with no arguments
364 if (method.getParameterCount() == 0 && !method.isBridge()) {
365 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
367 final ValueNodeCodecContext valueNode;
368 if (schema instanceof LeafSchemaNode) {
369 final LeafSchemaNode leafSchema = (LeafSchemaNode) schema;
371 // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
373 final Class<?> valueType = method.getReturnType();
374 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
375 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
376 context.getEffectiveModelContext());
377 } else if (schema instanceof LeafListSchemaNode) {
378 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
379 method.getGenericReturnType());
380 checkState(optType.isPresent(), "Failed to find return type for %s", method);
382 final Class<?> valueType;
383 final Type genericType = optType.get();
384 if (genericType instanceof Class<?>) {
385 valueType = (Class<?>) genericType;
386 } else if (genericType instanceof ParameterizedType) {
387 valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
388 } else if (genericType instanceof WildcardType) {
389 // FIXME: MDSAL-670: this is not right as we need to find a concrete type
390 valueType = Object.class;
392 throw new IllegalStateException("Unexpected return type " + genericType);
395 final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
396 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
397 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
398 } else if (schema instanceof AnyxmlSchemaNode) {
399 valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
400 opaqueReturnType(method), loader);
401 } else if (schema instanceof AnydataSchemaNode) {
402 valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
403 opaqueReturnType(method), loader);
405 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
406 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
410 leaves.put(method, valueNode);
413 return ImmutableMap.copyOf(leaves);
416 // FIXME: this is probably not right w.r.t. nulls
417 IllegalArgumentCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
418 if (Class.class.equals(valueType)) {
419 @SuppressWarnings({ "unchecked", "rawtypes" })
420 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) identityCodec;
422 } else if (InstanceIdentifier.class.equals(valueType)) {
423 @SuppressWarnings({ "unchecked", "rawtypes" })
424 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) instanceIdentifierCodec;
426 } else if (BindingReflections.isBindingClass(valueType)) {
427 return getCodecForBindingClass(valueType, instantiatedType);
429 // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
430 // valueType=Object.class
431 return ValueTypeCodec.NOOP_CODEC;
434 @SuppressWarnings("checkstyle:illegalCatch")
435 // FIXME: this is probably not right w.r.t. nulls
436 private IllegalArgumentCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
437 final TypeDefinition<?> typeDef) {
438 if (typeDef instanceof IdentityrefTypeDefinition) {
439 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, identityCodec);
440 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
441 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, instanceIdentifierCodec);
442 } else if (typeDef instanceof UnionTypeDefinition) {
443 final Callable<UnionTypeCodec> unionLoader = UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef,
446 return unionLoader.call();
447 } catch (final Exception e) {
448 throw new IllegalStateException("Unable to load codec for " + valueType, e);
450 } else if (typeDef instanceof LeafrefTypeDefinition) {
451 final Entry<GeneratedType, WithStatus> typeWithSchema = context.getTypeWithSchema(valueType);
452 final WithStatus schema = typeWithSchema.getValue();
453 checkState(schema instanceof TypeDefinition, "Unexpected schema %s", schema);
454 return getCodec(valueType, (TypeDefinition<?>) schema);
456 return ValueTypeCodec.getCodecFor(valueType, typeDef);
460 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListSchemaNode schema) {
461 final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
463 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
465 final Class<Identifier<?>> identifier = optIdentifier.get();
466 final Map<QName, ValueContext> valueCtx = new HashMap<>();
467 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, schema).values()) {
468 final QName name = leaf.getDomPathArgument().getNodeType();
469 valueCtx.put(name, new ValueContext(identifier, leaf));
471 return IdentifiableItemCodec.of(schema, identifier, listClz, valueCtx);
474 @SuppressWarnings("unchecked")
476 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
477 // TODO Do we need defensive check here?
478 return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
482 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
483 return getCodecContextNode(path, null);
487 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
488 throw new UnsupportedOperationException("Not implemented yet.");
492 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
493 return instanceIdentifierCodec.fromBinding(binding);
497 public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
498 return instanceIdentifierCodec.toBinding(dom);
502 public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
503 final InstanceIdentifier<T> path, final T data) {
504 final NormalizedNodeResult result = new NormalizedNodeResult();
505 // We create DOM stream writer which produces normalized nodes
506 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
508 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
509 final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = newWriterAndIdentifier(path,
512 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
514 getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
515 } catch (final IOException e) {
516 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
517 throw new IllegalStateException("Failed to create normalized node", e);
519 return new SimpleEntry<>(writeCtx.getKey(),result.getResult());
523 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
524 final NormalizedNode data) {
525 if (notBindingRepresentable(data)) {
529 final List<PathArgument> builder = new ArrayList<>();
530 final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
533 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
539 final DataObject lazyObj = codec.deserialize(data);
540 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
541 return new SimpleEntry<>(bindingPath, lazyObj);
545 public Notification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
546 return getNotificationContext(path).deserialize(data);
550 public Notification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
551 final Instant eventInstant) {
552 return eventInstant == null ? fromNormalizedNodeNotification(path, data)
553 : getNotificationContext(path).deserialize(data, eventInstant);
558 public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
559 return getRpcInputCodec(containerPath).deserialize(data);
563 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
564 final ContainerNode input) {
565 return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
569 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
570 final ContainerNode output) {
571 return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
575 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
576 public ContainerNode toNormalizedNodeNotification(@NonNull final Notification data) {
577 // FIXME: Should the cast to DataObject be necessary?
578 return serializeDataObject((DataObject) data,
579 (ctx, iface, domWriter) -> ctx.newNotificationWriter(iface.asSubclass(Notification.class), domWriter));
583 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
584 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
585 // FIXME: Should the cast to DataObject be necessary?
586 return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
590 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
591 final RpcInput input) {
592 return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
596 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
597 final RpcOutput output) {
598 return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
601 private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
602 final WriterFactoryMethod<T> newWriter) {
603 final NormalizedNodeResult result = new NormalizedNodeResult();
604 // We create DOM stream writer which produces normalized nodes
605 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
606 final Class<? extends DataObject> type = data.implementedInterface();
607 @SuppressWarnings("unchecked")
608 final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
610 getSerializer(type).serialize(data, writer);
611 } catch (final IOException e) {
612 LOG.error("Unexpected failure while serializing data {}", data, e);
613 throw new IllegalStateException("Failed to create normalized node", e);
615 return (ContainerNode) result.getResult();
619 private static boolean notBindingRepresentable(final NormalizedNode data) {
620 // ValueNode covers LeafNode and LeafSetEntryNode
621 return data instanceof ValueNode
622 || data instanceof MapNode || data instanceof UnkeyedListNode
623 || data instanceof ChoiceNode
624 || data instanceof LeafSetNode;
627 @SuppressWarnings("rawtypes")
628 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
629 final Class<?> valueType = method.getReturnType();
630 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
631 return valueType.asSubclass(OpaqueObject.class);
635 private interface WriterFactoryMethod<T extends DataContainer> {
636 BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
637 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);