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 com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static java.util.Objects.requireNonNull;
14 import com.google.common.base.Function;
15 import com.google.common.base.Optional;
16 import com.google.common.cache.CacheBuilder;
17 import com.google.common.cache.CacheLoader;
18 import com.google.common.cache.LoadingCache;
19 import com.google.common.collect.ImmutableBiMap;
20 import com.google.common.collect.ImmutableSet;
21 import com.google.common.collect.Iterators;
22 import java.lang.reflect.Method;
23 import java.util.AbstractMap.SimpleEntry;
24 import java.util.Collection;
25 import java.util.HashSet;
26 import java.util.Map.Entry;
28 import java.util.concurrent.TimeUnit;
29 import java.util.stream.Collectors;
30 import javassist.ClassPool;
31 import javax.annotation.Nonnull;
32 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
33 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
34 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
35 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
36 import org.opendaylight.mdsal.binding.dom.codec.api.BindingLazyContainerNode;
37 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
38 import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
39 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
40 import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException;
41 import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
42 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
43 import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
44 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
45 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
47 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
48 import org.opendaylight.yangtools.concepts.ListenerRegistration;
49 import org.opendaylight.yangtools.yang.binding.Action;
50 import org.opendaylight.yangtools.yang.binding.DataContainer;
51 import org.opendaylight.yangtools.yang.binding.DataObject;
52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
54 import org.opendaylight.yangtools.yang.binding.Notification;
55 import org.opendaylight.yangtools.yang.binding.RpcInput;
56 import org.opendaylight.yangtools.yang.binding.RpcOutput;
57 import org.opendaylight.yangtools.yang.binding.RpcService;
58 import org.opendaylight.yangtools.yang.common.QNameModule;
59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
61 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
62 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
63 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
64 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
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.DocumentedNode.WithStatus;
68 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
69 import org.opendaylight.yangtools.yang.model.api.Module;
70 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
71 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
72 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
73 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
74 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
75 import org.slf4j.Logger;
76 import org.slf4j.LoggerFactory;
79 * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
80 * caching of instance identifiers.
83 * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
85 public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
86 BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
88 private static final long WAIT_DURATION_SEC = 5;
89 private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
91 private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
92 .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
94 public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) {
95 return toYangInstanceIdentifierBlocking(key);
98 private final BindingNormalizedNodeCodecRegistry codecRegistry;
99 private final ClassLoadingStrategy classLoadingStrategy;
100 private final FutureSchema futureSchema;
101 private ListenerRegistration<?> listenerRegistration;
103 public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
104 final BindingNormalizedNodeCodecRegistry codecRegistry) {
105 this(classLoadingStrategy, codecRegistry, false);
108 public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
109 final BindingNormalizedNodeCodecRegistry codecRegistry, final boolean waitForSchema) {
110 this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
111 this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
112 this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
115 public static BindingToNormalizedNodeCodec newInstance(final ClassLoadingStrategy classLoadingStrategy,
116 final DOMSchemaService schemaService) {
117 final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(
118 StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault())));
119 BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(
120 classLoadingStrategy, codecRegistry, true);
121 instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
125 protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
126 final InstanceIdentifier<? extends DataObject> binding) {
128 return codecRegistry.toYangInstanceIdentifier(binding);
129 } catch (final MissingSchemaException e) {
130 waitForSchema(decompose(binding), e);
131 return codecRegistry.toYangInstanceIdentifier(binding);
136 * Translates supplied Binding Instance Identifier into NormalizedNode
137 * instance identifier.
140 * Binding Instance Identifier
141 * @return DOM Instance Identifier
142 * @throws IllegalArgumentException
143 * If supplied Instance Identifier is not valid.
145 public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
146 return codecRegistry.toYangInstanceIdentifier(binding);
150 public final YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull final InstanceIdentifier<?> binding) {
151 return codecRegistry.toYangInstanceIdentifier(binding);
154 protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
155 return iiCache.getUnchecked(binding);
159 public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
160 final InstanceIdentifier<T> path, final T data) {
162 return codecRegistry.toNormalizedNode(path, data);
163 } catch (final MissingSchemaException e) {
164 waitForSchema(decompose(path), e);
165 return codecRegistry.toNormalizedNode(path, data);
170 * Converts Binding Map.Entry to DOM Map.Entry.
173 * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
175 * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
176 * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
179 @SuppressWarnings({"unchecked", "rawtypes"})
180 public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
181 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
182 return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
186 public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(@Nonnull final YangInstanceIdentifier path,
187 final NormalizedNode<?, ?> data) {
188 return codecRegistry.fromNormalizedNode(path, data);
192 public final Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
193 @Nonnull final ContainerNode data) {
194 return codecRegistry.fromNormalizedNodeNotification(path, data);
198 public final DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path,
199 @Nonnull final ContainerNode data) {
200 return codecRegistry.fromNormalizedNodeRpcData(path, data);
204 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
205 final ContainerNode input) {
206 return codecRegistry.fromNormalizedNodeActionInput(action, input);
210 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
211 final ContainerNode output) {
212 return codecRegistry.fromNormalizedNodeActionOutput(action, output);
216 public final InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull final YangInstanceIdentifier dom) {
217 return codecRegistry.fromYangInstanceIdentifier(dom);
221 public final ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
222 return codecRegistry.toNormalizedNodeNotification(data);
226 public final ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
227 return codecRegistry.toNormalizedNodeRpcData(data);
231 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
232 final RpcInput input) {
233 return codecRegistry.toNormalizedNodeActionInput(action, input);
237 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
238 final RpcOutput output) {
239 return codecRegistry.toNormalizedNodeActionOutput(action, output);
243 public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
244 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
245 return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
249 public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
250 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
251 return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
255 * Returns a Binding-Aware instance identifier from normalized
256 * instance-identifier if it is possible to create representation.
259 * Returns Optional.absent for cases where target is mixin node except
262 public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
263 throws DeserializationException {
265 return Optional.fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
266 } catch (final IllegalArgumentException e) {
267 return Optional.absent();
271 public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
272 @Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
273 throws DeserializationException {
276 * This cast is required, due to generics behaviour in openjdk / oracle javac.
279 * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
280 * this means '?' is always  <? extends DataObject>. Eclipse compiler
281 * is able to determine this relationship and treats
282 * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
283 * as assignable. However openjdk / oracle javac treats this two types
284 * as incompatible and issues a compile error.
287 * It is safe to lose generic information and cast it to other generic signature.
289 @SuppressWarnings("unchecked")
290 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
291 codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
292 return Optional.fromNullable(binding);
293 } catch (final IllegalArgumentException e) {
294 return Optional.absent();
299 public void onGlobalContextUpdated(final SchemaContext context) {
300 final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
301 codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
302 futureSchema.onRuntimeContextUpdated(runtimeContext);
308 * @deprecated Use {@link BindingNormalizedNodeCodecRegistry#deserializeFunction} instead.
311 public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
312 final InstanceIdentifier<T> path) {
313 return input -> Optional.fromJavaUtil(codecRegistry.deserializeFunction(path).apply(
314 Optional.toJavaUtil(input)));
317 public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
318 return codecRegistry;
322 public void close() {
323 if (listenerRegistration != null) {
324 listenerRegistration.close();
328 public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
329 return codecRegistry;
332 // FIXME: This should be probably part of Binding Runtime context
333 public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
334 final Module module = getModuleBlocking(key);
335 final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
337 for (final RpcDefinition rpcDef : module.getRpcs()) {
338 final Method method = findRpcMethod(key, rpcDef);
339 ret.put(method, rpcDef.getPath());
341 } catch (final NoSuchMethodException e) {
342 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
347 protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
348 final Module module = getModuleBlocking(key);
349 final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
351 for (final RpcDefinition rpcDef : module.getRpcs()) {
352 final Method method = findRpcMethod(key, rpcDef);
353 ret.put(method, rpcDef);
355 } catch (final NoSuchMethodException e) {
356 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
361 private Module getModuleBlocking(final Class<?> modeledClass) {
362 final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
363 BindingRuntimeContext localRuntimeContext = runtimeContext();
364 Module module = localRuntimeContext == null ? null :
365 localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
366 if (module == null && futureSchema.waitForSchema(moduleName)) {
367 localRuntimeContext = runtimeContext();
368 checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
369 module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
371 if (module != null) {
375 LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
376 modeledClass, moduleName, localRuntimeContext);
377 throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
378 + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
381 private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
382 LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
383 futureSchema.getUnit());
384 if (!futureSchema.waitForSchema(binding)) {
389 private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
390 throws NoSuchMethodException {
391 final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
392 final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
393 return key.getMethod(methodName, inputClz);
397 public final BindingCodecTree create(final BindingRuntimeContext context) {
398 return codecRegistry.create(context);
402 public final BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
403 return codecRegistry.create(context, bindingClasses);
407 protected Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
408 final YangInstanceIdentifier domIdentifier) {
410 final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
411 final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
412 checkArgument(bindingPath != null);
414 * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
415 * return non-null value.
417 final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
418 return new SimpleEntry<>(bindingPath, codecContext);
421 @SuppressWarnings("unchecked")
422 public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
423 final Set<Class<? extends Notification>> result = new HashSet<>();
424 final BindingRuntimeContext runtimeContext = runtimeContext();
425 for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
426 if (interested.contains(notification.getPath())) {
428 result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
429 } catch (final IllegalStateException e) {
431 LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
438 SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
439 final ActionDefinition schema = runtimeContext().getActionDefinition(type);
440 checkArgument(schema != null, "Failed to find schema for %s", type);
441 return schema.getPath();
444 private BindingRuntimeContext runtimeContext() {
445 return futureSchema.runtimeContext();
448 private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
449 return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
452 protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
453 return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
456 public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
457 final BindingCodecTreeNode<?> mapCodec = requireNonNull(
458 codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
459 "Codec not found for yang instance identifier: " + parentMapPath);
460 final WithStatus schema = mapCodec.getSchema();
461 if (schema instanceof ListSchemaNode) {
462 final ListSchemaNode castedSchema = (ListSchemaNode) schema;
463 return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
464 : Builders.mapBuilder(castedSchema).build();
466 throw new IllegalArgumentException("Path does not point to list schema node");
469 protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
470 final Collection<DataTreeIdentifier<?>> subtrees) {
471 return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
474 protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
475 final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
476 return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);