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