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