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