binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/BindingToNormalizedNodeCodec.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.adapter;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.cache.CacheBuilder;
  15 import com.google.common.cache.CacheLoader;
  16 import com.google.common.cache.LoadingCache;
  17 import com.google.common.collect.ImmutableBiMap;
  18 import com.google.common.collect.ImmutableSet;
  19 import com.google.common.collect.Iterators;
  20 import java.lang.reflect.Method;
  21 import java.util.AbstractMap.SimpleEntry;
  22 import java.util.Collection;
  23 import java.util.HashSet;
  24 import java.util.Map.Entry;
  25 import java.util.Optional;
  26 import java.util.Set;
  27 import java.util.concurrent.TimeUnit;
  28 import java.util.function.Function;
  29 import java.util.stream.Collectors;
  30 import org.eclipse.jdt.annotation.NonNull;
  31 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  32 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  33 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  34 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  35 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  36 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
  37 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  38 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  39 import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException;
  40 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
  41 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  42 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  43 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  44 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  45 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  46 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  47 import org.opendaylight.yangtools.yang.binding.Action;
  48 import org.opendaylight.yangtools.yang.binding.DataContainer;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  52 import org.opendaylight.yangtools.yang.binding.Notification;
  53 import org.opendaylight.yangtools.yang.binding.RpcInput;
  54 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  55 import org.opendaylight.yangtools.yang.binding.RpcService;
  56 import org.opendaylight.yangtools.yang.common.QNameModule;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  59 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  61 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  62 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  63 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  64 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  65 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  66 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  67 import org.opendaylight.yangtools.yang.model.api.Module;
  68 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  69 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  70 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  71 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  72 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  73 import org.slf4j.Logger;
  74 import org.slf4j.LoggerFactory;
  75
  76 /**
  77  * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
  78  * caching of instance identifiers.
  79  *
  80  * <p>
  81  * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
  82  */
  83 public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
  84         BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
  85
  86     private static final long WAIT_DURATION_SEC = 5;
  87     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
  88
  89     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
  90             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  91                 @Override
  92                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  93                     return toYangInstanceIdentifierBlocking(key);
  94                 }
  95             });
  96     private final BindingNormalizedNodeCodecRegistry codecRegistry;
  97     private final ClassLoadingStrategy classLoadingStrategy;
  98     private final FutureSchema futureSchema;
  99     private ListenerRegistration<?> listenerRegistration;
 100
 101     public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
 102             final BindingNormalizedNodeCodecRegistry codecRegistry) {
 103         this(classLoadingStrategy, codecRegistry, false);
 104     }
 105
 106     public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
 107             final BindingNormalizedNodeCodecRegistry codecRegistry, final boolean waitForSchema) {
 108         this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
 109         this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
 110         this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
 111     }
 112
 113     public static BindingToNormalizedNodeCodec newInstance(final ClassLoadingStrategy classLoadingStrategy,
 114             final DOMSchemaService schemaService) {
 115         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
 116         BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(
 117                 classLoadingStrategy, codecRegistry, true);
 118         instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
 119         return instance;
 120     }
 121
 122     protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
 123             final InstanceIdentifier<? extends DataObject> binding) {
 124         try {
 125             return codecRegistry.toYangInstanceIdentifier(binding);
 126         } catch (final MissingSchemaException e) {
 127             waitForSchema(decompose(binding), e);
 128             return codecRegistry.toYangInstanceIdentifier(binding);
 129         }
 130     }
 131
 132     /**
 133      * Translates supplied Binding Instance Identifier into NormalizedNode
 134      * instance identifier.
 135      *
 136      * @param binding
 137      *            Binding Instance Identifier
 138      * @return DOM Instance Identifier
 139      * @throws IllegalArgumentException
 140      *             If supplied Instance Identifier is not valid.
 141      */
 142     public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
 143         return codecRegistry.toYangInstanceIdentifier(binding);
 144     }
 145
 146     @Override
 147     public final YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 148         return codecRegistry.toYangInstanceIdentifier(binding);
 149     }
 150
 151     protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
 152         return iiCache.getUnchecked(binding);
 153     }
 154
 155     @Override
 156     public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 157             final InstanceIdentifier<T> path, final T data) {
 158         try {
 159             return codecRegistry.toNormalizedNode(path, data);
 160         } catch (final MissingSchemaException e) {
 161             waitForSchema(decompose(path), e);
 162             return codecRegistry.toNormalizedNode(path, data);
 163         }
 164     }
 165
 166     /**
 167      * Converts Binding Map.Entry to DOM Map.Entry.
 168      *
 169      * <p>
 170      * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
 171      *
 172      * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
 173      * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
 174      *         as value.
 175      */
 176     @SuppressWarnings({"unchecked", "rawtypes"})
 177     public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 178             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
 179         return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
 180     }
 181
 182     @Override
 183     public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 184             final NormalizedNode<?, ?> data) {
 185         return codecRegistry.fromNormalizedNode(path, data);
 186     }
 187
 188     @Override
 189     public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
 190         return codecRegistry.fromNormalizedNodeNotification(path, data);
 191     }
 192
 193     @Override
 194     public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
 195         return codecRegistry.fromNormalizedNodeRpcData(path, data);
 196     }
 197
 198     @Override
 199     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 200             final ContainerNode input) {
 201         return codecRegistry.fromNormalizedNodeActionInput(action, input);
 202     }
 203
 204     @Override
 205     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 206             final ContainerNode output) {
 207         return codecRegistry.fromNormalizedNodeActionOutput(action, output);
 208     }
 209
 210     @Override
 211     public final InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 212         return codecRegistry.fromYangInstanceIdentifier(dom);
 213     }
 214
 215     @Override
 216     public final ContainerNode toNormalizedNodeNotification(final Notification data) {
 217         return codecRegistry.toNormalizedNodeNotification(data);
 218     }
 219
 220     @Override
 221     public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 222         return codecRegistry.toNormalizedNodeRpcData(data);
 223     }
 224
 225     @Override
 226     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 227             final RpcInput input) {
 228         return codecRegistry.toNormalizedNodeActionInput(action, input);
 229     }
 230
 231     @Override
 232     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 233             final RpcOutput output) {
 234         return codecRegistry.toNormalizedNodeActionOutput(action, output);
 235     }
 236
 237     @Override
 238     public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
 239             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
 240         return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
 241     }
 242
 243     @Override
 244     public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
 245             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
 246         return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
 247     }
 248
 249     /**
 250      * Returns a Binding-Aware instance identifier from normalized
 251      * instance-identifier if it is possible to create representation.
 252      *
 253      * <p>
 254      * Returns Optional.empty for cases where target is mixin node except
 255      * augmentation.
 256      */
 257     public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
 258                     throws DeserializationException {
 259         try {
 260             return Optional.ofNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
 261         } catch (final IllegalArgumentException e) {
 262             return Optional.empty();
 263         }
 264     }
 265
 266     public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
 267             final @NonNull Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
 268                     throws DeserializationException {
 269         try {
 270             /*
 271              * This cast is required, due to generics behaviour in openjdk / oracle javac.
 272              *
 273              * <p>
 274              * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
 275              * this means '?' is always  <? extends DataObject>. Eclipse compiler
 276              * is able to determine this relationship and treats
 277              * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
 278              * as assignable. However openjdk / oracle javac treats this two types
 279              * as incompatible and issues a compile error.
 280              *
 281              * <p>
 282              * It is safe to lose generic information and cast it to other generic signature.
 283              */
 284             @SuppressWarnings("unchecked")
 285             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
 286                     codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
 287             return Optional.ofNullable(binding);
 288         } catch (final IllegalArgumentException e) {
 289             return Optional.empty();
 290         }
 291     }
 292
 293     @Override
 294     public void onGlobalContextUpdated(final SchemaContext context) {
 295         final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
 296         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
 297         futureSchema.onRuntimeContextUpdated(runtimeContext);
 298     }
 299
 300     /**
 301      * Deprecated.
 302      *
 303      * @deprecated Use {@link BindingNormalizedNodeCodecRegistry#deserializeFunction} instead.
 304      */
 305     @Deprecated
 306     public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
 307             final InstanceIdentifier<T> path) {
 308         return codecRegistry.deserializeFunction(path)::apply;
 309     }
 310
 311     public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
 312         return codecRegistry;
 313     }
 314
 315     @Override
 316     public void close() {
 317         if (listenerRegistration != null) {
 318             listenerRegistration.close();
 319         }
 320     }
 321
 322     public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
 323         return codecRegistry;
 324     }
 325
 326     // FIXME: This should be probably part of Binding Runtime context
 327     public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
 328         final Module module = getModuleBlocking(key);
 329         final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
 330         try {
 331             for (final RpcDefinition rpcDef : module.getRpcs()) {
 332                 final Method method = findRpcMethod(key, rpcDef);
 333                 ret.put(method, rpcDef.getPath());
 334             }
 335         } catch (final NoSuchMethodException e) {
 336             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 337         }
 338         return ret.build();
 339     }
 340
 341     protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
 342         final Module module = getModuleBlocking(key);
 343         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
 344         try {
 345             for (final RpcDefinition rpcDef : module.getRpcs()) {
 346                 final Method method = findRpcMethod(key, rpcDef);
 347                 ret.put(method, rpcDef);
 348             }
 349         } catch (final NoSuchMethodException e) {
 350             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 351         }
 352         return ret.build();
 353     }
 354
 355     private Module getModuleBlocking(final Class<?> modeledClass) {
 356         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 357         BindingRuntimeContext localRuntimeContext = runtimeContext();
 358         Module module = localRuntimeContext == null ? null :
 359             localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
 360         if (module == null && futureSchema.waitForSchema(moduleName)) {
 361             localRuntimeContext = runtimeContext();
 362             checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
 363             module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
 364         }
 365         if (module != null) {
 366             return module;
 367         }
 368
 369         LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 370                 modeledClass, moduleName, localRuntimeContext);
 371         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
 372                 + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
 373     }
 374
 375     private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
 376         LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
 377             futureSchema.getUnit());
 378         if (!futureSchema.waitForSchema(binding)) {
 379             throw exception;
 380         }
 381     }
 382
 383     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 384             throws NoSuchMethodException {
 385         final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
 386         final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
 387         return key.getMethod(methodName, inputClz);
 388     }
 389
 390     @Override
 391     public final BindingCodecTree create(final BindingRuntimeContext context) {
 392         return codecRegistry.create(context);
 393     }
 394
 395     @Override
 396     public final BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
 397         return codecRegistry.create(context, bindingClasses);
 398     }
 399
 400     protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
 401             final YangInstanceIdentifier domIdentifier) {
 402
 403         final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
 404         final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
 405         checkArgument(bindingPath != null);
 406         /**
 407          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
 408          * return non-null value.
 409          */
 410         final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
 411         return new SimpleEntry<>(bindingPath, codecContext);
 412     }
 413
 414     @SuppressWarnings("unchecked")
 415     public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
 416         final Set<Class<? extends Notification>> result = new HashSet<>();
 417         final BindingRuntimeContext runtimeContext = runtimeContext();
 418         for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
 419             if (interested.contains(notification.getPath())) {
 420                 try {
 421                     result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
 422                 } catch (final IllegalStateException e) {
 423                     // Ignore
 424                     LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
 425                 }
 426             }
 427         }
 428         return result;
 429     }
 430
 431     SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
 432         final ActionDefinition schema = runtimeContext().getActionDefinition(type);
 433         checkArgument(schema != null, "Failed to find schema for %s", type);
 434         return schema.getPath();
 435     }
 436
 437     private BindingRuntimeContext runtimeContext() {
 438         return futureSchema.runtimeContext();
 439     }
 440
 441     private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
 442         return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
 443     }
 444
 445     protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
 446         return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
 447     }
 448
 449     /**
 450      * This method creates an empty list container of a particular type.
 451      *
 452      * @deprecated This method is not generally useful, as empty lists do not convey information in YANG (they are
 453      *             equivalent to non-present lists). It also leaks implementation details to a broader scope and should
 454      *             never have been public in the first place.
 455      */
 456     @Deprecated
 457     public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
 458         final BindingCodecTreeNode mapCodec = requireNonNull(
 459                 codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
 460                 "Codec not found for yang instance identifier: " + parentMapPath);
 461         final WithStatus schema = mapCodec.getSchema();
 462         if (schema instanceof ListSchemaNode) {
 463             final ListSchemaNode castedSchema = (ListSchemaNode) schema;
 464             return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
 465                     : Builders.mapBuilder(castedSchema).build();
 466         }
 467         throw new IllegalArgumentException("Path does not point to list schema node");
 468     }
 469
 470     protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
 471             final Collection<DataTreeIdentifier<?>> subtrees) {
 472         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
 473     }
 474
 475     protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
 476         final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
 477         return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);
 478     }
 479 }