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 static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.cache.CacheBuilder;
  16 import com.google.common.cache.CacheLoader;
  17 import com.google.common.cache.LoadingCache;
  18 import com.google.common.collect.ImmutableBiMap;
  19 import com.google.common.collect.ImmutableSet;
  20 import com.google.common.collect.Iterators;
  21 import java.lang.reflect.Method;
  22 import java.time.Instant;
  23 import java.util.AbstractMap.SimpleEntry;
  24 import java.util.Collection;
  25 import java.util.Map.Entry;
  26 import java.util.Optional;
  27 import java.util.concurrent.TimeUnit;
  28 import java.util.stream.Collectors;
  29 import javax.annotation.PreDestroy;
  30 import javax.inject.Inject;
  31 import javax.inject.Singleton;
  32 import org.eclipse.jdt.annotation.NonNull;
  33 import org.opendaylight.binding.runtime.api.BindingRuntimeContext;
  34 import org.opendaylight.binding.runtime.api.BindingRuntimeGenerator;
  35 import org.opendaylight.binding.runtime.api.ClassLoadingStrategy;
  36 import org.opendaylight.binding.runtime.api.DefaultBindingRuntimeContext;
  37 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  38 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  39 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
  40 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  41 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
  42 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  43 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
  44 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  45 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  46 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  47 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  48 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  49 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  50 import org.opendaylight.yangtools.yang.binding.Action;
  51 import org.opendaylight.yangtools.yang.binding.DataContainer;
  52 import org.opendaylight.yangtools.yang.binding.DataObject;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  55 import org.opendaylight.yangtools.yang.binding.Notification;
  56 import org.opendaylight.yangtools.yang.binding.RpcInput;
  57 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  58 import org.opendaylight.yangtools.yang.binding.RpcService;
  59 import org.opendaylight.yangtools.yang.common.QNameModule;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  62 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  63 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  64 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  65 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  66 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  67 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  68 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
  69 import org.opendaylight.yangtools.yang.model.api.Module;
  70 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  71 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  72 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  73 import org.slf4j.Logger;
  74 import org.slf4j.LoggerFactory;
  75
  76 /**
  77  * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
  78  * caching of instance identifiers.
  79  *
  80  * <p>
  81  * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
  82  */
  83 @Singleton
  84 public class BindingToNormalizedNodeCodec implements BindingNormalizedNodeSerializer, EffectiveModelContextListener,
  85         AutoCloseable {
  86
  87     private static final long WAIT_DURATION_SEC = 5;
  88     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
  89
  90     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
  91             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  92                 @Override
  93                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  94                     return toYangInstanceIdentifierBlocking(key);
  95                 }
  96             });
  97     private final BindingNormalizedNodeCodecRegistry codecRegistry;
  98     private final ClassLoadingStrategy classLoadingStrategy;
  99     private final BindingRuntimeGenerator generator;
 100     private final FutureSchema futureSchema;
 101
 102     private ListenerRegistration<?> listenerRegistration;
 103
 104     @Inject
 105     public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
 106             final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) {
 107         this(generator, classLoadingStrategy, codecRegistry, false);
 108     }
 109
 110     @Beta
 111     public BindingToNormalizedNodeCodec(final BindingRuntimeContext runtimeContext) {
 112         generator = (final SchemaContext context) -> {
 113             throw new UnsupportedOperationException("Static context assigned");
 114         };
 115         classLoadingStrategy = runtimeContext.getStrategy();
 116         codecRegistry = new BindingNormalizedNodeCodecRegistry(runtimeContext);
 117         // TODO: this should have a specialized constructor or not be needed
 118         futureSchema = FutureSchema.create(0, TimeUnit.SECONDS, false);
 119         futureSchema.onRuntimeContextUpdated(runtimeContext);
 120     }
 121
 122     public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
 123             final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry,
 124             final boolean waitForSchema) {
 125         this.generator = requireNonNull(generator, "generator");
 126         this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
 127         this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
 128         this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
 129     }
 130
 131     public static BindingToNormalizedNodeCodec newInstance(final BindingRuntimeGenerator generator,
 132             final ClassLoadingStrategy classLoadingStrategy, final DOMSchemaService schemaService) {
 133         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
 134         BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(generator, classLoadingStrategy,
 135             codecRegistry, true);
 136         instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
 137         return instance;
 138     }
 139
 140     protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
 141             final InstanceIdentifier<? extends DataObject> binding) {
 142         try {
 143             return codecRegistry.toYangInstanceIdentifier(binding);
 144         } catch (final MissingSchemaException e) {
 145             waitForSchema(decompose(binding), e);
 146             return codecRegistry.toYangInstanceIdentifier(binding);
 147         }
 148     }
 149
 150     @Override
 151     public final YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 152         return codecRegistry.toYangInstanceIdentifier(binding);
 153     }
 154
 155     protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
 156         return iiCache.getUnchecked(binding);
 157     }
 158
 159     @Override
 160     public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 161             final InstanceIdentifier<T> path, final T data) {
 162         try {
 163             return codecRegistry.toNormalizedNode(path, data);
 164         } catch (final MissingSchemaException e) {
 165             waitForSchema(decompose(path), e);
 166             return codecRegistry.toNormalizedNode(path, data);
 167         }
 168     }
 169
 170     /**
 171      * Converts Binding Map.Entry to DOM Map.Entry.
 172      *
 173      * <p>
 174      * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
 175      *
 176      * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
 177      * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
 178      *         as value.
 179      */
 180     @SuppressWarnings({"unchecked", "rawtypes"})
 181     public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
 182             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
 183         return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
 184     }
 185
 186     @Override
 187     public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 188             final NormalizedNode<?, ?> data) {
 189         return codecRegistry.fromNormalizedNode(path, data);
 190     }
 191
 192     @Override
 193     public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
 194         return codecRegistry.fromNormalizedNodeNotification(path, data);
 195     }
 196
 197     @Override
 198     public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
 199             final Instant eventInstant) {
 200         return codecRegistry.fromNormalizedNodeNotification(path, data, eventInstant);
 201     }
 202
 203     @Override
 204     public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
 205         return codecRegistry.fromNormalizedNodeRpcData(path, data);
 206     }
 207
 208     @Override
 209     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 210             final ContainerNode input) {
 211         return codecRegistry.fromNormalizedNodeActionInput(action, input);
 212     }
 213
 214     @Override
 215     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 216             final ContainerNode output) {
 217         return codecRegistry.fromNormalizedNodeActionOutput(action, output);
 218     }
 219
 220     @Override
 221     public final InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 222         return codecRegistry.fromYangInstanceIdentifier(dom);
 223     }
 224
 225     @Override
 226     public final ContainerNode toNormalizedNodeNotification(final Notification data) {
 227         return codecRegistry.toNormalizedNodeNotification(data);
 228     }
 229
 230     @Override
 231     public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 232         return codecRegistry.toNormalizedNodeRpcData(data);
 233     }
 234
 235     @Override
 236     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 237             final RpcInput input) {
 238         return codecRegistry.toNormalizedNodeActionInput(action, input);
 239     }
 240
 241     @Override
 242     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 243             final RpcOutput output) {
 244         return codecRegistry.toNormalizedNodeActionOutput(action, output);
 245     }
 246
 247     @Override
 248     public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
 249             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
 250         return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
 251     }
 252
 253     @Override
 254     public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
 255             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
 256         return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
 257     }
 258
 259     /**
 260      * Returns a Binding-Aware instance identifier from normalized
 261      * instance-identifier if it is possible to create representation.
 262      *
 263      * <p>
 264      * Returns Optional.empty for cases where target is mixin node except
 265      * augmentation.
 266      */
 267     public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
 268                     throws DeserializationException {
 269         try {
 270             return Optional.ofNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
 271         } catch (final IllegalArgumentException e) {
 272             return Optional.empty();
 273         }
 274     }
 275
 276     @Override
 277     public void onModelContextUpdated(final EffectiveModelContext newModelContext) {
 278         final BindingRuntimeContext runtimeContext = DefaultBindingRuntimeContext.create(
 279             generator.generateTypeMapping(newModelContext), classLoadingStrategy);
 280         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
 281         futureSchema.onRuntimeContextUpdated(runtimeContext);
 282     }
 283
 284     public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
 285         return codecRegistry;
 286     }
 287
 288     @Override
 289     @PreDestroy
 290     public void close() {
 291         if (listenerRegistration != null) {
 292             listenerRegistration.close();
 293         }
 294     }
 295
 296     public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
 297         return codecRegistry;
 298     }
 299
 300     // FIXME: This should be probably part of Binding Runtime context
 301     public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
 302         final Module module = getModuleBlocking(key);
 303         final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
 304         try {
 305             for (final RpcDefinition rpcDef : module.getRpcs()) {
 306                 final Method method = findRpcMethod(key, rpcDef);
 307                 ret.put(method, rpcDef.getPath());
 308             }
 309         } catch (final NoSuchMethodException e) {
 310             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 311         }
 312         return ret.build();
 313     }
 314
 315     protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
 316         final Module module = getModuleBlocking(key);
 317         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
 318         try {
 319             for (final RpcDefinition rpcDef : module.getRpcs()) {
 320                 final Method method = findRpcMethod(key, rpcDef);
 321                 ret.put(method, rpcDef);
 322             }
 323         } catch (final NoSuchMethodException e) {
 324             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 325         }
 326         return ret.build();
 327     }
 328
 329     private Module getModuleBlocking(final Class<?> modeledClass) {
 330         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 331         BindingRuntimeContext localRuntimeContext = runtimeContext();
 332         Module module = localRuntimeContext == null ? null :
 333             localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
 334         if (module == null && futureSchema.waitForSchema(moduleName)) {
 335             localRuntimeContext = runtimeContext();
 336             checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
 337             module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
 338         }
 339         if (module != null) {
 340             return module;
 341         }
 342
 343         LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 344                 modeledClass, moduleName, localRuntimeContext);
 345         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
 346                 + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
 347     }
 348
 349     private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
 350         LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
 351             futureSchema.getUnit());
 352         if (!futureSchema.waitForSchema(binding)) {
 353             throw exception;
 354         }
 355     }
 356
 357     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 358             throws NoSuchMethodException {
 359         final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
 360         final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
 361         return key.getMethod(methodName, inputClz);
 362     }
 363
 364     protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
 365             final YangInstanceIdentifier domIdentifier) {
 366
 367         final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
 368         final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
 369         checkArgument(bindingPath != null);
 370         /**
 371          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
 372          * return non-null value.
 373          */
 374         final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
 375         return new SimpleEntry<>(bindingPath, codecContext);
 376     }
 377
 378     SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
 379         final ActionDefinition schema = runtimeContext().getActionDefinition(type);
 380         checkArgument(schema != null, "Failed to find schema for %s", type);
 381         return schema.getPath();
 382     }
 383
 384     private BindingRuntimeContext runtimeContext() {
 385         return futureSchema.runtimeContext();
 386     }
 387
 388     private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
 389         return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
 390     }
 391
 392     protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
 393         return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
 394     }
 395
 396     protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
 397             final Collection<DataTreeIdentifier<?>> subtrees) {
 398         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
 399     }
 400
 401     protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
 402         final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
 403         return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);
 404     }
 405 }