Promote BindingRuntimeContext to binding-generator-api
[mdsal.git] / 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.cache.CacheBuilder;
15 import com.google.common.cache.CacheLoader;
16 import com.google.common.cache.LoadingCache;
17 import com.google.common.collect.ImmutableBiMap;
18 import com.google.common.collect.ImmutableSet;
19 import com.google.common.collect.Iterators;
20 import java.lang.reflect.Method;
21 import java.time.Instant;
22 import java.util.AbstractMap.SimpleEntry;
23 import java.util.Collection;
24 import java.util.HashSet;
25 import java.util.Map.Entry;
26 import java.util.Optional;
27 import java.util.Set;
28 import java.util.concurrent.TimeUnit;
29 import java.util.function.Function;
30 import java.util.stream.Collectors;
31 import javax.annotation.PreDestroy;
32 import javax.inject.Inject;
33 import javax.inject.Singleton;
34 import org.eclipse.jdt.annotation.NonNull;
35 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
36 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
37 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
38 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
39 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
40 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
41 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
42 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
43 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
44 import org.opendaylight.mdsal.binding.generator.api.BindingRuntimeContext;
45 import org.opendaylight.mdsal.binding.generator.api.BindingRuntimeGenerator;
46 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
47 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
48 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
49 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
50 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
51 import org.opendaylight.yangtools.concepts.ListenerRegistration;
52 import org.opendaylight.yangtools.yang.binding.Action;
53 import org.opendaylight.yangtools.yang.binding.DataContainer;
54 import org.opendaylight.yangtools.yang.binding.DataObject;
55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
57 import org.opendaylight.yangtools.yang.binding.Notification;
58 import org.opendaylight.yangtools.yang.binding.RpcInput;
59 import org.opendaylight.yangtools.yang.binding.RpcOutput;
60 import org.opendaylight.yangtools.yang.binding.RpcService;
61 import org.opendaylight.yangtools.yang.common.QNameModule;
62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
66 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
67 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
68 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
69 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
70 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
71 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
72 import org.opendaylight.yangtools.yang.model.api.Module;
73 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
74 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
75 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
76 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
77 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
78 import org.slf4j.Logger;
79 import org.slf4j.LoggerFactory;
80
81 /**
82  * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
83  * caching of instance identifiers.
84  *
85  * <p>
86  * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
87  */
88 @Singleton
89 public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
90         BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
91
92     private static final long WAIT_DURATION_SEC = 5;
93     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
94
95     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
96             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
97                 @Override
98                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
99                     return toYangInstanceIdentifierBlocking(key);
100                 }
101             });
102     private final BindingNormalizedNodeCodecRegistry codecRegistry;
103     private final ClassLoadingStrategy classLoadingStrategy;
104     private final BindingRuntimeGenerator generator;
105     private final FutureSchema futureSchema;
106
107     private ListenerRegistration<?> listenerRegistration;
108
109     @Inject
110     public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
111             final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) {
112         this(generator, classLoadingStrategy, codecRegistry, false);
113     }
114
115     public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
116             final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry,
117             final boolean waitForSchema) {
118         this.generator = requireNonNull(generator, "generator");
119         this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
120         this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
121         this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
122     }
123
124     public static BindingToNormalizedNodeCodec newInstance(final BindingRuntimeGenerator generator,
125             final ClassLoadingStrategy classLoadingStrategy, final DOMSchemaService schemaService) {
126         final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
127         BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(generator, classLoadingStrategy,
128             codecRegistry, true);
129         instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
130         return instance;
131     }
132
133     protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
134             final InstanceIdentifier<? extends DataObject> binding) {
135         try {
136             return codecRegistry.toYangInstanceIdentifier(binding);
137         } catch (final MissingSchemaException e) {
138             waitForSchema(decompose(binding), e);
139             return codecRegistry.toYangInstanceIdentifier(binding);
140         }
141     }
142
143     /**
144      * Translates supplied Binding Instance Identifier into NormalizedNode
145      * instance identifier.
146      *
147      * @param binding
148      *            Binding Instance Identifier
149      * @return DOM Instance Identifier
150      * @throws IllegalArgumentException
151      *             If supplied Instance Identifier is not valid.
152      */
153     public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
154         return codecRegistry.toYangInstanceIdentifier(binding);
155     }
156
157     @Override
158     public final YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
159         return codecRegistry.toYangInstanceIdentifier(binding);
160     }
161
162     protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
163         return iiCache.getUnchecked(binding);
164     }
165
166     @Override
167     public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
168             final InstanceIdentifier<T> path, final T data) {
169         try {
170             return codecRegistry.toNormalizedNode(path, data);
171         } catch (final MissingSchemaException e) {
172             waitForSchema(decompose(path), e);
173             return codecRegistry.toNormalizedNode(path, data);
174         }
175     }
176
177     /**
178      * Converts Binding Map.Entry to DOM Map.Entry.
179      *
180      * <p>
181      * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
182      *
183      * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
184      * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
185      *         as value.
186      */
187     @SuppressWarnings({"unchecked", "rawtypes"})
188     public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
189             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
190         return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
191     }
192
193     @Override
194     public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
195             final NormalizedNode<?, ?> data) {
196         return codecRegistry.fromNormalizedNode(path, data);
197     }
198
199     @Override
200     public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
201         return codecRegistry.fromNormalizedNodeNotification(path, data);
202     }
203
204     @Override
205     public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
206             final Instant eventInstant) {
207         return codecRegistry.fromNormalizedNodeNotification(path, data, eventInstant);
208     }
209
210     @Override
211     public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
212         return codecRegistry.fromNormalizedNodeRpcData(path, data);
213     }
214
215     @Override
216     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
217             final ContainerNode input) {
218         return codecRegistry.fromNormalizedNodeActionInput(action, input);
219     }
220
221     @Override
222     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
223             final ContainerNode output) {
224         return codecRegistry.fromNormalizedNodeActionOutput(action, output);
225     }
226
227     @Override
228     public final InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
229         return codecRegistry.fromYangInstanceIdentifier(dom);
230     }
231
232     @Override
233     public final ContainerNode toNormalizedNodeNotification(final Notification data) {
234         return codecRegistry.toNormalizedNodeNotification(data);
235     }
236
237     @Override
238     public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
239         return codecRegistry.toNormalizedNodeRpcData(data);
240     }
241
242     @Override
243     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
244             final RpcInput input) {
245         return codecRegistry.toNormalizedNodeActionInput(action, input);
246     }
247
248     @Override
249     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
250             final RpcOutput output) {
251         return codecRegistry.toNormalizedNodeActionOutput(action, output);
252     }
253
254     @Override
255     public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
256             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
257         return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
258     }
259
260     @Override
261     public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
262             final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
263         return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
264     }
265
266     /**
267      * Returns a Binding-Aware instance identifier from normalized
268      * instance-identifier if it is possible to create representation.
269      *
270      * <p>
271      * Returns Optional.empty for cases where target is mixin node except
272      * augmentation.
273      */
274     public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
275                     throws DeserializationException {
276         try {
277             return Optional.ofNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
278         } catch (final IllegalArgumentException e) {
279             return Optional.empty();
280         }
281     }
282
283     public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
284             final @NonNull Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
285                     throws DeserializationException {
286         try {
287             /*
288              * This cast is required, due to generics behaviour in openjdk / oracle javac.
289              *
290              * <p>
291              * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
292              * this means '?' is always Â <? extends DataObject>. Eclipse compiler
293              * is able to determine this relationship and treats
294              * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
295              * as assignable. However openjdk / oracle javac treats this two types
296              * as incompatible and issues a compile error.
297              *
298              * <p>
299              * It is safe to lose generic information and cast it to other generic signature.
300              */
301             @SuppressWarnings("unchecked")
302             final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
303                     codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
304             return Optional.ofNullable(binding);
305         } catch (final IllegalArgumentException e) {
306             return Optional.empty();
307         }
308     }
309
310     @Override
311     public void onGlobalContextUpdated(final SchemaContext context) {
312         final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(
313             generator.generateTypeMapping(context), classLoadingStrategy);
314         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
315         futureSchema.onRuntimeContextUpdated(runtimeContext);
316     }
317
318     /**
319      * Deprecated.
320      *
321      * @deprecated Use {@link BindingNormalizedNodeCodecRegistry#deserializeFunction} instead.
322      */
323     @Deprecated
324     public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
325             final InstanceIdentifier<T> path) {
326         return codecRegistry.deserializeFunction(path)::apply;
327     }
328
329     public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
330         return codecRegistry;
331     }
332
333     @Override
334     @PreDestroy
335     public void close() {
336         if (listenerRegistration != null) {
337             listenerRegistration.close();
338         }
339     }
340
341     public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
342         return codecRegistry;
343     }
344
345     // FIXME: This should be probably part of Binding Runtime context
346     public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
347         final Module module = getModuleBlocking(key);
348         final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
349         try {
350             for (final RpcDefinition rpcDef : module.getRpcs()) {
351                 final Method method = findRpcMethod(key, rpcDef);
352                 ret.put(method, rpcDef.getPath());
353             }
354         } catch (final NoSuchMethodException e) {
355             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
356         }
357         return ret.build();
358     }
359
360     protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
361         final Module module = getModuleBlocking(key);
362         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
363         try {
364             for (final RpcDefinition rpcDef : module.getRpcs()) {
365                 final Method method = findRpcMethod(key, rpcDef);
366                 ret.put(method, rpcDef);
367             }
368         } catch (final NoSuchMethodException e) {
369             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
370         }
371         return ret.build();
372     }
373
374     private Module getModuleBlocking(final Class<?> modeledClass) {
375         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
376         BindingRuntimeContext localRuntimeContext = runtimeContext();
377         Module module = localRuntimeContext == null ? null :
378             localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
379         if (module == null && futureSchema.waitForSchema(moduleName)) {
380             localRuntimeContext = runtimeContext();
381             checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
382             module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
383         }
384         if (module != null) {
385             return module;
386         }
387
388         LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
389                 modeledClass, moduleName, localRuntimeContext);
390         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
391                 + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
392     }
393
394     private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
395         LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
396             futureSchema.getUnit());
397         if (!futureSchema.waitForSchema(binding)) {
398             throw exception;
399         }
400     }
401
402     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
403             throws NoSuchMethodException {
404         final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
405         final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
406         return key.getMethod(methodName, inputClz);
407     }
408
409     @Override
410     public final BindingCodecTree create(final BindingRuntimeContext context) {
411         return codecRegistry.create(context);
412     }
413
414     protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
415             final YangInstanceIdentifier domIdentifier) {
416
417         final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
418         final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
419         checkArgument(bindingPath != null);
420         /**
421          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
422          * return non-null value.
423          */
424         final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
425         return new SimpleEntry<>(bindingPath, codecContext);
426     }
427
428     @SuppressWarnings("unchecked")
429     public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
430         final Set<Class<? extends Notification>> result = new HashSet<>();
431         final BindingRuntimeContext runtimeContext = runtimeContext();
432         for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
433             if (interested.contains(notification.getPath())) {
434                 try {
435                     result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
436                 } catch (final IllegalStateException e) {
437                     // Ignore
438                     LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
439                 }
440             }
441         }
442         return result;
443     }
444
445     SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
446         final ActionDefinition schema = runtimeContext().getActionDefinition(type);
447         checkArgument(schema != null, "Failed to find schema for %s", type);
448         return schema.getPath();
449     }
450
451     private BindingRuntimeContext runtimeContext() {
452         return futureSchema.runtimeContext();
453     }
454
455     private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
456         return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
457     }
458
459     protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
460         return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
461     }
462
463     /**
464      * This method creates an empty list container of a particular type.
465      *
466      * @deprecated This method is not generally useful, as empty lists do not convey information in YANG (they are
467      *             equivalent to non-present lists). It also leaks implementation details to a broader scope and should
468      *             never have been public in the first place.
469      */
470     @Deprecated
471     public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
472         final BindingCodecTreeNode mapCodec = requireNonNull(
473                 codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
474                 "Codec not found for yang instance identifier: " + parentMapPath);
475         final WithStatus schema = mapCodec.getSchema();
476         if (schema instanceof ListSchemaNode) {
477             final ListSchemaNode castedSchema = (ListSchemaNode) schema;
478             return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
479                     : Builders.mapBuilder(castedSchema).build();
480         }
481         throw new IllegalArgumentException("Path does not point to list schema node");
482     }
483
484     protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
485             final Collection<DataTreeIdentifier<?>> subtrees) {
486         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
487     }
488
489     protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
490         final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
491         return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);
492     }
493 }