binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/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.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  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.binding.runtime.api.BindingRuntimeContext;
  27 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  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.spi.AbstractBindingLazyContainerNode;
  34 import org.opendaylight.yangtools.yang.binding.Action;
  35 import org.opendaylight.yangtools.yang.binding.DataContainer;
  36 import org.opendaylight.yangtools.yang.binding.DataObject;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  39 import org.opendaylight.yangtools.yang.binding.Notification;
  40 import org.opendaylight.yangtools.yang.binding.RpcInput;
  41 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  54 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 public class BindingNormalizedNodeCodecRegistry implements DataObjectSerializerRegistry,
  59         BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer {
  60     private static final Logger LOG = LoggerFactory.getLogger(BindingNormalizedNodeCodecRegistry.class);
  61
  62     private static final AtomicReferenceFieldUpdater<BindingNormalizedNodeCodecRegistry, BindingCodecContext> UPDATER =
  63             AtomicReferenceFieldUpdater.newUpdater(BindingNormalizedNodeCodecRegistry.class, BindingCodecContext.class,
  64                 "codecContext");
  65     private volatile BindingCodecContext codecContext;
  66
  67     public BindingNormalizedNodeCodecRegistry() {
  68
  69     }
  70
  71     public BindingNormalizedNodeCodecRegistry(final BindingRuntimeContext codecContext) {
  72         this();
  73         onBindingRuntimeContextUpdated(codecContext);
  74     }
  75
  76     @Override
  77     public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
  78         return codecContext().getSerializer(type);
  79     }
  80
  81     public BindingCodecTree getCodecContext() {
  82         return codecContext;
  83     }
  84
  85     public void onBindingRuntimeContextUpdated(final BindingRuntimeContext context) {
  86         // BindingCodecContext is a costly resource. Let us not ditch it unless we have to
  87         final BindingCodecContext current = codecContext;
  88         if (current != null && context.equals(current.getRuntimeContext())) {
  89             LOG.debug("Skipping update of runtime context {}", context);
  90             return;
  91         }
  92
  93         final BindingCodecContext updated = new BindingCodecContext(context, this);
  94         if (!UPDATER.compareAndSet(this, current, updated)) {
  95             LOG.warn("Concurrent update of runtime context (expected={} current={}) detected at ", current,
  96                 codecContext, new Throwable());
  97         }
  98     }
  99
 100     final @NonNull BindingCodecContext codecContext() {
 101         final BindingCodecContext local = codecContext;
 102         checkState(local != null, "No context available yet");
 103         return local;
 104     }
 105
 106     @Override
 107     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 108         return codecContext.getInstanceIdentifierCodec().serialize(binding);
 109     }
 110
 111     @Override
 112     public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 113         return codecContext.getInstanceIdentifierCodec().deserialize(dom);
 114     }
 115
 116     @Override
 117     public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?,?>> toNormalizedNode(
 118             final InstanceIdentifier<T> path, final T data) {
 119         final NormalizedNodeResult result = new NormalizedNodeResult();
 120         // We create DOM stream writer which produces normalized nodes
 121         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 122
 123         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 124         final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = codecContext.newWriter(path,
 125             domWriter);
 126
 127         // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 128         try {
 129             getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
 130         } catch (final IOException e) {
 131             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 132             throw new IllegalStateException("Failed to create normalized node", e);
 133         }
 134         return new SimpleEntry<>(writeCtx.getKey(),result.getResult());
 135     }
 136
 137     @Override
 138     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 139     public ContainerNode toNormalizedNodeNotification(final Notification data) {
 140         // FIXME: Should the cast to DataObject be necessary?
 141         return serializeDataObject((DataObject) data,
 142             // javac does not like a methodhandle here
 143             (iface, domWriter) -> newNotificationWriter(iface.asSubclass(Notification.class), domWriter));
 144     }
 145
 146     @Override
 147     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 148     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 149         // FIXME: Should the cast to DataObject be necessary?
 150         return serializeDataObject((DataObject) data, this::newRpcWriter);
 151     }
 152
 153     @Override
 154     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 155             final RpcInput input) {
 156         return serializeDataObject(input, (iface, domWriter) -> newActionInputWriter(action, domWriter));
 157     }
 158
 159     @Override
 160     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 161             final RpcOutput output) {
 162         return serializeDataObject(output, (iface, domWriter) -> newActionOutputWriter(action, domWriter));
 163     }
 164
 165     @Override
 166     public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
 167             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
 168         return new LazyActionInputContainerNode(identifier, input, this, action);
 169     }
 170
 171     @Override
 172     public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
 173             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
 174         return new LazyActionOutputContainerNode(identifier, output, this, action);
 175     }
 176
 177     private <T extends DataContainer> ContainerNode serializeDataObject(final DataObject data,
 178             final BiFunction<Class<? extends T>, NormalizedNodeStreamWriter, BindingStreamEventWriter> newWriter) {
 179         final NormalizedNodeResult result = new NormalizedNodeResult();
 180         // We create DOM stream writer which produces normalized nodes
 181         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 182         final Class<? extends DataObject> type = data.implementedInterface();
 183         @SuppressWarnings("unchecked")
 184         final BindingStreamEventWriter writer = newWriter.apply((Class<T>)type, domWriter);
 185         try {
 186             getSerializer(type).serialize(data, writer);
 187         } catch (final IOException e) {
 188             LOG.error("Unexpected failure while serializing data {}", data, e);
 189             throw new IllegalStateException("Failed to create normalized node", e);
 190         }
 191         return (ContainerNode) result.getResult();
 192     }
 193
 194     private static boolean notBindingRepresentable(final NormalizedNode<?, ?> data) {
 195         // ValueNode covers LeafNode and LeafSetEntryNode
 196         return data instanceof ValueNode
 197                 || data instanceof MapNode || data instanceof UnkeyedListNode
 198                 || data instanceof ChoiceNode
 199                 || data instanceof LeafSetNode;
 200     }
 201
 202     @Override
 203     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 204             final NormalizedNode<?, ?> data) {
 205         if (notBindingRepresentable(data)) {
 206             return null;
 207         }
 208
 209         final List<PathArgument> builder = new ArrayList<>();
 210         final BindingDataObjectCodecTreeNode<?> codec = codecContext.getCodecContextNode(path, builder);
 211         if (codec == null) {
 212             if (data != null) {
 213                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
 214                     data.getClass());
 215             }
 216             return null;
 217         }
 218
 219         final DataObject lazyObj = codec.deserialize(data);
 220         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
 221         return new SimpleEntry<>(bindingPath, lazyObj);
 222     }
 223
 224     @Override
 225     public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
 226         final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
 227         return codec.deserialize(data);
 228     }
 229
 230     @Override
 231     public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
 232             final Instant eventInstant) {
 233         if (eventInstant == null) {
 234             return fromNormalizedNodeNotification(path, data);
 235         }
 236
 237         final NotificationCodecContext<?> codec = codecContext.getNotificationContext(path);
 238         return codec.deserialize(data, eventInstant);
 239     }
 240
 241     @Override
 242     public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
 243         final RpcInputCodec<?> codec = codecContext.getRpcInputCodec(path);
 244         return codec.deserialize(data);
 245     }
 246
 247     @Override
 248     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 249             final ContainerNode input) {
 250         return (T) requireNonNull(codecContext.getActionCodec(action).input().deserialize(requireNonNull(input)));
 251     }
 252
 253     @Override
 254     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 255             final ContainerNode output) {
 256         return (T) requireNonNull(codecContext.getActionCodec(action).output().deserialize(requireNonNull(output)));
 257     }
 258
 259     @Override
 260     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
 261             final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 262         return codecContext.newWriter(path, domWriter);
 263     }
 264
 265     @Override
 266     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
 267             final NormalizedNodeStreamWriter domWriter) {
 268         return codecContext.newWriterWithoutIdentifier(path, domWriter);
 269     }
 270
 271     @Override
 272     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
 273             final NormalizedNodeStreamWriter streamWriter) {
 274         return codecContext.newNotificationWriter(notification, streamWriter);
 275     }
 276
 277     @Override
 278     public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
 279             final NormalizedNodeStreamWriter domWriter) {
 280         return codecContext.getActionCodec(action).input().createWriter(domWriter);
 281     }
 282
 283     @Override
 284     public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
 285             final NormalizedNodeStreamWriter domWriter) {
 286         return codecContext.getActionCodec(action).output().createWriter(domWriter);
 287     }
 288
 289     @Override
 290     public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 291             final NormalizedNodeStreamWriter streamWriter) {
 292         return codecContext.newRpcWriter(rpcInputOrOutput,streamWriter);
 293     }
 294
 295     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  deserializeFunction(
 296             final InstanceIdentifier<T> path) {
 297         final DataObjectCodecContext<?,?> ctx = (DataObjectCodecContext<?,?>) codecContext.getCodecContextNode(path,
 298             null);
 299         return new DeserializeFunction<>(ctx);
 300     }
 301
 302     private static final class DeserializeFunction<T> implements Function<Optional<NormalizedNode<?, ?>>, Optional<T>> {
 303         private final DataObjectCodecContext<?,?> ctx;
 304
 305         DeserializeFunction(final DataObjectCodecContext<?,?> ctx) {
 306             this.ctx = ctx;
 307         }
 308
 309         @SuppressWarnings("unchecked")
 310         @Override
 311         public Optional<T> apply(final Optional<NormalizedNode<?, ?>> input) {
 312             return input.map(data -> (T) ctx.deserialize(data));
 313         }
 314     }
 315
 316     @NonNullByDefault
 317     private abstract static class AbstractLazyActionContainerNode<T extends DataObject>
 318             extends AbstractBindingLazyContainerNode<T, BindingNormalizedNodeCodecRegistry> {
 319         protected final Class<? extends Action<?, ?, ?>> action;
 320
 321         AbstractLazyActionContainerNode(final NodeIdentifier identifier, final T bindingData,
 322             final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
 323             super(identifier, bindingData, context);
 324             this.action = requireNonNull(action);
 325         }
 326     }
 327
 328     @NonNullByDefault
 329     private static final class LazyActionInputContainerNode extends AbstractLazyActionContainerNode<RpcInput> {
 330         LazyActionInputContainerNode(final NodeIdentifier identifier, final RpcInput bindingData,
 331                 final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
 332             super(identifier, bindingData, context, action);
 333         }
 334
 335         @Override
 336         protected ContainerNode computeContainerNode(final BindingNormalizedNodeCodecRegistry context) {
 337             return context.toNormalizedNodeActionInput(action, getDataObject());
 338         }
 339     }
 340
 341     @NonNullByDefault
 342     private static final class LazyActionOutputContainerNode extends AbstractLazyActionContainerNode<RpcOutput> {
 343         LazyActionOutputContainerNode(final NodeIdentifier identifier, final RpcOutput bindingData,
 344                 final BindingNormalizedNodeCodecRegistry context, final Class<? extends Action<?, ?, ?>> action) {
 345             super(identifier, bindingData, context, action);
 346         }
 347
 348         @Override
 349         protected ContainerNode computeContainerNode(final BindingNormalizedNodeCodecRegistry context) {
 350             return context.toNormalizedNodeActionOutput(action, getDataObject());
 351         }
 352     }
 353 }