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.List;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23
  24 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
  25 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeWriterFactory;
  26 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
  27 import org.opendaylight.yangtools.concepts.Delegator;
  28 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  29 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  30 import org.opendaylight.yangtools.yang.binding.DataObject;
  31 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
  32 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  33 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  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.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer {
  51     private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
  52
  53     private final DataObjectSerializerGenerator generator;
  54     private final LoadingCache<Class<? extends DataObject>, DataObjectSerializer> serializers;
  55     private BindingCodecContext codecContext;
  56
  57     public BindingNormalizedNodeCodecRegistry(final DataObjectSerializerGenerator generator) {
  58         this.generator = Preconditions.checkNotNull(generator);
  59         this.serializers = CacheBuilder.newBuilder().weakKeys().build(new GeneratorLoader());
  60     }
  61
  62     @Override
  63     public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
  64         return serializers.getUnchecked(type);
  65     }
  66
  67     public BindingCodecContext getCodecContext() {
  68         return codecContext;
  69     }
  70
  71     public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
  72         codecContext = new BindingCodecContext(context);
  73         generator.onBindingRuntimeContextUpdated(context);
  74     }
  75
  76
  77     @Override
  78     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
  79         return codecContext.getInstanceIdentifierCodec().serialize(binding);
  80     }
  81
  82     @Override
  83     public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
  84         return codecContext.getInstanceIdentifierCodec().deserialize(dom);
  85     }
  86
  87     @Override
  88     public <T extends DataObject> Entry<YangInstanceIdentifier,NormalizedNode<?,?>> toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
  89         NormalizedNodeResult result = new NormalizedNodeResult();
  90         // We create DOM stream writer which produces normalized nodes
  91         NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
  92
  93         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
  94         Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path, domWriter);
  95
  96         // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
  97         try {
  98             getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
  99         } catch (IOException e) {
 100             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 101             throw new IllegalStateException("Failed to create normalized node", e);
 102         }
 103         return new SimpleEntry<YangInstanceIdentifier,NormalizedNode<?,?>>(writeCtx.getKey(),result.getResult());
 104     }
 105
 106     private static boolean isBindingRepresentable(final NormalizedNode<?, ?> data) {
 107         if (data instanceof ChoiceNode) {
 108             return false;
 109         }
 110         if (data instanceof LeafNode<?>) {
 111             return false;
 112         }
 113         if (data instanceof LeafSetNode) {
 114             return false;
 115         }
 116         if( data instanceof LeafSetEntryNode<?>) {
 117             return false;
 118         }
 119         if (data instanceof MapNode) {
 120             return false;
 121         }
 122         if (data instanceof UnkeyedListNode) {
 123             return false;
 124         }
 125
 126         return true;
 127     }
 128
 129     @Override
 130     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 131         if (!isBindingRepresentable(data)) {
 132             return null;
 133         }
 134
 135         final List<PathArgument> builder = new ArrayList<>();
 136         final NodeCodecContext codec = codecContext.getCodecContextNode(path, builder);
 137         if (codec == null) {
 138             if (data != null) {
 139                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path, data.getClass());
 140             }
 141             return null;
 142         }
 143
 144         final DataObject lazyObj = (DataObject) codec.dataFromNormalizedNode(data);
 145         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
 146         return new SimpleEntry<InstanceIdentifier<?>, DataObject>(bindingPath, lazyObj);
 147     }
 148
 149     @Override
 150     public Map<InstanceIdentifier<?>, DataObject> fromNormalizedNodes(final Map<YangInstanceIdentifier, NormalizedNode<?, ?>> dom) {
 151         throw new UnsupportedOperationException("Not implemented yet");
 152     }
 153
 154     @Override
 155     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 156         return codecContext.newWriter(path, domWriter);
 157     }
 158
 159     @Override
 160     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 161         return codecContext.newWriterWithoutIdentifier(path, domWriter);
 162     }
 163
 164
 165     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  deserializeFunction(final InstanceIdentifier<T> path) {
 166         DataObjectCodecContext<?> ctx = (DataObjectCodecContext<?>) codecContext.getCodecContextNode(path, null);
 167         return new DeserializeFunction<T>(ctx);
 168     }
 169
 170
 171     private static class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
 172         private final DataObjectCodecContext<?> ctx;
 173
 174         public DeserializeFunction(final DataObjectCodecContext<?> ctx) {
 175             super();
 176             this.ctx = ctx;
 177         }
 178
 179         @SuppressWarnings("unchecked")
 180         @Override
 181         public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
 182             if(input.isPresent()) {
 183                 return Optional.of((T) ctx.dataFromNormalizedNode(input.get()));
 184             }
 185             return Optional.absent();
 186         }
 187     }
 188
 189     private class GeneratorLoader extends CacheLoader<Class<? extends DataObject>, DataObjectSerializer> {
 190
 191         @Override
 192         public DataObjectSerializer load(final Class<? extends DataObject> key) throws Exception {
 193             DataObjectSerializerImplementation prototype = generator.getSerializer(key);
 194             return new DataObjectSerializerProxy(prototype);
 195         }
 196     }
 197
 198     private class DataObjectSerializerProxy implements DataObjectSerializer,
 199             Delegator<DataObjectSerializerImplementation> {
 200
 201         private final DataObjectSerializerImplementation delegate;
 202
 203         DataObjectSerializerProxy(final DataObjectSerializerImplementation delegate) {
 204             this.delegate = delegate;
 205         }
 206
 207         @Override
 208         public DataObjectSerializerImplementation getDelegate() {
 209             return delegate;
 210         }
 211
 212         @Override
 213         public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
 214             delegate.serialize(BindingNormalizedNodeCodecRegistry.this, obj, stream);
 215         }
 216     }
 217
 218 }