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