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