2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.binding.data.codec.impl;
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;
17 import java.io.IOException;
18 import java.util.AbstractMap.SimpleEntry;
19 import java.util.ArrayList;
20 import java.util.List;
22 import java.util.Map.Entry;
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;
50 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer {
51 private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
53 private final DataObjectSerializerGenerator generator;
54 private final LoadingCache<Class<? extends DataObject>, DataObjectSerializer> serializers;
55 private BindingCodecContext codecContext;
57 public BindingNormalizedNodeCodecRegistry(final DataObjectSerializerGenerator generator) {
58 this.generator = Preconditions.checkNotNull(generator);
59 this.serializers = CacheBuilder.newBuilder().weakKeys().build(new GeneratorLoader());
63 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
64 return serializers.getUnchecked(type);
67 public BindingCodecContext getCodecContext() {
71 public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
72 codecContext = new BindingCodecContext(context);
73 generator.onBindingRuntimeContextUpdated(context);
78 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
79 return codecContext.getInstanceIdentifierCodec().serialize(binding);
83 public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
84 return codecContext.getInstanceIdentifierCodec().deserialize(dom);
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);
93 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
94 Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path, domWriter);
96 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
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);
103 return new SimpleEntry<YangInstanceIdentifier,NormalizedNode<?,?>>(writeCtx.getKey(),result.getResult());
106 private static boolean isBindingRepresentable(final NormalizedNode<?, ?> data) {
107 if (data instanceof ChoiceNode) {
110 if (data instanceof LeafNode<?>) {
113 if (data instanceof LeafSetNode) {
116 if( data instanceof LeafSetEntryNode<?>) {
119 if (data instanceof MapNode) {
122 if (data instanceof UnkeyedListNode) {
130 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
131 if (!isBindingRepresentable(data)) {
135 final List<PathArgument> builder = new ArrayList<>();
136 final NodeCodecContext codec = codecContext.getCodecContextNode(path, builder);
139 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path, data.getClass());
144 final DataObject lazyObj = (DataObject) codec.dataFromNormalizedNode(data);
145 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
146 return new SimpleEntry<InstanceIdentifier<?>, DataObject>(bindingPath, lazyObj);
150 public Map<InstanceIdentifier<?>, DataObject> fromNormalizedNodes(final Map<YangInstanceIdentifier, NormalizedNode<?, ?>> dom) {
151 throw new UnsupportedOperationException("Not implemented yet");
155 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
156 return codecContext.newWriter(path, domWriter);
160 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
161 return codecContext.newWriterWithoutIdentifier(path, domWriter);
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);
171 private static class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
172 private final DataObjectCodecContext<?> ctx;
174 public DeserializeFunction(final DataObjectCodecContext<?> ctx) {
179 @SuppressWarnings("unchecked")
181 public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
182 if(input.isPresent()) {
183 return Optional.of((T) ctx.dataFromNormalizedNode(input.get()));
185 return Optional.absent();
189 private class GeneratorLoader extends CacheLoader<Class<? extends DataObject>, DataObjectSerializer> {
192 public DataObjectSerializer load(final Class<? extends DataObject> key) throws Exception {
193 DataObjectSerializerImplementation prototype = generator.getSerializer(key);
194 return new DataObjectSerializerProxy(prototype);
198 private class DataObjectSerializerProxy implements DataObjectSerializer,
199 Delegator<DataObjectSerializerImplementation> {
201 private final DataObjectSerializerImplementation delegate;
203 DataObjectSerializerProxy(final DataObjectSerializerImplementation delegate) {
204 this.delegate = delegate;
208 public DataObjectSerializerImplementation getDelegate() {
213 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
214 delegate.serialize(BindingNormalizedNodeCodecRegistry.this, obj, stream);