2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.adapter;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.Function;
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
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.util.AbstractMap.SimpleEntry;
23 import java.util.Collection;
24 import java.util.HashSet;
25 import java.util.Map.Entry;
27 import java.util.concurrent.TimeUnit;
28 import java.util.stream.Collectors;
29 import javax.annotation.Nonnull;
30 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
31 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
32 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
33 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
34 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
35 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
36 import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException;
37 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
38 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
39 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
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.InstanceIdentifier.PathArgument;
45 import org.opendaylight.yangtools.yang.binding.Notification;
46 import org.opendaylight.yangtools.yang.binding.RpcService;
47 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
48 import org.opendaylight.yangtools.yang.common.QNameModule;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
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.data.impl.schema.Builders;
54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
55 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
56 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
57 import org.opendaylight.yangtools.yang.model.api.Module;
58 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
59 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
60 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
61 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
62 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
67 * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
68 * caching of instance identifiers.
71 * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
73 public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
74 BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
76 private static final long WAIT_DURATION_SEC = 5;
77 private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
79 private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
80 .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
82 public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) {
83 return toYangInstanceIdentifierBlocking(key);
86 private final BindingNormalizedNodeCodecRegistry codecRegistry;
87 private final ClassLoadingStrategy classLoadingStrategy;
88 private final FutureSchema futureSchema;
90 public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
91 final BindingNormalizedNodeCodecRegistry codecRegistry) {
92 this(classLoadingStrategy, codecRegistry, false);
95 public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
96 final BindingNormalizedNodeCodecRegistry codecRegistry, final boolean waitForSchema) {
97 this.classLoadingStrategy = Preconditions.checkNotNull(classLoadingStrategy, "classLoadingStrategy");
98 this.codecRegistry = Preconditions.checkNotNull(codecRegistry, "codecRegistry");
99 this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
102 protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
103 final InstanceIdentifier<? extends DataObject> binding) {
105 return codecRegistry.toYangInstanceIdentifier(binding);
106 } catch (final MissingSchemaException e) {
107 waitForSchema(decompose(binding), e);
108 return codecRegistry.toYangInstanceIdentifier(binding);
113 * Translates supplied Binding Instance Identifier into NormalizedNode
114 * instance identifier.
117 * Binding Instance Identifier
118 * @return DOM Instance Identifier
119 * @throws IllegalArgumentException
120 * If supplied Instance Identifier is not valid.
122 public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
123 return codecRegistry.toYangInstanceIdentifier(binding);
127 public final YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull final InstanceIdentifier<?> binding) {
128 return codecRegistry.toYangInstanceIdentifier(binding);
131 protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
132 return iiCache.getUnchecked(binding);
136 public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
137 final InstanceIdentifier<T> path, final T data) {
139 return codecRegistry.toNormalizedNode(path, data);
140 } catch (final MissingSchemaException e) {
141 waitForSchema(decompose(path), e);
142 return codecRegistry.toNormalizedNode(path, data);
147 * Converts Binding Map.Entry to DOM Map.Entry.
150 * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
152 * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
153 * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
156 @SuppressWarnings({"unchecked", "rawtypes"})
157 public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
158 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
159 return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
163 public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(@Nonnull final YangInstanceIdentifier path,
164 final NormalizedNode<?, ?> data) {
165 return codecRegistry.fromNormalizedNode(path, data);
169 public final Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
170 @Nonnull final ContainerNode data) {
171 return codecRegistry.fromNormalizedNodeNotification(path, data);
175 public final DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path,
176 @Nonnull final ContainerNode data) {
177 return codecRegistry.fromNormalizedNodeRpcData(path, data);
181 public final InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull final YangInstanceIdentifier dom) {
182 return codecRegistry.fromYangInstanceIdentifier(dom);
186 public final ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
187 return codecRegistry.toNormalizedNodeNotification(data);
191 public final ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
192 return codecRegistry.toNormalizedNodeRpcData(data);
196 * Returns a Binding-Aware instance identifier from normalized
197 * instance-identifier if it is possible to create representation.
200 * Returns Optional.absent for cases where target is mixin node except
203 public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
204 throws DeserializationException {
206 return Optional.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
207 } catch (final IllegalArgumentException e) {
208 return Optional.absent();
212 public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
213 @Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
214 throws DeserializationException {
217 * This cast is required, due to generics behaviour in openjdk / oracle javac.
220 * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
221 * this means '?' is always  <? extends DataObject>. Eclipse compiler
222 * is able to determine this relationship and treats
223 * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
224 * as assignable. However openjdk / oracle javac treats this two types
225 * as incompatible and issues a compile error.
228 * It is safe to lose generic information and cast it to other generic signature.
230 @SuppressWarnings("unchecked")
231 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
232 codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
233 return Optional.fromNullable(binding);
234 } catch (final IllegalArgumentException e) {
235 return Optional.absent();
240 public void onGlobalContextUpdated(final SchemaContext context) {
241 final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
242 codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
243 futureSchema.onRuntimeContextUpdated(runtimeContext);
246 public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
247 final InstanceIdentifier<T> path) {
248 return codecRegistry.deserializeFunction(path);
251 public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
252 return codecRegistry;
256 public void close() {
257 // NOOP Intentionally
260 public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
261 return codecRegistry;
264 // FIXME: This should be probably part of Binding Runtime context
265 public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
266 final Module module = getModuleBlocking(key);
267 final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
269 for (final RpcDefinition rpcDef : module.getRpcs()) {
270 final Method method = findRpcMethod(key, rpcDef);
271 ret.put(method, rpcDef.getPath());
273 } catch (final NoSuchMethodException e) {
274 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
279 protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
280 final Module module = getModuleBlocking(key);
281 final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
283 for (final RpcDefinition rpcDef : module.getRpcs()) {
284 final Method method = findRpcMethod(key, rpcDef);
285 ret.put(method, rpcDef);
287 } catch (final NoSuchMethodException e) {
288 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
293 private Module getModuleBlocking(final Class<?> modeledClass) {
294 final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
295 BindingRuntimeContext localRuntimeContext = runtimeContext();
296 Module module = localRuntimeContext == null ? null :
297 localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
298 if (module == null && futureSchema.waitForSchema(moduleName)) {
299 localRuntimeContext = runtimeContext();
300 Preconditions.checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
301 module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
303 Preconditions.checkState(module != null, "Schema for %s is not available.", modeledClass);
307 private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
308 LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
309 futureSchema.getUnit());
310 if (!futureSchema.waitForSchema(binding)) {
315 private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
316 throws NoSuchMethodException {
317 final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
318 final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
319 return key.getMethod(methodName, inputClz);
323 public final BindingCodecTree create(final BindingRuntimeContext context) {
324 return codecRegistry.create(context);
328 public final BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
329 return codecRegistry.create(context, bindingClasses);
333 protected Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
334 final YangInstanceIdentifier domIdentifier) {
336 final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
337 final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
338 Preconditions.checkArgument(bindingPath != null);
340 * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
341 * return non-null value.
343 final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
344 return new SimpleEntry<>(bindingPath, codecContext);
347 @SuppressWarnings("unchecked")
348 public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
349 final Set<Class<? extends Notification>> result = new HashSet<>();
350 final BindingRuntimeContext runtimeContext = runtimeContext();
351 for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
352 if (interested.contains(notification.getPath())) {
354 result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
355 } catch (final IllegalStateException e) {
357 LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
364 private BindingRuntimeContext runtimeContext() {
365 return futureSchema.runtimeContext();
368 private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
369 return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
372 protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
373 return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
376 public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
377 final BindingCodecTreeNode<?> mapCodec = requireNonNull(
378 codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
379 "Codec not found for yang instance identifier: " + parentMapPath);
380 final WithStatus schema = mapCodec.getSchema();
381 if (schema instanceof ListSchemaNode) {
382 final ListSchemaNode castedSchema = (ListSchemaNode) schema;
383 return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
384 : Builders.mapBuilder(castedSchema).build();
386 throw new IllegalArgumentException("Path does not point to list schema node");
389 protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
390 final Collection<DataTreeIdentifier<?>> subtrees) {
391 return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
394 protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
395 final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
396 return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);