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