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