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