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