2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
12 import static java.util.Objects.requireNonNull;
14 import com.google.common.annotations.Beta;
15 import com.google.common.annotations.VisibleForTesting;
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 java.lang.reflect.Method;
21 import java.util.Collection;
23 import java.util.Map.Entry;
24 import java.util.stream.Collectors;
25 import org.eclipse.jdt.annotation.NonNull;
26 import org.opendaylight.mdsal.binding.api.ActionSpec;
27 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
28 import org.opendaylight.mdsal.binding.api.InstanceNotificationSpec;
29 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
30 import org.opendaylight.mdsal.binding.dom.codec.spi.ForwardingBindingDOMCodecServices;
31 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
32 import org.opendaylight.mdsal.binding.runtime.api.RpcRuntimeType;
33 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
34 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
35 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
36 import org.opendaylight.yangtools.yang.binding.DataObject;
37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
38 import org.opendaylight.yangtools.yang.binding.RpcService;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.opendaylight.yangtools.yang.common.QNameModule;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
44 import org.opendaylight.yangtools.yang.model.api.Module;
45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
46 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
47 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
49 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
50 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
51 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
57 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
58 private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
60 private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
61 .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
63 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
64 return toYangInstanceIdentifier(key);
68 private final @NonNull BindingDOMCodecServices delegate;
70 public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
71 this.delegate = requireNonNull(delegate);
75 protected BindingDOMCodecServices delegate() {
79 @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
80 return cache.getUnchecked(path);
83 <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
84 return verifyNotNull(fromYangInstanceIdentifier(dom));
87 DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
88 return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
91 Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
92 return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
95 @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
96 final var entry = resolvePath(spec.path());
97 final var stack = entry.getKey();
98 final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
99 verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
100 return stack.toSchemaNodeIdentifier();
103 @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
104 final var entry = resolvePath(spec.path());
105 final var stack = entry.getKey();
106 final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
107 verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
109 return stack.toSchemaNodeIdentifier();
112 private @NonNull Entry<SchemaInferenceStack, QNameModule> resolvePath(final @NonNull InstanceIdentifier<?> path) {
113 final var stack = SchemaInferenceStack.of(getRuntimeContext().getEffectiveModelContext());
114 final var it = toYangInstanceIdentifier(path).getPathArguments().iterator();
115 verify(it.hasNext(), "Unexpected empty instance identifier for %s", path);
117 QNameModule lastNamespace;
119 final var arg = it.next();
120 if (arg instanceof AugmentationIdentifier) {
121 final var augChildren = ((AugmentationIdentifier) arg).getPossibleChildNames();
122 verify(!augChildren.isEmpty(), "Invalid empty augmentation %s", arg);
123 lastNamespace = augChildren.iterator().next().getModule();
127 final var qname = arg.getNodeType();
128 final var stmt = stack.enterDataTree(qname);
129 lastNamespace = qname.getModule();
130 if (stmt instanceof ListEffectiveStatement) {
131 // Lists have two steps
132 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
133 // Verify just to make sure we are doing the right thing
134 final var skipped = it.next();
135 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
136 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
139 } while (it.hasNext());
141 return Map.entry(stack, lastNamespace);
144 // FIXME: This should be probably part of Binding Runtime context and RpcServices perhaps should have their own
146 ImmutableBiMap<Method, RpcRuntimeType> getRpcMethodToSchema(final Class<? extends RpcService> key) {
147 final var runtimeContext = getRuntimeContext();
148 final var types = runtimeContext.getTypes();
149 final var qnameModule = BindingReflections.getQNameModule(key);
151 // We are dancing a bit here to reconstruct things a RpcServiceRuntimeType could easily hold
152 final var module = runtimeContext.getEffectiveModelContext().findModuleStatement(qnameModule)
153 .orElseThrow(() -> new IllegalStateException("No module found for " + qnameModule + " service " + key));
154 return module.streamEffectiveSubstatements(RpcEffectiveStatement.class)
156 final var rpcName = rpc.argument();
157 final var inputClz = runtimeContext.getRpcInput(rpcName);
158 final var methodName = BindingMapping.getRpcMethodName(rpcName);
162 method = key.getMethod(methodName, inputClz);
163 } catch (NoSuchMethodException e) {
164 throw new IllegalStateException("Cannot find RPC method for " + rpc, e);
167 final var type = types.schemaTreeChild(rpcName);
168 if (!(type instanceof RpcRuntimeType rpcType)) {
169 throw new IllegalStateException("Unexpected run-time type " + type + " for " + rpcName);
171 return Map.entry(method, rpcType);
173 .collect(ImmutableBiMap.toImmutableBiMap(Entry::getKey, Entry::getValue));
176 // FIXME: This should be probably part of Binding Runtime context
177 ImmutableBiMap<Method, QName> getRpcMethodToQName(final Class<? extends RpcService> key) {
178 final Module module = getModule(key);
179 final ImmutableBiMap.Builder<Method, QName> ret = ImmutableBiMap.builder();
181 for (final RpcDefinition rpcDef : module.getRpcs()) {
182 final Method method = findRpcMethod(key, rpcDef);
183 ret.put(method,rpcDef.getQName());
185 } catch (final NoSuchMethodException e) {
186 throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
191 private Module getModule(final Class<?> modeledClass) {
192 final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
193 final BindingRuntimeContext localRuntimeContext = getRuntimeContext();
194 final Module module = localRuntimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
195 if (module != null) {
199 LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
200 modeledClass, moduleName, localRuntimeContext);
201 throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
202 + "full BindingRuntimeContext available in trace log", modeledClass, moduleName));
205 private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
206 throws NoSuchMethodException {
207 final var rpcName = rpcDef.getQName();
208 final var inputClz = getRuntimeContext().getRpcInput(rpcName);
209 return key.getMethod(BindingMapping.getRpcMethodName(rpcName), inputClz);