2 * Copyright (c) 2015 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 java.util.Objects.requireNonNull;
12 import java.io.IOException;
13 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
14 import org.opendaylight.yangtools.yang.binding.DataObject;
15 import org.opendaylight.yangtools.yang.binding.TypeObject;
16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
17 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
18 import org.slf4j.Logger;
19 import org.slf4j.LoggerFactory;
22 * Serializer of Binding objects to Normalized Node which uses {@link DataObjectNormalizedNodeCache} to
23 * cache already serialized values.
26 * This serializer implements {@link BindingStreamEventWriter} along with {@link BindingSerializer}.
29 * {@link BindingSerializer} interface is used by generated implementations of {@link DataObjectSerializer} to provide
30 * Binding object for inspection and to prevent streaming of already serialized object.
32 final class CachingNormalizedNodeSerializer extends ForwardingBindingStreamEventWriter
33 implements BindingSerializer<Object, DataObject> {
34 private static final Logger LOG = LoggerFactory.getLogger(CachingNormalizedNodeSerializer.class);
36 private final NormalizedNodeResult domResult = new NormalizedNodeResult();
37 private final NormalizedNodeWriterWithAddChild domWriter = new NormalizedNodeWriterWithAddChild(domResult);
38 private final AbstractBindingNormalizedNodeCacheHolder cacheHolder;
39 private final BindingToNormalizedStreamWriter delegate;
41 private CachingNormalizedNodeSerializer(final AbstractBindingNormalizedNodeCacheHolder cacheHolder,
42 final DataContainerCodecContext<?, ?> subtreeRoot) {
43 this.cacheHolder = requireNonNull(cacheHolder);
44 delegate = new BindingToNormalizedStreamWriter(subtreeRoot, domWriter);
48 * Serializes supplied data using stream writer with child cache enabled.
50 * @param cacheHolder Binding to Normalized Node Cache holder
51 * @param subtreeRoot Codec Node for provided data object
52 * @param data Data to be serialized
53 * @return Normalized Node representation of data.
55 static NormalizedNode serializeUsingStreamWriter(final AbstractBindingNormalizedNodeCacheHolder cacheHolder,
56 final DataContainerCodecContext<?, ?> subtreeRoot, final DataObject data) {
57 final var writer = new CachingNormalizedNodeSerializer(cacheHolder, subtreeRoot);
59 subtreeRoot.eventStreamSerializer().serialize(data, writer);
60 } catch (final IOException e) {
61 throw new IllegalStateException(e);
63 return writer.domResult.getResult();
67 protected AnydataBindingStreamWriter delegate() {
72 public void leafNode(final String localName, final Object value) throws IOException {
73 if (value instanceof TypeObject typed) {
74 // TypeObject is a tagging interface used for generated classes which wrap derived and restricted types.
75 // They are immutable and hence we can safely wrap them in LeafNodes and reuse them, if directed to do so.
76 final var type = typed.getClass();
77 if (cacheHolder.isCached(type)) {
78 final var context = ((DataObjectCodecContext<?, ?>) delegate.current()).getLeafChild(localName);
79 if (context instanceof LeafNodeCodecContext.OfTypeObject<?> typeContext) {
80 final var cache = cacheHolder.getCachingSerializer(typeContext);
82 // We have a cache hit and are thus done
83 domWriter.addChild(cache.get(typed));
87 LOG.debug("Unexpected failure to acquire cache for context {}, skipping caching", context);
89 LOG.debug("Context {} does not match expected TypeObject {}, skipping caching", context, typed);
93 super.leafNode(localName, value);
97 * Serializes input if it is cached, returns null otherwise.
100 * If input is cached it uses {@link NormalizedNodeWriterWithAddChild#addChild(NormalizedNode)}
101 * to provide already serialized value to underlying NormalizedNodeWriter in order to reuse
102 * value instead of creating new one using Normalized Node stream APIs.
105 * Note that this optional is serialization of child node invoked from
106 * {@link org.opendaylight.mdsal.binding.dom.codec.impl.DataObjectSerializer}, which may opt-out from
107 * streaming of data when non-null result is returned.
110 public NormalizedNode serialize(final DataObject input) {
111 final var cachingSerializer = getCacheSerializer(input.implementedInterface());
112 if (cachingSerializer != null) {
113 final var domData = cachingSerializer.get(input);
114 domWriter.addChild(domData);
120 private AbstractBindingNormalizedNodeCache<DataObject, ?> getCacheSerializer(
121 final Class<? extends DataObject> type) {
122 if (cacheHolder.isCached(type)) {
123 final var currentCtx = (DataContainerCodecContext<?, ?>) delegate.current();
124 if (type.equals(currentCtx.getBindingClass())) {
125 return cacheHolder.getCachingSerializer(currentCtx);
127 return cacheHolder.getCachingSerializer(currentCtx.streamChild(type));