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