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.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.data.impl.schema.ImmutableNodes;
66 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
67 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
68 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
69 import org.opendaylight.yangtools.yang.model.api.Module;
70 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
71 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
72 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
73 import org.slf4j.Logger;
74 import org.slf4j.LoggerFactory;
77 * A combinations of {@link BindingCodecTreeFactory} and {@link BindingNormalizedNodeSerializer}, with internal
78 * caching of instance identifiers.
81 * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
84 public class BindingToNormalizedNodeCodec implements BindingNormalizedNodeSerializer, EffectiveModelContextListener,
87 private static final long WAIT_DURATION_SEC = 5;
88 private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
90 private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
91 .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
93 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
94 return toYangInstanceIdentifierBlocking(key);
97 private final BindingNormalizedNodeCodecRegistry codecRegistry;
98 private final ClassLoadingStrategy classLoadingStrategy;
99 private final BindingRuntimeGenerator generator;
100 private final FutureSchema futureSchema;
102 private ListenerRegistration<?> listenerRegistration;
105 public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
106 final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) {
107 this(generator, classLoadingStrategy, codecRegistry, false);
111 public BindingToNormalizedNodeCodec(final BindingRuntimeContext runtimeContext) {
112 generator = (final SchemaContext context) -> {
113 throw new UnsupportedOperationException("Static context assigned");
115 classLoadingStrategy = runtimeContext.getStrategy();
116 codecRegistry = new BindingNormalizedNodeCodecRegistry(runtimeContext);
117 // TODO: this should have a specialized constructor or not be needed
118 futureSchema = FutureSchema.create(0, TimeUnit.SECONDS, false);
119 futureSchema.onRuntimeContextUpdated(runtimeContext);
122 public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
123 final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry,
124 final boolean waitForSchema) {
125 this.generator = requireNonNull(generator, "generator");
126 this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
127 this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
128 this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
131 public static BindingToNormalizedNodeCodec newInstance(final BindingRuntimeGenerator generator,
132 final ClassLoadingStrategy classLoadingStrategy, final DOMSchemaService schemaService) {
133 final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
134 BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(generator, classLoadingStrategy,
135 codecRegistry, true);
136 instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
140 protected YangInstanceIdentifier toYangInstanceIdentifierBlocking(
141 final InstanceIdentifier<? extends DataObject> binding) {
143 return codecRegistry.toYangInstanceIdentifier(binding);
144 } catch (final MissingSchemaException e) {
145 waitForSchema(decompose(binding), e);
146 return codecRegistry.toYangInstanceIdentifier(binding);
151 public final YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
152 return codecRegistry.toYangInstanceIdentifier(binding);
155 protected YangInstanceIdentifier toYangInstanceIdentifierCached(final InstanceIdentifier<?> binding) {
156 return iiCache.getUnchecked(binding);
160 public final <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
161 final InstanceIdentifier<T> path, final T data) {
163 return codecRegistry.toNormalizedNode(path, data);
164 } catch (final MissingSchemaException e) {
165 waitForSchema(decompose(path), e);
166 return codecRegistry.toNormalizedNode(path, data);
171 public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
172 final NormalizedNode<?, ?> data) {
173 return codecRegistry.fromNormalizedNode(path, data);
177 public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
178 return codecRegistry.fromNormalizedNodeNotification(path, data);
182 public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
183 final Instant eventInstant) {
184 return codecRegistry.fromNormalizedNodeNotification(path, data, eventInstant);
188 public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
189 return codecRegistry.fromNormalizedNodeRpcData(path, data);
193 public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
194 final ContainerNode input) {
195 return codecRegistry.fromNormalizedNodeActionInput(action, input);
199 public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
200 final ContainerNode output) {
201 return codecRegistry.fromNormalizedNodeActionOutput(action, output);
205 public final InstanceIdentifier<?> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
206 return codecRegistry.fromYangInstanceIdentifier(dom);
210 public final ContainerNode toNormalizedNodeNotification(final Notification data) {
211 return codecRegistry.toNormalizedNodeNotification(data);
215 public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
216 return codecRegistry.toNormalizedNodeRpcData(data);
220 public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
221 final RpcInput input) {
222 return codecRegistry.toNormalizedNodeActionInput(action, input);
226 public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
227 final RpcOutput output) {
228 return codecRegistry.toNormalizedNodeActionOutput(action, output);
232 public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(
233 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcInput input) {
234 return codecRegistry.toLazyNormalizedNodeActionInput(action, identifier, input);
238 public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(
239 final Class<? extends Action<?, ?, ?>> action, final NodeIdentifier identifier, final RpcOutput output) {
240 return codecRegistry.toLazyNormalizedNodeActionOutput(action, identifier, output);
244 * Returns a Binding-Aware instance identifier from normalized
245 * instance-identifier if it is possible to create representation.
248 * Returns Optional.empty for cases where target is mixin node except
251 public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
252 throws DeserializationException {
254 return Optional.ofNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
255 } catch (final IllegalArgumentException e) {
256 return Optional.empty();
261 public void onModelContextUpdated(final EffectiveModelContext newModelContext) {
262 final BindingRuntimeContext runtimeContext = DefaultBindingRuntimeContext.create(
263 generator.generateTypeMapping(newModelContext), classLoadingStrategy);
264 codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
265 futureSchema.onRuntimeContextUpdated(runtimeContext);
268 public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
269 return codecRegistry;
274 public void close() {
275 if (listenerRegistration != null) {
276 listenerRegistration.close();
280 public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
281 return codecRegistry;
284 // FIXME: This should be probably part of Binding Runtime context
285 public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
286 final Module module = getModuleBlocking(key);
287 final ImmutableBiMap.Builder<Method, SchemaPath> ret = ImmutableBiMap.builder();
289 for (final RpcDefinition rpcDef : module.getRpcs()) {
290 final Method method = findRpcMethod(key, rpcDef);
291 ret.put(method, rpcDef.getPath());
293 } catch (final NoSuchMethodException e) {
294 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
299 protected ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
300 final Module module = getModuleBlocking(key);
301 final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
303 for (final RpcDefinition rpcDef : module.getRpcs()) {
304 final Method method = findRpcMethod(key, rpcDef);
305 ret.put(method, rpcDef);
307 } catch (final NoSuchMethodException e) {
308 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
313 private Module getModuleBlocking(final Class<?> modeledClass) {
314 final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
315 BindingRuntimeContext localRuntimeContext = runtimeContext();
316 Module module = localRuntimeContext == null ? null :
317 localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
318 if (module == null && futureSchema.waitForSchema(moduleName)) {
319 localRuntimeContext = runtimeContext();
320 checkState(localRuntimeContext != null, "BindingRuntimeContext is not available.");
321 module = localRuntimeContext.getSchemaContext().findModule(moduleName).orElse(null);
323 if (module != null) {
327 LOG.debug("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
328 modeledClass, moduleName, localRuntimeContext);
329 throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
330 + "full BindingRuntimeContext available in debug log", modeledClass, moduleName));
333 private void waitForSchema(final Collection<Class<?>> binding, final MissingSchemaException exception) {
334 LOG.warn("Blocking thread to wait for schema convergence updates for {} {}", futureSchema.getDuration(),
335 futureSchema.getUnit());
336 if (!futureSchema.waitForSchema(binding)) {
341 private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
342 throws NoSuchMethodException {
343 final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
344 final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
345 return key.getMethod(methodName, inputClz);
348 protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
349 final YangInstanceIdentifier domIdentifier) {
351 final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
352 final InstanceIdentifier<?> bindingPath = codecRegistry.fromYangInstanceIdentifier(domIdentifier);
353 checkArgument(bindingPath != null);
355 * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
356 * return non-null value.
358 final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
359 return new SimpleEntry<>(bindingPath, codecContext);
362 SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
363 final ActionDefinition schema = runtimeContext().getActionDefinition(type);
364 checkArgument(schema != null, "Failed to find schema for %s", type);
365 return schema.getPath();
368 private BindingRuntimeContext runtimeContext() {
369 return futureSchema.runtimeContext();
372 private static Collection<Class<?>> decompose(final InstanceIdentifier<?> path) {
373 return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
376 protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
377 return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
380 protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
381 final Collection<DataTreeIdentifier<?>> subtrees) {
382 return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
385 protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
386 final YangInstanceIdentifier domPath = toYangInstanceIdentifierBlocking(path.getRootIdentifier());
387 return new DOMDataTreeIdentifier(path.getDatastoreType(), domPath);