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