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