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;
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.BindingCodecTreeFactory;
22 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
23 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeWriterFactory;
24 import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
25 import org.opendaylight.yangtools.concepts.Delegator;
26 import org.opendaylight.yangtools.sal.binding.generator.impl.ModuleInfoBackedContext;
27 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
28 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
29 import org.opendaylight.yangtools.yang.binding.DataContainer;
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.binding.Notification;
37 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
43 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
48 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
49 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
51 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry,
56 BindingCodecTreeFactory, BindingNormalizedNodeWriterFactory,
57 BindingNormalizedNodeSerializer {
58 private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
60 private final DataObjectSerializerGenerator generator;
61 private final LoadingCache<Class<? extends DataObject>, DataObjectSerializer> serializers;
62 private volatile BindingCodecContext codecContext;
64 public BindingNormalizedNodeCodecRegistry(final DataObjectSerializerGenerator generator) {
65 this.generator = Preconditions.checkNotNull(generator);
66 this.serializers = CacheBuilder.newBuilder().weakKeys().build(new GeneratorLoader());
70 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
71 return serializers.getUnchecked(type);
74 public BindingCodecContext getCodecContext() {
78 public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
79 codecContext = create(context);
80 generator.onBindingRuntimeContextUpdated(context);
85 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
86 return codecContext.getInstanceIdentifierCodec().serialize(binding);
90 public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
91 return codecContext.getInstanceIdentifierCodec().deserialize(dom);
95 public <T extends DataObject> Entry<YangInstanceIdentifier,NormalizedNode<?,?>> toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
96 final NormalizedNodeResult result = new NormalizedNodeResult();
97 // We create DOM stream writer which produces normalized nodes
98 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
100 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
101 final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path, domWriter);
103 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
105 getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
106 } catch (final IOException e) {
107 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
108 throw new IllegalStateException("Failed to create normalized node", e);
110 return new SimpleEntry<YangInstanceIdentifier,NormalizedNode<?,?>>(writeCtx.getKey(),result.getResult());
114 public ContainerNode toNormalizedNodeNotification(final Notification data) {
115 final NormalizedNodeResult result = new NormalizedNodeResult();
116 // We create DOM stream writer which produces normalized nodes
117 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
118 @SuppressWarnings({ "unchecked", "rawtypes" })
119 final Class<? extends DataObject> type = (Class) data.getImplementedInterface();
120 @SuppressWarnings({ "unchecked", "rawtypes" })
121 final BindingStreamEventWriter writer = newNotificationWriter((Class) type, domWriter);
123 // FIXME: Should be cast to DataObject necessary?
124 getSerializer(type).serialize((DataObject) data, writer);
125 } catch (final IOException e) {
126 LOG.error("Unexpected failure while serializing data {}", data, e);
127 throw new IllegalStateException("Failed to create normalized node", e);
129 return (ContainerNode) result.getResult();
134 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
135 final NormalizedNodeResult result = new NormalizedNodeResult();
136 // We create DOM stream writer which produces normalized nodes
137 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
138 @SuppressWarnings({ "unchecked", "rawtypes" })
139 final Class<? extends DataObject> type = (Class) data.getImplementedInterface();
140 final BindingStreamEventWriter writer = newRpcWriter(type, domWriter);
142 // FIXME: Should be cast to DataObject necessary?
143 getSerializer(type).serialize((DataObject) data, writer);
144 } catch (final IOException e) {
145 LOG.error("Unexpected failure while serializing data {}", data, e);
146 throw new IllegalStateException("Failed to create normalized node", e);
148 return (ContainerNode) result.getResult();
151 private static boolean isBindingRepresentable(final NormalizedNode<?, ?> data) {
152 if (data instanceof ChoiceNode) {
155 if (data instanceof LeafNode<?>) {
158 if (data instanceof LeafSetNode) {
161 if( data instanceof LeafSetEntryNode<?>) {
164 if (data instanceof MapNode) {
167 if (data instanceof UnkeyedListNode) {
175 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
176 if (!isBindingRepresentable(data)) {
180 final List<PathArgument> builder = new ArrayList<>();
181 final NodeCodecContext<?> codec = codecContext.getCodecContextNode(path, builder);
184 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path, data.getClass());
189 final DataObject lazyObj = codec.deserialize(data);
190 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
191 return new SimpleEntry<InstanceIdentifier<?>, DataObject>(bindingPath, lazyObj);
195 public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
196 final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
197 return codec.deserialize(data);
201 public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
202 final ContainerNodeCodecContext<?> codec = codecContext.getRpcDataContext(path);
203 return codec.deserialize(data);
207 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
208 return codecContext.newWriter(path, domWriter);
212 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
213 return codecContext.newWriterWithoutIdentifier(path, domWriter);
217 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
218 final NormalizedNodeStreamWriter streamWriter) {
219 return codecContext.newNotificationWriter(notification, streamWriter);
223 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
224 final NormalizedNodeStreamWriter streamWriter) {
225 return codecContext.newRpcWriter(rpcInputOrOutput,streamWriter);
228 public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(final InstanceIdentifier<T> path) {
229 final DataObjectCodecContext<?,?> ctx = (DataObjectCodecContext<?,?>) codecContext.getCodecContextNode(path, null);
230 return new DeserializeFunction<T>(ctx);
234 public BindingCodecContext create(BindingRuntimeContext context) {
235 return new BindingCodecContext(context, this);
239 public BindingCodecContext create(SchemaContext context, Class<?>... bindingClasses) {
240 ModuleInfoBackedContext strategy = ModuleInfoBackedContext.create();
241 for (Class<?> bindingCls : bindingClasses) {
243 strategy.registerModuleInfo(BindingReflections.getModuleInfo(bindingCls));
244 } catch (Exception e) {
245 throw new IllegalStateException(
246 "Could not create BindingRuntimeContext from class " + bindingCls.getName(),
250 BindingRuntimeContext runtimeCtx = BindingRuntimeContext.create(strategy, context);
251 return create(runtimeCtx);
255 private static final class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
256 private final DataObjectCodecContext<?,?> ctx;
258 DeserializeFunction(final DataObjectCodecContext<?,?> ctx) {
262 @SuppressWarnings("unchecked")
264 public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
265 if (input.isPresent()) {
266 return Optional.of((T) ctx.deserialize(input.get()));
268 return Optional.absent();
272 private final class GeneratorLoader extends CacheLoader<Class<? extends DataContainer>, DataObjectSerializer> {
274 public DataObjectSerializer load(final Class<? extends DataContainer> key) throws Exception {
275 final DataObjectSerializerImplementation prototype = generator.getSerializer(key);
276 return new DataObjectSerializerProxy(prototype);
280 private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectSerializerImplementation> {
281 private final DataObjectSerializerImplementation delegate;
283 DataObjectSerializerProxy(final DataObjectSerializerImplementation delegate) {
284 this.delegate = delegate;
288 public DataObjectSerializerImplementation getDelegate() {
293 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
294 delegate.serialize(BindingNormalizedNodeCodecRegistry.this, obj, stream);