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 java.lang.reflect.Method;
  18 import java.net.URI;
  19 import java.util.AbstractMap.SimpleEntry;
  20 import java.util.Collection;
  21 import java.util.Date;
  22 import java.util.HashSet;
  23 import java.util.Map;
  24 import java.util.Map.Entry;
  25 import java.util.Set;
  26 import java.util.concurrent.TimeUnit;
  27 import javax.annotation.Nonnull;
  28 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  32 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  33 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  34 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
  35 import org.opendaylight.yangtools.binding.data.codec.impl.MissingSchemaException;
  36 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
  37 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
  38 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  39 import org.opendaylight.yangtools.yang.binding.DataContainer;
  40 import org.opendaylight.yangtools.yang.binding.DataObject;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.binding.Notification;
  43 import org.opendaylight.yangtools.yang.binding.RpcService;
  44 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  45 import org.opendaylight.yangtools.yang.common.QNameModule;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  51 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  52 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  53 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  54 import org.opendaylight.yangtools.yang.model.api.Module;
  55 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  56 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  57 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  58 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  59 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  60 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  61 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 public final class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
  66
  67     private static final long WAIT_DURATION_SEC = 5;
  68     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
  69
  70     private final BindingNormalizedNodeCodecRegistry codecRegistry;
  71
  72     private final GeneratedClassLoadingStrategy classLoadingStrategy;
  73     private final FutureSchema futureSchema;
  74     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
  75             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  76
  77                 @Override
  78                 public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) throws Exception {
  79                     return toYangInstanceIdentifierBlocking(key);
  80                 }
  81
  82             });
  83
  84     private volatile BindingRuntimeContext runtimeContext;
  85
  86     public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy,
  87             final BindingNormalizedNodeCodecRegistry codecRegistry) {
  88         this(classLoadingStrategy,codecRegistry,false);
  89
  90     }
  91
  92     public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy,
  93             final BindingNormalizedNodeCodecRegistry codecRegistry,final boolean waitForSchema) {
  94         this.classLoadingStrategy = Preconditions.checkNotNull(classLoadingStrategy,"classLoadingStrategy");
  95         this.codecRegistry = Preconditions.checkNotNull(codecRegistry,"codecRegistry");
  96         this.futureSchema = waitForSchema ? new FutureSchema(WAIT_DURATION_SEC, TimeUnit.SECONDS) : null;
  97     }
  98
  99     YangInstanceIdentifier toYangInstanceIdentifierBlocking(final InstanceIdentifier<? extends DataObject> binding) {
 100         try {
 101             return codecRegistry.toYangInstanceIdentifier(binding);
 102         } catch (final MissingSchemaException e) {
 103             waitForSchema(decompose(binding), e);
 104             return codecRegistry.toYangInstanceIdentifier(binding);
 105         }
 106     }
 107
 108     /**
 109      * Translates supplied Binding Instance Identifier into NormalizedNode
 110      * instance identifier.
 111      *
 112      * @param binding
 113      *            Binding Instance Identifier
 114      * @return DOM Instance Identifier
 115      * @throws IllegalArgumentException
 116      *             If supplied Instance Identifier is not valid.
 117      */
 118     public YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
 119         return codecRegistry.toYangInstanceIdentifier(binding);
 120     }
 121
 122     @Override
 123     public YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull final InstanceIdentifier<?> binding) {
 124         return codecRegistry.toYangInstanceIdentifier(binding);
 125     }
 126
 127
 128     YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
 129         return iiCache .getUnchecked(binding);
 130     }
 131
 132     @Override
 133     public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 134             final InstanceIdentifier<T> path, final T data) {
 135         try {
 136             return codecRegistry.toNormalizedNode(path, data);
 137         } catch (final MissingSchemaException e) {
 138             waitForSchema(decompose(path), e);
 139             return codecRegistry.toNormalizedNode(path, data);
 140         }
 141     }
 142
 143     /**
 144      * Converts Binding Map.Entry to DOM Map.Entry
 145      *
 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      *
 192      * Returns a Binding-Aware instance identifier from normalized
 193      * instance-identifier if it is possible to create representation.
 194      *
 195      * Returns Optional.absent for cases where target is mixin node except
 196      * augmentation.
 197      *
 198      */
 199     public Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
 200                     throws DeserializationException {
 201         try {
 202             return Optional.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
 203         } catch (final IllegalArgumentException e) {
 204             return Optional.absent();
 205         }
 206     }
 207
 208     public Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
 209             @Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
 210                     throws DeserializationException {
 211         try {
 212             /*
 213              * This cast is required, due to generics behaviour in openjdk / oracle javac
 214              *
 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              * It is safe to  loose generic information and cast it to other generic signature.
 223              *
 224              */
 225             @SuppressWarnings("unchecked")
 226             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
 227             return Optional.fromNullable(binding);
 228         } catch (final IllegalArgumentException e) {
 229             return Optional.absent();
 230         }
 231     }
 232
 233     @Override
 234     public void onGlobalContextUpdated(final SchemaContext arg0) {
 235         runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, arg0);
 236         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
 237         if(futureSchema != null) {
 238             futureSchema.onRuntimeContextUpdated(runtimeContext);
 239         }
 240     }
 241
 242     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>  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 != 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 e) {
 305         if(futureSchema != null) {
 306             LOG.warn("Blocking thread to wait for schema convergence updates for {} {}",futureSchema.getDuration(), futureSchema.getUnit());
 307             if(!futureSchema.waitForSchema(binding)) {
 308                 return;
 309             }
 310         }
 311         throw e;
 312     }
 313
 314     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef) throws NoSuchMethodException {
 315         final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
 316         if (rpcDef.getInput() != null && isExplicitStatement(rpcDef.getInput())) {
 317             final Class<?> inputClz = runtimeContext.getClassForSchema(rpcDef.getInput());
 318             return key.getMethod(methodName, inputClz);
 319         }
 320         return key.getMethod(methodName);
 321     }
 322
 323     private static boolean isExplicitStatement(final ContainerSchemaNode node) {
 324         return node instanceof EffectiveStatement
 325                 && ((EffectiveStatement) node).getDeclared().getStatementSource() == StatementSource.DECLARATION;
 326     }
 327
 328     @Override
 329     public BindingCodecTree create(final BindingRuntimeContext context) {
 330         return codecRegistry.create(context);
 331     }
 332
 333     @Override
 334     public BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
 335         return codecRegistry.create(context, bindingClasses);
 336     }
 337
 338     @Nonnull
 339     protected Map.Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
 340             final YangInstanceIdentifier domIdentifier) {
 341
 342         final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
 343         final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
 344         Preconditions.checkArgument(bindingPath != null);
 345         /**
 346          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
 347          * return non-null value.
 348          */
 349         final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
 350         return new SimpleEntry<InstanceIdentifier<?>, BindingCodecTreeNode<?>>(bindingPath, codecContext);
 351     }
 352
 353     @SuppressWarnings("unchecked")
 354     public Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
 355         final Set<Class<? extends Notification>> result = new HashSet<>();
 356         final Set<NotificationDefinition> knownNotifications = runtimeContext.getSchemaContext().getNotifications();
 357         for (final NotificationDefinition notification : knownNotifications) {
 358             if (interested.contains(notification.getPath())) {
 359                 try {
 360                     result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
 361                 } catch (final IllegalStateException e) {
 362                     // Ignore
 363                     LOG.warn("Class for {} is currently not known.",notification.getPath(),e);
 364                 }
 365             }
 366         }
 367         return result;
 368     }
 369
 370     private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
 371         final Set<Class<?>> clazzes = new HashSet<>();
 372         for(final InstanceIdentifier.PathArgument arg : path.getPathArguments()) {
 373             clazzes.add(arg.getType());
 374         }
 375         return clazzes;
 376     }
 377
 378     protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
 379         return ImmutableNodes.fromInstanceId(runtimeContext.getSchemaContext(), parentPath);
 380     }
 381
 382     public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
 383         final BindingCodecTreeNode<?> mapCodec = codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath);
 384         final Object schema = mapCodec.getSchema();
 385         if (schema instanceof ListSchemaNode) {
 386             final ListSchemaNode castedSchema = (ListSchemaNode) schema;
 387             if (castedSchema.isUserOrdered()) {
 388                 return Builders.orderedMapBuilder(castedSchema).build();
 389             } else {
 390                 return Builders.mapBuilder(castedSchema).build();
 391             }
 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         final Set<DOMDataTreeIdentifier> ret = new HashSet<>(subtrees.size());
 399
 400         for (final DataTreeIdentifier<?> subtree : subtrees) {
 401             ret.add(toDOMDataTreeIdentifier(subtree));
 402         }
 403         return ret;
 404     }
 405
 406     protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
 407         final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
 408         return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);
 409     }
 410
 411 }