binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/CurrentAdapterSerializer.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  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;
  22 import java.util.Map;
  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.spec.naming.BindingMapping;
  33 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  34 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.binding.RpcService;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.QNameModule;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.model.api.Module;
  44 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  49 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 @Beta
  54 @VisibleForTesting
  55 public final class CurrentAdapterSerializer extends ForwardingBindingDOMCodecServices {
  56     private static final Logger LOG = LoggerFactory.getLogger(CurrentAdapterSerializer.class);
  57
  58     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> cache = CacheBuilder.newBuilder()
  59             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
  60                 @Override
  61                 public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
  62                     return toYangInstanceIdentifier(key);
  63                 }
  64             });
  65
  66     private final @NonNull BindingDOMCodecServices delegate;
  67
  68     public CurrentAdapterSerializer(final BindingDOMCodecServices delegate) {
  69         this.delegate = requireNonNull(delegate);
  70     }
  71
  72     @Override
  73     protected BindingDOMCodecServices delegate() {
  74         return delegate;
  75     }
  76
  77     @NonNull YangInstanceIdentifier toCachedYangInstanceIdentifier(final @NonNull InstanceIdentifier<?> path) {
  78         return cache.getUnchecked(path);
  79     }
  80
  81     <T extends DataObject> @NonNull InstanceIdentifier<T> coerceInstanceIdentifier(final YangInstanceIdentifier dom) {
  82         return verifyNotNull(fromYangInstanceIdentifier(dom));
  83     }
  84
  85     DOMDataTreeIdentifier toDOMDataTreeIdentifier(final DataTreeIdentifier<?> path) {
  86         return new DOMDataTreeIdentifier(path.getDatastoreType(), toYangInstanceIdentifier(path.getRootIdentifier()));
  87     }
  88
  89     Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(final Collection<DataTreeIdentifier<?>> subtrees) {
  90         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());
  91     }
  92
  93     @NonNull Absolute getActionPath(final @NonNull ActionSpec<?, ?> spec) {
  94         final var entry = resolvePath(spec.path());
  95         final var stack = entry.getKey();
  96         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
  97         verify(stmt instanceof ActionEffectiveStatement, "Action %s resolved to unexpected statement %s", spec, stmt);
  98         return stack.toSchemaNodeIdentifier();
  99     }
 100
 101     @NonNull Absolute getNotificationPath(final @NonNull InstanceNotificationSpec<?, ?> spec) {
 102         final var entry = resolvePath(spec.path());
 103         final var stack = entry.getKey();
 104         final var stmt = stack.enterSchemaTree(BindingReflections.findQName(spec.type()).bindTo(entry.getValue()));
 105         verify(stmt instanceof NotificationEffectiveStatement, "Notification %s resolved to unexpected statement %s",
 106             spec, stmt);
 107         return stack.toSchemaNodeIdentifier();
 108     }
 109
 110     private @NonNull Entry<SchemaInferenceStack, QNameModule> resolvePath(final @NonNull InstanceIdentifier<?> path) {
 111         final var stack = SchemaInferenceStack.of(getRuntimeContext().getEffectiveModelContext());
 112         final var it = toYangInstanceIdentifier(path).getPathArguments().iterator();
 113         verify(it.hasNext(), "Unexpected empty instance identifier for %s", path);
 114
 115         QNameModule lastNamespace;
 116         do {
 117             final var arg = it.next();
 118             if (arg instanceof AugmentationIdentifier) {
 119                 final var augChildren = ((AugmentationIdentifier) arg).getPossibleChildNames();
 120                 verify(!augChildren.isEmpty(), "Invalid empty augmentation %s", arg);
 121                 lastNamespace = augChildren.iterator().next().getModule();
 122                 continue;
 123             }
 124
 125             final var qname = arg.getNodeType();
 126             final var stmt = stack.enterDataTree(qname);
 127             lastNamespace = qname.getModule();
 128             if (stmt instanceof ListEffectiveStatement) {
 129                 // Lists have two steps
 130                 verify(it.hasNext(), "Unexpected list termination at %s in %s", stmt, path);
 131                 // Verify just to make sure we are doing the right thing
 132                 final var skipped = it.next();
 133                 verify(skipped instanceof NodeIdentifier, "Unexpected skipped list entry item %s in %s", skipped, path);
 134                 verify(stmt.argument().equals(skipped.getNodeType()), "Mismatched list entry item %s in %s", skipped,
 135                     path);
 136             }
 137         } while (it.hasNext());
 138
 139         return Map.entry(stack, lastNamespace);
 140     }
 141
 142     // FIXME: This should be probably part of Binding Runtime context
 143     ImmutableBiMap<Method, RpcDefinition> getRpcMethodToSchema(final Class<? extends RpcService> key) {
 144         final Module module = getModule(key);
 145         final ImmutableBiMap.Builder<Method, RpcDefinition> ret = ImmutableBiMap.builder();
 146         try {
 147             for (final RpcDefinition rpcDef : module.getRpcs()) {
 148                 final Method method = findRpcMethod(key, rpcDef);
 149                 ret.put(method, rpcDef);
 150             }
 151         } catch (final NoSuchMethodException e) {
 152             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 153         }
 154         return ret.build();
 155     }
 156
 157     // FIXME: This should be probably part of Binding Runtime context
 158     ImmutableBiMap<Method, QName> getRpcMethodToQName(final Class<? extends RpcService> key) {
 159         final Module module = getModule(key);
 160         final ImmutableBiMap.Builder<Method, QName> ret = ImmutableBiMap.builder();
 161         try {
 162             for (final RpcDefinition rpcDef : module.getRpcs()) {
 163                 final Method method = findRpcMethod(key, rpcDef);
 164                 ret.put(method,rpcDef.getQName());
 165             }
 166         } catch (final NoSuchMethodException e) {
 167             throw new IllegalStateException("Rpc defined in model does not have representation in generated class.", e);
 168         }
 169         return ret.build();
 170     }
 171
 172     private Module getModule(final Class<?> modeledClass) {
 173         final QNameModule moduleName = BindingReflections.getQNameModule(modeledClass);
 174         final BindingRuntimeContext localRuntimeContext = getRuntimeContext();
 175         final Module module = localRuntimeContext.getEffectiveModelContext().findModule(moduleName).orElse(null);
 176         if (module != null) {
 177             return module;
 178         }
 179
 180         LOG.trace("Schema for {} is not available; expected module name: {}; BindingRuntimeContext: {}",
 181                 modeledClass, moduleName, localRuntimeContext);
 182         throw new IllegalStateException(String.format("Schema for %s is not available; expected module name: %s; "
 183                 + "full BindingRuntimeContext available in trace log", modeledClass, moduleName));
 184     }
 185
 186     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
 187             throws NoSuchMethodException {
 188         final var rpcName = rpcDef.getQName();
 189         final var inputClz = getRuntimeContext().getRpcInput(rpcName);
 190         return key.getMethod(BindingMapping.getRpcMethodName(rpcName), inputClz);
 191     }
 192 }