binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/util/AugmentableDispatchSerializer.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.util;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.io.IOException;
  12 import java.lang.reflect.InvocationHandler;
  13 import java.lang.reflect.Proxy;
  14 import java.util.Collections;
  15 import java.util.Map;
  16 import java.util.Map.Entry;
  17 import org.opendaylight.yangtools.yang.binding.Augmentable;
  18 import org.opendaylight.yangtools.yang.binding.Augmentation;
  19 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  20 import org.opendaylight.yangtools.yang.binding.DataObject;
  21 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  22 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  23 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  24 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * Dispatch serializer, which emits {@link BindingStreamEventWriter#startAugmentationNode(Class)}
  30  * events for supplied augmentation node.
  31  */
  32 public class AugmentableDispatchSerializer implements DataObjectSerializerImplementation {
  33
  34     private static final Logger LOG = LoggerFactory.getLogger(AugmentableDispatchSerializer.class);
  35
  36     @Override
  37     public void serialize(final DataObjectSerializerRegistry reg, final DataObject obj,
  38             final BindingStreamEventWriter stream) throws IOException {
  39         if (obj instanceof Augmentable<?>) {
  40             final Map<Class<? extends Augmentation<?>>, Augmentation<?>> augmentations;
  41             if (reg instanceof AugmentationReader) {
  42                 augmentations = ((AugmentationReader) reg).getAugmentations(obj);
  43             } else if (Proxy.isProxyClass(obj.getClass())) {
  44                 augmentations = getFromProxy(obj);
  45             } else {
  46                 augmentations = BindingReflections.getAugmentations((Augmentable<?>) obj);
  47             }
  48             for (final Entry<Class<? extends Augmentation<?>>, Augmentation<?>> aug : augmentations.entrySet()) {
  49                 emitAugmentation(aug.getKey(), aug.getValue(), stream, reg);
  50             }
  51         }
  52     }
  53
  54     private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getFromProxy(final DataObject obj) {
  55         final InvocationHandler proxy = Proxy.getInvocationHandler(obj);
  56         if (proxy instanceof AugmentationReader) {
  57             return ((AugmentationReader) proxy).getAugmentations(obj);
  58         }
  59         return Collections.emptyMap();
  60     }
  61
  62     @SuppressWarnings("rawtypes")
  63     private static void emitAugmentation(final Class type, final Augmentation<?> value,
  64             final BindingStreamEventWriter stream, final DataObjectSerializerRegistry registry) throws IOException {
  65         /*
  66          * Binding Specification allowed to insert augmentation with null for
  67          * value, which effectively could be used to remove augmentation
  68          * from builder / DTO.
  69          */
  70         if(value == null) {
  71             return;
  72         }
  73         Preconditions.checkArgument(value instanceof DataObject);
  74         @SuppressWarnings("unchecked")
  75         final DataObjectSerializer serializer = registry.getSerializer(type);
  76         if (serializer != null) {
  77             serializer.serialize((DataObject) value, stream);
  78         } else {
  79             LOG.warn("DataObjectSerializer is not present for {} in registry {}", type, registry);
  80         }
  81     }
  82 }