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