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