binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/DataObjectStreamer.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verify;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableClassToInstanceMap;
  15 import java.io.IOException;
  16 import java.lang.reflect.InvocationHandler;
  17 import java.lang.reflect.Proxy;
  18 import java.util.Collection;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Map.Entry;
  22 import org.opendaylight.mdsal.binding.dom.codec.util.AugmentationReader;
  23 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  24 import org.opendaylight.yangtools.yang.binding.Augmentable;
  25 import org.opendaylight.yangtools.yang.binding.Augmentation;
  26 import org.opendaylight.yangtools.yang.binding.BindingSerializer;
  27 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  28 import org.opendaylight.yangtools.yang.binding.DataContainer;
  29 import org.opendaylight.yangtools.yang.binding.DataObject;
  30 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  31 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  32 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  33 import org.opendaylight.yangtools.yang.binding.Identifiable;
  34 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * Base superclass for all concrete streamers, that is objects which are able to turn a concrete DataObject into a
  40  * stream of events.
  41  *
  42  * @param <T> DataObject type
  43  */
  44 @Beta
  45 public abstract class DataObjectStreamer<T extends DataObject> implements DataObjectSerializerImplementation {
  46     private static final Logger LOG = LoggerFactory.getLogger(DataObjectStreamer.class);
  47
  48     protected DataObjectStreamer() {
  49
  50     }
  51
  52     protected static final void streamAnydata(final BindingStreamEventWriter writer, final String localName,
  53             final Object value) throws IOException {
  54         if (value != null && writer instanceof AnydataBindingStreamWriter) {
  55             verify(value instanceof OpaqueObject, "Unexpected data %s", value);
  56             ((AnydataBindingStreamWriter) writer).anydataNode(localName, (OpaqueObject<?>) value);
  57         }
  58     }
  59
  60     protected static final void streamAnyxml(final BindingStreamEventWriter writer, final String localName,
  61             final Object value) throws IOException {
  62         if (value != null) {
  63             writer.anyxmlNode(localName, value);
  64         }
  65     }
  66
  67     protected static final void streamAugmentations(final DataObjectSerializerRegistry registry,
  68             final BindingStreamEventWriter writer, final Augmentable<?> obj) throws IOException {
  69         final Map<Class<? extends Augmentation<?>>, Augmentation<?>> augmentations;
  70         if (registry instanceof AugmentationReader) {
  71             augmentations = ((AugmentationReader) registry).getAugmentations(obj);
  72         } else if (Proxy.isProxyClass(obj.getClass())) {
  73             augmentations = getFromProxy(obj);
  74         } else {
  75             augmentations = BindingReflections.getAugmentations(obj);
  76         }
  77         for (final Entry<Class<? extends Augmentation<?>>, Augmentation<?>> aug : augmentations.entrySet()) {
  78             emitAugmentation(aug.getKey(), aug.getValue(), writer, registry);
  79         }
  80     }
  81
  82     private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getFromProxy(final Augmentable<?> obj) {
  83         final InvocationHandler proxy = Proxy.getInvocationHandler(obj);
  84         if (proxy instanceof AugmentationReader) {
  85             return ((AugmentationReader) proxy).getAugmentations(obj);
  86         }
  87         return ImmutableClassToInstanceMap.of();
  88     }
  89
  90     protected static final <C extends DataContainer> void streamChoice(final Class<C> choiceClass,
  91             final DataObjectSerializerRegistry registry, final BindingStreamEventWriter writer, final C value)
  92                     throws IOException {
  93         if (value != null) {
  94             final Class<? extends DataContainer> caseClass = value.implementedInterface();
  95             writer.startChoiceNode(choiceClass, BindingStreamEventWriter.UNKNOWN_SIZE);
  96             final DataObjectSerializer caseStreamer = registry.getSerializer(caseClass.asSubclass(DataObject.class));
  97             if (caseStreamer != null) {
  98                 if (tryCache(writer, (DataObject) value)) {
  99                     caseStreamer.serialize((DataObject) value, writer);
 100                 }
 101             } else {
 102                 LOG.warn("No serializer for case {} is available in registry {}", caseClass, registry);
 103             }
 104
 105             writer.endNode();
 106         }
 107     }
 108
 109     protected static final <C extends DataObject> void streamContainer(final DataObjectStreamer<C> childStreamer,
 110             final DataObjectSerializerRegistry registry, final BindingStreamEventWriter writer, final C value)
 111                     throws IOException {
 112         if (value != null && tryCache(writer, value)) {
 113             childStreamer.serialize(registry, value, writer);
 114         }
 115     }
 116
 117     protected static final void streamLeaf(final BindingStreamEventWriter writer, final String localName,
 118             final Object value) throws IOException {
 119         if (value != null) {
 120             writer.leafNode(localName, value);
 121         }
 122     }
 123
 124     protected static final void streamLeafList(final BindingStreamEventWriter writer, final String localName,
 125             final List<?> value) throws IOException {
 126         if (value != null) {
 127             writer.startLeafSet(localName, value.size());
 128             commonStreamLeafset(writer, value);
 129         }
 130     }
 131
 132     protected static final void streamOrderedLeafList(final BindingStreamEventWriter writer,
 133             final String localName, final List<?> value) throws IOException {
 134         if (value != null) {
 135             writer.startOrderedLeafSet(localName, value.size());
 136             commonStreamLeafset(writer, value);
 137         }
 138     }
 139
 140     protected static final <E extends DataObject> void streamList(final Class<E> childClass,
 141             final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
 142             final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
 143         if (value != null) {
 144             writer.startUnkeyedList(childClass, value.size());
 145             commonStreamList(registry, writer, childStreamer, value);
 146         }
 147     }
 148
 149     protected static final <E extends DataObject & Identifiable<?>> void streamMap(final Class<E> childClass,
 150             final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
 151             final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
 152         if (value != null) {
 153             writer.startMapNode(childClass, value.size());
 154             commonStreamList(registry, writer, childStreamer, value);
 155         }
 156     }
 157
 158     protected static final <E extends DataObject & Identifiable<?>> void streamOrderedMap(final Class<E> childClass,
 159             final DataObjectStreamer<E> childStreamer, final DataObjectSerializerRegistry registry,
 160             final BindingStreamEventWriter writer, final List<? extends E> value) throws IOException {
 161         if (value != null) {
 162             writer.startOrderedMapNode(childClass, value.size());
 163             commonStreamList(registry, writer, childStreamer, value);
 164         }
 165     }
 166
 167     private static <E extends DataObject> void commonStreamList(final DataObjectSerializerRegistry registry,
 168             final BindingStreamEventWriter writer, final DataObjectStreamer<E> childStreamer,
 169             final Collection<? extends E> value) throws IOException {
 170
 171         for (E entry : value) {
 172             if (tryCache(writer, entry)) {
 173                 childStreamer.serialize(registry, entry, writer);
 174             }
 175         }
 176         writer.endNode();
 177     }
 178
 179     private static void commonStreamLeafset(final BindingStreamEventWriter writer, final List<?> value)
 180             throws IOException {
 181         for (Object entry : value) {
 182             writer.leafSetEntryNode(entry);
 183         }
 184         writer.endNode();
 185     }
 186
 187     @SuppressWarnings("rawtypes")
 188     private static void emitAugmentation(final Class type, final Augmentation<?> value,
 189             final BindingStreamEventWriter writer, final DataObjectSerializerRegistry registry) throws IOException {
 190         /*
 191          * Binding Specification allowed to insert augmentation with null for
 192          * value, which effectively could be used to remove augmentation
 193          * from builder / DTO.
 194          */
 195         if (value != null) {
 196             checkArgument(value instanceof DataObject);
 197             @SuppressWarnings("unchecked")
 198             final DataObjectSerializer serializer = registry.getSerializer(type);
 199             if (serializer != null) {
 200                 serializer.serialize((DataObject) value, writer);
 201             } else {
 202                 LOG.warn("DataObjectSerializer is not present for {} in registry {}", type, registry);
 203             }
 204         }
 205     }
 206
 207     @SuppressWarnings("unchecked")
 208     private static <T extends DataObject> boolean tryCache(final BindingStreamEventWriter writer, final T value) {
 209         return writer instanceof BindingSerializer ? ((BindingSerializer<?, T>) writer).serialize(value) == null : true;
 210     }
 211 }