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