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
  17 import java.io.IOException;
  18 import java.util.AbstractMap.SimpleEntry;
  19 import java.util.ArrayList;
  20 import java.util.LinkedList;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Map.Entry;
  24
  25 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
  26 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeWriterFactory;
  27 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  28 import org.opendaylight.yangtools.concepts.Delegator;
  29 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  30 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  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.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer {
  50     private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
  51
  52     private final DataObjectSerializerGenerator generator;
  53     private final LoadingCache<Class<? extends DataObject>, DataObjectSerializer> serializers;
  54     private BindingCodecContext codecContext;
  55
  56     public BindingNormalizedNodeCodecRegistry(final DataObjectSerializerGenerator generator) {
  57         this.generator = Preconditions.checkNotNull(generator);
  58         this.serializers = CacheBuilder.newBuilder().weakKeys().build(new GeneratorLoader());
  59     }
  60
  61     @Override
  62     public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
  63         return serializers.getUnchecked(type);
  64     }
  65
  66     public BindingCodecContext getCodecContext() {
  67         return codecContext;
  68     }
  69
  70     public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
  71         codecContext = new BindingCodecContext(context);
  72         generator.onBindingRuntimeContextUpdated(context);
  73     }
  74
  75
  76     @Override
  77     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
  78         List<YangInstanceIdentifier.PathArgument> builder = new LinkedList<>();
  79         codecContext.getCodecContextNode(binding, builder);
  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         NormalizedNodeResult result = new NormalizedNodeResult();
  91         // We create DOM stream writer which produces normalized nodes
  92         NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  93
  94         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
  95         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 (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     private static boolean isBindingRepresentable(final NormalizedNode<?, ?> data) {
 108         if (data instanceof LeafNode<?>) {
 109             return false;
 110         }
 111         if (data instanceof LeafSetNode) {
 112             return false;
 113         }
 114         if (data instanceof MapNode) {
 115             return false;
 116         }
 117         if (data instanceof UnkeyedListNode) {
 118             return false;
 119         }
 120
 121         return true;
 122     }
 123
 124     @Override
 125     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 126         if (!isBindingRepresentable(data)) {
 127             return null;
 128         }
 129
 130         final List<PathArgument> builder = new ArrayList<>();
 131         final NodeCodecContext codec = codecContext.getCodecContextNode(path, builder);
 132         if (codec == null) {
 133             // FIXME: do we allow data == null?
 134             if (data != null) {
 135                 LOG.warn("Path %s does not have a binding equivalent, should have been caught earlier", path);
 136             }
 137             return null;
 138         }
 139
 140         final DataObject lazyObj = (DataObject) codec.dataFromNormalizedNode(data);
 141         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
 142         return new SimpleEntry<InstanceIdentifier<?>, DataObject>(bindingPath, lazyObj);
 143     }
 144
 145     @Override
 146     public Map<InstanceIdentifier<?>, DataObject> fromNormalizedNodes(final Map<YangInstanceIdentifier, NormalizedNode<?, ?>> dom) {
 147         throw new UnsupportedOperationException("Not implemented yet");
 148     }
 149
 150     @Override
 151     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 152         return codecContext.newWriter(path, domWriter);
 153     }
 154
 155     @Override
 156     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 157         return codecContext.newWriterWithoutIdentifier(path, domWriter);
 158     }
 159
 160
 161     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  deserializeFunction(final InstanceIdentifier<T> path) {
 162         DataObjectCodecContext<?> ctx = (DataObjectCodecContext<?>) codecContext.getCodecContextNode(path, null);
 163         return new DeserializeFunction<T>(ctx);
 164     }
 165
 166
 167     private static class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
 168         private final DataObjectCodecContext<?> ctx;
 169
 170         public DeserializeFunction(final DataObjectCodecContext<?> ctx) {
 171             super();
 172             this.ctx = ctx;
 173         }
 174
 175         @SuppressWarnings("unchecked")
 176         @Override
 177         public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
 178             if(input.isPresent()) {
 179                 return Optional.of((T) ctx.dataFromNormalizedNode(input.get()));
 180             }
 181             return Optional.absent();
 182         }
 183     }
 184
 185     private class GeneratorLoader extends CacheLoader<Class<? extends DataObject>, DataObjectSerializer> {
 186
 187         @Override
 188         public DataObjectSerializer load(final Class<? extends DataObject> key) throws Exception {
 189             DataObjectSerializerImplementation prototype = generator.getSerializer(key);
 190             return new DataObjectSerializerProxy(prototype);
 191         }
 192     }
 193
 194     private class DataObjectSerializerProxy implements DataObjectSerializer,
 195             Delegator<DataObjectSerializerImplementation> {
 196
 197         private final DataObjectSerializerImplementation delegate;
 198
 199         DataObjectSerializerProxy(final DataObjectSerializerImplementation delegate) {
 200             this.delegate = delegate;
 201         }
 202
 203         @Override
 204         public DataObjectSerializerImplementation getDelegate() {
 205             return delegate;
 206         }
 207
 208         @Override
 209         public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
 210             delegate.serialize(BindingNormalizedNodeCodecRegistry.this, obj, stream);
 211         }
 212     }
 213
 214 }