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.mdsal.binding.dom.codec.impl;
10 import static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
13 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
14 import java.io.IOException;
15 import java.time.Instant;
16 import java.util.AbstractMap.SimpleEntry;
17 import java.util.ArrayList;
18 import java.util.List;
19 import java.util.Map.Entry;
20 import java.util.Optional;
21 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
22 import java.util.function.BiFunction;
23 import java.util.function.Function;
24 import org.eclipse.jdt.annotation.NonNull;
25 import org.eclipse.jdt.annotation.NonNullByDefault;
26 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
27 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
28 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
32 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
33 import org.opendaylight.mdsal.binding.dom.codec.util.AbstractBindingLazyContainerNode;
34 import org.opendaylight.mdsal.binding.generator.api.BindingRuntimeContext;
35 import org.opendaylight.yangtools.yang.binding.Action;
36 import org.opendaylight.yangtools.yang.binding.DataContainer;
37 import org.opendaylight.yangtools.yang.binding.DataObject;
38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
40 import org.opendaylight.yangtools.yang.binding.Notification;
41 import org.opendaylight.yangtools.yang.binding.RpcInput;
42 import org.opendaylight.yangtools.yang.binding.RpcOutput;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
45 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
50 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
53 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
54 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
55 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
59 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry,
60 BindingCodecTreeFactory, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer {
61 private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
63 private static final AtomicReferenceFieldUpdater<BindingNormalizedNodeCodecRegistry, BindingCodecContext> UPDATER =
64 AtomicReferenceFieldUpdater.newUpdater(BindingNormalizedNodeCodecRegistry.class, BindingCodecContext.class,
66 private volatile BindingCodecContext codecContext;
68 public BindingNormalizedNodeCodecRegistry() {
72 public BindingNormalizedNodeCodecRegistry(final BindingRuntimeContext codecContext) {
74 onBindingRuntimeContextUpdated(codecContext);
78 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
79 return codecContext().getSerializer(type);
82 public BindingCodecTree getCodecContext() {
86 public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
87 // BindingCodecContext is a costly resource. Let us not ditch it unless we have to
88 final BindingCodecContext current = codecContext;
89 if (current != null && context.equals(current.getRuntimeContext())) {
90 LOG.debug("Skipping update of runtime context {}", context);
94 final BindingCodecContext updated = new BindingCodecContext(context, this);
95 if (!UPDATER.compareAndSet(this, current, updated)) {
96 LOG.warn("Concurrent update of runtime context (expected={} current={}) detected at ", current,
97 codecContext, new Throwable());
101 final @NonNull BindingCodecContext codecContext() {
102 final BindingCodecContext local = codecContext;
103 checkState(local != null, "No context available yet");
108 public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
109 return codecContext.getInstanceIdentifierCodec().serialize(binding);
113 public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
114 return codecContext.getInstanceIdentifierCodec().deserialize(dom);
118 public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?,?>> toNormalizedNode(
119 final InstanceIdentifier<T> path, final T data) {
120 final NormalizedNodeResult result = new NormalizedNodeResult();
121 // We create DOM stream writer which produces normalized nodes
122 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
124 // We create Binding Stream Writer which translates from Binding to Normalized Nodes
125 final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path,
128 // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
130 getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
131 } catch (final IOException e) {
132 LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
133 throw new IllegalStateException("Failed to create normalized node", e);
135 return new SimpleEntry<>(writeCtx.getKey(),result.getResult());
139 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
140 public ContainerNode toNormalizedNodeNotification(final Notification data) {
141 // FIXME: Should the cast to DataObject be necessary?
142 return serializeDataObject((DataObject) data,
143 // javac does not like a methodhandle here
144 (iface, domWriter) -> newNotificationWriter(iface.asSubclass(Notification.class), domWriter));
148 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
149 public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
150 // FIXME: Should the cast to DataObject be necessary?
151 return serializeDataObject((DataObject) data, this::newRpcWriter);
155 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
156 final RpcInput input) {
157 return serializeDataObject(input, (iface, domWriter) -> newActionInputWriter(action, domWriter));
161 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
162 final RpcOutput output) {
163 return serializeDataObject(output, (iface, domWriter) -> newActionOutputWriter(action, domWriter));
167 public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
168 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
169 return new LazyActionInputContainerNode(identifier, input, this, action);
173 public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
174 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
175 return new LazyActionOutputContainerNode(identifier, output, this, action);
178 private <T extends DataContainer> ContainerNode serializeDataObject(final DataObject data,
179 final BiFunction<Class<? extends T>, NormalizedNodeStreamWriter, BindingStreamEventWriter> newWriter) {
180 final NormalizedNodeResult result = new NormalizedNodeResult();
181 // We create DOM stream writer which produces normalized nodes
182 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
183 final Class<? extends DataObject> type = data.implementedInterface();
184 @SuppressWarnings("unchecked")
185 final BindingStreamEventWriter writer = newWriter.apply((Class<T>)type, domWriter);
187 getSerializer(type).serialize(data, writer);
188 } catch (final IOException e) {
189 LOG.error("Unexpected failure while serializing data {}", data, e);
190 throw new IllegalStateException("Failed to create normalized node", e);
192 return (ContainerNode) result.getResult();
195 private static boolean notBindingRepresentable(final NormalizedNode<?, ?> data) {
196 // ValueNode covers LeafNode and LeafSetEntryNode
197 return data instanceof ValueNode
198 || data instanceof MapNode || data instanceof UnkeyedListNode
199 || data instanceof ChoiceNode
200 || data instanceof LeafSetNode;
204 public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
205 final NormalizedNode<?, ?> data) {
206 if (notBindingRepresentable(data)) {
210 final List<PathArgument> builder = new ArrayList<>();
211 final BindingDataObjectCodecTreeNode<?> codec = codecContext.getCodecContextNode(path, builder);
214 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
220 final DataObject lazyObj = codec.deserialize(data);
221 final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
222 return new SimpleEntry<>(bindingPath, lazyObj);
226 public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
227 final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
228 return codec.deserialize(data);
232 public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
233 final Instant eventInstant) {
234 if (eventInstant == null) {
235 return fromNormalizedNodeNotification(path, data);
238 final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
239 return codec.deserialize(data, eventInstant);
243 public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
244 final RpcInputCodec<?> codec = codecContext.getRpcInputCodec(path);
245 return codec.deserialize(data);
249 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
250 final ContainerNode input) {
251 return (T) requireNonNull(codecContext.getActionCodec(action).input().deserialize(requireNonNull(input)));
255 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
256 final ContainerNode output) {
257 return (T) requireNonNull(codecContext.getActionCodec(action).output().deserialize(requireNonNull(output)));
261 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
262 final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
263 return codecContext.newWriter(path, domWriter);
267 public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
268 final NormalizedNodeStreamWriter domWriter) {
269 return codecContext.newWriterWithoutIdentifier(path, domWriter);
273 public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
274 final NormalizedNodeStreamWriter streamWriter) {
275 return codecContext.newNotificationWriter(notification, streamWriter);
279 public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
280 final NormalizedNodeStreamWriter domWriter) {
281 return codecContext.getActionCodec(action).input().createWriter(domWriter);
285 public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
286 final NormalizedNodeStreamWriter domWriter) {
287 return codecContext.getActionCodec(action).output().createWriter(domWriter);
291 public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
292 final NormalizedNodeStreamWriter streamWriter) {
293 return codecContext.newRpcWriter(rpcInputOrOutput,streamWriter);
296 public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
297 final InstanceIdentifier<T> path) {
298 final DataObjectCodecContext<?,?> ctx = (DataObjectCodecContext<?,?>) codecContext.getCodecContextNode(path,
300 return new DeserializeFunction<>(ctx);
304 public BindingCodecTree create(final BindingRuntimeContext context) {
305 return new BindingCodecContext(context, this);
308 private static final class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
309 private final DataObjectCodecContext<?,?> ctx;
311 DeserializeFunction(final DataObjectCodecContext<?,?> ctx) {
315 @SuppressWarnings("unchecked")
317 public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
318 return input.map(data -> (T) ctx.deserialize(data));
323 private abstract static class AbstractLazyActionContainerNode<T extends DataObject>
324 extends AbstractBindingLazyContainerNode<T, BindingNormalizedNodeCodecRegistry> {
325 protected final Class<? extends Action<?, ?, ?>> action;
327 AbstractLazyActionContainerNode(final NodeIdentifier identifier, final T bindingData,
328 final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
329 super(identifier, bindingData, context);
330 this.action = requireNonNull(action);
335 private static final class LazyActionInputContainerNode extends AbstractLazyActionContainerNode<RpcInput> {
336 LazyActionInputContainerNode(final NodeIdentifier identifier, final RpcInput bindingData,
337 final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
338 super(identifier, bindingData, context, action);
342 protected ContainerNode computeContainerNode(final BindingNormalizedNodeCodecRegistry context) {
343 return context.toNormalizedNodeActionInput(action, getDataObject());
348 private static final class LazyActionOutputContainerNode extends AbstractLazyActionContainerNode<RpcOutput> {
349 LazyActionOutputContainerNode(final NodeIdentifier identifier, final RpcOutput bindingData,
350 final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
351 super(identifier, bindingData, context, action);
355 protected ContainerNode computeContainerNode(final BindingNormalizedNodeCodecRegistry context) {
356 return context.toNormalizedNodeActionOutput(action, getDataObject());