binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingNormalizedNodeCodecRegistry.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.impl;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.cache.CacheBuilder;
  14 import com.google.common.cache.CacheLoader;
  15 import com.google.common.cache.LoadingCache;
  16 import java.io.IOException;
  17 import java.util.AbstractMap.SimpleEntry;
  18 import java.util.ArrayList;
  19 import java.util.List;
  20 import java.util.Map.Entry;
  21 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  22 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
  25 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.DataObjectSerializerGenerator;
  26 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  27 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  28 import org.opendaylight.yangtools.concepts.Delegator;
  29 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  30 import org.opendaylight.yangtools.yang.binding.DataContainer;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  33 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  34 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  37 import org.opendaylight.yangtools.yang.binding.Notification;
  38 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry,
  57         BindingCodecTreeFactory, BindingNormalizedNodeWriterFactory,
  58         BindingNormalizedNodeSerializer {
  59     private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
  60
  61     private final DataObjectSerializerGenerator generator;
  62     private final LoadingCache<Class<? extends DataObject>, DataObjectSerializer> serializers;
  63     private volatile BindingCodecContext codecContext;
  64
  65     public BindingNormalizedNodeCodecRegistry(final DataObjectSerializerGenerator generator) {
  66         this.generator = Preconditions.checkNotNull(generator);
  67         this.serializers = CacheBuilder.newBuilder().weakKeys().build(new GeneratorLoader());
  68     }
  69
  70     @Override
  71     public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
  72         return serializers.getUnchecked(type);
  73     }
  74
  75     public BindingCodecTree getCodecContext() {
  76         return codecContext;
  77     }
  78
  79     public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
  80         codecContext = new BindingCodecContext(context, this);
  81         generator.onBindingRuntimeContextUpdated(context);
  82     }
  83
  84     @Override
  85     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
  86         return codecContext.getInstanceIdentifierCodec().serialize(binding);
  87     }
  88
  89     @Override
  90     public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
  91         return codecContext.getInstanceIdentifierCodec().deserialize(dom);
  92     }
  93
  94     @Override
  95     public <T extends DataObject> Entry<YangInstanceIdentifier,NormalizedNode<?,?>> toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
  96         final NormalizedNodeResult result = new NormalizedNodeResult();
  97         // We create DOM stream writer which produces normalized nodes
  98         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  99
 100         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 101         final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path, domWriter);
 102
 103         // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 104         try {
 105             getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
 106         } catch (final IOException e) {
 107             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 108             throw new IllegalStateException("Failed to create normalized node", e);
 109         }
 110         return new SimpleEntry<>(writeCtx.getKey(),result.getResult());
 111     }
 112
 113     @Override
 114     public ContainerNode toNormalizedNodeNotification(final Notification data) {
 115         final NormalizedNodeResult result = new NormalizedNodeResult();
 116         // We create DOM stream writer which produces normalized nodes
 117         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 118         @SuppressWarnings({ "unchecked", "rawtypes" })
 119         final Class<? extends DataObject> type = (Class) data.getImplementedInterface();
 120         @SuppressWarnings({ "unchecked", "rawtypes" })
 121         final BindingStreamEventWriter writer = newNotificationWriter((Class) type, domWriter);
 122         try {
 123             // FIXME: Should be cast to DataObject necessary?
 124             getSerializer(type).serialize((DataObject) data, writer);
 125         } catch (final IOException e) {
 126             LOG.error("Unexpected failure while serializing data {}", data, e);
 127             throw new IllegalStateException("Failed to create normalized node", e);
 128         }
 129         return (ContainerNode) result.getResult();
 130
 131     }
 132
 133     @Override
 134     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 135         final NormalizedNodeResult result = new NormalizedNodeResult();
 136         // We create DOM stream writer which produces normalized nodes
 137         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 138         @SuppressWarnings({ "unchecked", "rawtypes" })
 139         final Class<? extends DataObject> type = (Class) data.getImplementedInterface();
 140         final BindingStreamEventWriter writer = newRpcWriter(type, domWriter);
 141         try {
 142             // FIXME: Should be cast to DataObject necessary?
 143             getSerializer(type).serialize((DataObject) data, writer);
 144         } catch (final IOException e) {
 145             LOG.error("Unexpected failure while serializing data {}", data, e);
 146             throw new IllegalStateException("Failed to create normalized node", e);
 147         }
 148         return (ContainerNode) result.getResult();
 149     }
 150
 151     private static boolean isBindingRepresentable(final NormalizedNode<?, ?> data) {
 152         if (data instanceof ChoiceNode) {
 153             return false;
 154         }
 155         if (data instanceof LeafNode<?>) {
 156             return false;
 157         }
 158         if (data instanceof LeafSetNode) {
 159             return false;
 160         }
 161         if (data instanceof LeafSetEntryNode<?>) {
 162             return false;
 163         }
 164         if (data instanceof MapNode) {
 165             return false;
 166         }
 167         if (data instanceof UnkeyedListNode) {
 168             return false;
 169         }
 170
 171         return true;
 172     }
 173
 174     @Override
 175     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 176         if (!isBindingRepresentable(data)) {
 177             return null;
 178         }
 179
 180         final List<PathArgument> builder = new ArrayList<>();
 181         final NodeCodecContext<?> codec = codecContext.getCodecContextNode(path, builder);
 182         if (codec == null) {
 183             if (data != null) {
 184                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path, data.getClass());
 185             }
 186             return null;
 187         }
 188
 189         final DataObject lazyObj = codec.deserialize(data);
 190         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
 191         return new SimpleEntry<>(bindingPath, lazyObj);
 192     }
 193
 194     @Override
 195     public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
 196         final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
 197         return codec.deserialize(data);
 198     }
 199
 200     @Override
 201     public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
 202         final RpcInputCodec<?> codec = codecContext.getRpcInputCodec(path);
 203         return codec.deserialize(data);
 204     }
 205
 206    @Override
 207     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 208         return codecContext.newWriter(path, domWriter);
 209     }
 210
 211     @Override
 212     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 213         return codecContext.newWriterWithoutIdentifier(path, domWriter);
 214     }
 215
 216     @Override
 217     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
 218             final NormalizedNodeStreamWriter streamWriter) {
 219         return codecContext.newNotificationWriter(notification, streamWriter);
 220     }
 221
 222     @Override
 223     public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 224             final NormalizedNodeStreamWriter streamWriter) {
 225         return codecContext.newRpcWriter(rpcInputOrOutput,streamWriter);
 226     }
 227
 228     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  deserializeFunction(final InstanceIdentifier<T> path) {
 229         final DataObjectCodecContext<?,?> ctx = (DataObjectCodecContext<?,?>) codecContext.getCodecContextNode(path, null);
 230         return new DeserializeFunction<>(ctx);
 231     }
 232
 233     @Override
 234     public BindingCodecTree create(final BindingRuntimeContext context) {
 235         return new BindingCodecContext(context, this);
 236     }
 237
 238     @Override
 239     public BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
 240         final ModuleInfoBackedContext strategy = ModuleInfoBackedContext.create();
 241         for (final Class<?> bindingCls : bindingClasses) {
 242             try {
 243                 strategy.registerModuleInfo(BindingReflections.getModuleInfo(bindingCls));
 244             } catch (final Exception e) {
 245                 throw new IllegalStateException(
 246                         "Could not create BindingRuntimeContext from class " + bindingCls.getName(),
 247                         e);
 248             }
 249         }
 250         final BindingRuntimeContext runtimeCtx = BindingRuntimeContext.create(strategy, context);
 251         return create(runtimeCtx);
 252     }
 253
 254
 255     private static final class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
 256         private final DataObjectCodecContext<?,?> ctx;
 257
 258         DeserializeFunction(final DataObjectCodecContext<?,?> ctx) {
 259             this.ctx = ctx;
 260         }
 261
 262         @SuppressWarnings("unchecked")
 263         @Override
 264         public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
 265             if (input.isPresent()) {
 266                 return Optional.of((T) ctx.deserialize(input.get()));
 267             }
 268             return Optional.absent();
 269         }
 270     }
 271
 272     private final class GeneratorLoader extends CacheLoader<Class<? extends DataContainer>, DataObjectSerializer> {
 273         @Override
 274         public DataObjectSerializer load(final Class<? extends DataContainer> key) throws Exception {
 275             final DataObjectSerializerImplementation prototype = generator.getSerializer(key);
 276             return new DataObjectSerializerProxy(prototype);
 277         }
 278     }
 279
 280     private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectSerializerImplementation> {
 281         private final DataObjectSerializerImplementation delegate;
 282
 283         DataObjectSerializerProxy(final DataObjectSerializerImplementation delegate) {
 284             this.delegate = delegate;
 285         }
 286
 287         @Override
 288         public DataObjectSerializerImplementation getDelegate() {
 289             return delegate;
 290         }
 291
 292         @Override
 293         public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
 294             delegate.serialize(BindingNormalizedNodeCodecRegistry.this, obj, stream);
 295         }
 296     }
 297
 298 }