opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/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.controller.md.sal.binding.impl;
   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.util.AbstractMap.SimpleEntry;
  19 import java.util.Collection;
  20 import java.util.HashSet;
  21 import java.util.Iterator;
  22 import java.util.Map;
  23 import java.util.Map.Entry;
  24 import java.util.Set;
  25 import java.util.concurrent.TimeUnit;
  26 import javax.annotation.Nonnull;
  27 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
  28 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
  29 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
  30 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  32 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  33 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  34 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  35 import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException;
  36 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
  37 import org.opendaylight.mdsal.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.YangInstanceIdentifier.PathArgument;
  48 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  50 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  51 import org.opendaylight.yangtools.yang.model.api.Module;
  52 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  53 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  55 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  56 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public class BindingToNormalizedNodeCodec
  61         implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
  62
  63     private static final long WAIT_DURATION_SEC = 5;
  64     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
  65
  66     private final BindingNormalizedNodeCodecRegistry codecRegistry;
  67
  68     private final ClassLoadingStrategy classLoadingStrategy;
  69     private final FutureSchema futureSchema;
  70     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
  71             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  72
  73                 @Override
  74                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) throws Exception {
  75                     return toYangInstanceIdentifierBlocking(key);
  76                 }
  77
  78             });
  79
  80     private DataNormalizer legacyToNormalized;
  81
  82     public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
  83             final BindingNormalizedNodeCodecRegistry codecRegistry) {
  84         this(classLoadingStrategy, codecRegistry, false);
  85
  86     }
  87
  88     public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
  89             final BindingNormalizedNodeCodecRegistry codecRegistry, final boolean waitForSchema) {
  90         this.classLoadingStrategy = Preconditions.checkNotNull(classLoadingStrategy, "classLoadingStrategy");
  91         this.codecRegistry = Preconditions.checkNotNull(codecRegistry, "codecRegistry");
  92         this.futureSchema = new FutureSchema(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
  93     }
  94
  95     public YangInstanceIdentifier
  96             toYangInstanceIdentifierBlocking(final InstanceIdentifier<? extends DataObject> binding) {
  97         try {
  98             return this.codecRegistry.toYangInstanceIdentifier(binding);
  99         } catch (final MissingSchemaException e) {
 100             waitForSchema(decompose(binding), e);
 101             return this.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 this.codecRegistry.toYangInstanceIdentifier(binding);
 117     }
 118
 119     @Override
 120     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 121         return this.codecRegistry.toYangInstanceIdentifier(binding);
 122     }
 123
 124     public YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
 125         return this.iiCache.getUnchecked(binding);
 126     }
 127
 128     @Override
 129     public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 130             final InstanceIdentifier<T> path, final T data) {
 131         return this.codecRegistry.toNormalizedNode(path, data);
 132     }
 133
 134     /**
 135      * Converts Binding Map.Entry to DOM Map.Entry
 136      *
 137      * <p>
 138      * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
 139      *
 140      * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
 141      * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
 142      *         as value.
 143      */
 144     @SuppressWarnings({ "unchecked", "rawtypes" })
 145     public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 146             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
 147         return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
 148     }
 149
 150     @Override
 151     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 152             final NormalizedNode<?, ?> data) {
 153         return this.codecRegistry.fromNormalizedNode(path, data);
 154     }
 155
 156     @Override
 157     public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
 158         return this.codecRegistry.fromNormalizedNodeNotification(path, data);
 159     }
 160
 161     @Override
 162     public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
 163         return this.codecRegistry.fromNormalizedNodeRpcData(path, data);
 164     }
 165
 166     @Override
 167     public InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 168         return this.codecRegistry.fromYangInstanceIdentifier(dom);
 169     }
 170
 171     @Override
 172     public ContainerNode toNormalizedNodeNotification(final Notification data) {
 173         return this.codecRegistry.toNormalizedNodeNotification(data);
 174     }
 175
 176     @Override
 177     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 178         return this.codecRegistry.toNormalizedNodeRpcData(data);
 179     }
 180
 181     public DataNormalizer getDataNormalizer() {
 182         return this.legacyToNormalized;
 183     }
 184
 185     /**
 186      * Returns a Binding-Aware instance identifier from normalized
 187      * instance-identifier if it is possible to create representation.
 188      *
 189      * <p>
 190      * Returns Optional.absent for cases where target is mixin node except
 191      * augmentation.
 192      *
 193      */
 194     public Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
 195             throws DeserializationException {
 196         try {
 197             return Optional.<InstanceIdentifier<? extends DataObject>>fromNullable(
 198                     this.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 =
 223                     Entry.class.cast(this.codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
 224             return Optional.fromNullable(binding);
 225         } catch (final IllegalArgumentException e) {
 226             return Optional.absent();
 227         }
 228     }
 229
 230     @Override
 231     public void onGlobalContextUpdated(final SchemaContext schemaContext) {
 232         this.legacyToNormalized = new DataNormalizer(schemaContext);
 233         final BindingRuntimeContext runtimeContext =
 234                 BindingRuntimeContext.create(this.classLoadingStrategy, schemaContext);
 235         this.codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
 236         this.futureSchema.onRuntimeContextUpdated(runtimeContext);
 237     }
 238
 239     public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>>
 240             deserializeFunction(final InstanceIdentifier<T> path) {
 241         return this.codecRegistry.deserializeFunction(path);
 242     }
 243
 244     /**
 245      * Returns an default object according to YANG schema for supplied path.
 246      *
 247      * @param path DOM Path
 248      * @return Node with defaults set on.
 249      */
 250     public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier path) {
 251         final Iterator<PathArgument> iterator = path.getPathArguments().iterator();
 252         DataNormalizationOperation<?> currentOp = this.legacyToNormalized.getRootOperation();
 253         while (iterator.hasNext()) {
 254             final PathArgument currentArg = iterator.next();
 255             try {
 256                 currentOp = currentOp.getChild(currentArg);
 257             } catch (final DataNormalizationException e) {
 258                 throw new IllegalArgumentException(String.format("Invalid child encountered in path %s", path), e);
 259             }
 260         }
 261         return currentOp.createDefault(path.getLastPathArgument());
 262     }
 263
 264     public BindingNormalizedNodeCodecRegistry getCodecRegistry() {
 265         return this.codecRegistry;
 266     }
 267
 268     @Override
 269     public void close() {
 270         // NOOP Intentionally
 271     }
 272
 273     public BindingNormalizedNodeCodecRegistry getCodecFactory() {
 274         return this.codecRegistry;
 275     }
 276
 277     // FIXME: This should be probably part of Binding Runtime context
 278     public ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
 279         final Module module = getModuleBlocking(key);
 280         final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.<Method, SchemaPath>builder();
 281         try {
 282             for (final RpcDefinition rpcDef : module.getRpcs()) {
 283                 final Method method = findRpcMethod(key, rpcDef);
 284                 ret.put(method, rpcDef.getPath());
 285             }
 286         } catch (final NoSuchMethodException e) {
 287             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 288         }
 289         return ret.build();
 290     }
 291
 292     public ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
 293         final Module module = getModuleBlocking(key);
 294         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
 295         try {
 296             for (final RpcDefinition rpcDef : module.getRpcs()) {
 297                 final Method method = findRpcMethod(key, rpcDef);
 298                 ret.put(method, rpcDef);
 299             }
 300         } catch (final NoSuchMethodException e) {
 301             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 302         }
 303         return ret.build();
 304     }
 305
 306     private Module getModuleBlocking(final Class<?> modeledClass) {
 307         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 308         Module module = runtimeContext().getSchemaContext().findModule(moduleName).orElse(null);
 309         if (module == null && this.futureSchema.waitForSchema(moduleName)) {
 310             module = runtimeContext().getSchemaContext().findModule(moduleName).orElse(null);
 311         }
 312         Preconditions.checkState(module != null, "Schema for %s is not available.", modeledClass);
 313         return module;
 314     }
 315
 316     private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException ex) {
 317         LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", this.futureSchema.getDuration(),
 318                 this.futureSchema.getUnit());
 319         if (this.futureSchema.waitForSchema(binding)) {
 320             return;
 321         }
 322
 323         throw ex;
 324     }
 325
 326     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 327             throws NoSuchMethodException {
 328         final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
 329         if (rpcDef.getInput() != null) {
 330             final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
 331             return key.getMethod(methodName, inputClz);
 332         }
 333         return key.getMethod(methodName);
 334     }
 335
 336     private BindingRuntimeContext runtimeContext() {
 337         return this.futureSchema.runtimeContext();
 338     }
 339
 340     @Override
 341     public BindingCodecTree create(final BindingRuntimeContext context) {
 342         return this.codecRegistry.create(context);
 343     }
 344
 345     @Override
 346     public BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
 347         return this.codecRegistry.create(context, bindingClasses);
 348     }
 349
 350     @Nonnull
 351     public Map.Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>>
 352             getSubtreeCodec(final YangInstanceIdentifier domIdentifier) {
 353
 354         final BindingCodecTree currentCodecTree = this.codecRegistry.getCodecContext();
 355         final InstanceIdentifier<?> bindingPath = this.codecRegistry.fromYangInstanceIdentifier(domIdentifier);
 356         Preconditions.checkArgument(bindingPath != null);
 357         /**
 358          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
 359          * return non-null value.
 360          */
 361         final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
 362         return new SimpleEntry<>(bindingPath, codecContext);
 363     }
 364
 365     @SuppressWarnings("unchecked")
 366     public Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
 367         final Set<Class<? extends Notification>> result = new HashSet<>();
 368         final Set<NotificationDefinition> knownNotifications = runtimeContext().getSchemaContext().getNotifications();
 369         for (final NotificationDefinition notification : knownNotifications) {
 370             if (interested.contains(notification.getPath())) {
 371                 try {
 372                     result.add((Class<? extends Notification>) runtimeContext().getClassForSchema(notification));
 373                 } catch (final IllegalStateException e) {
 374                     // Ignore
 375                     LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
 376                 }
 377             }
 378         }
 379         return result;
 380     }
 381
 382     private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
 383         final Set<Class<?>> clazzes = new HashSet<>();
 384         for (final InstanceIdentifier.PathArgument arg : path.getPathArguments()) {
 385             clazzes.add(arg.getType());
 386         }
 387         return clazzes;
 388     }
 389 }