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