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