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

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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 com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.collect.ClassToInstanceMap;
  12 import com.google.common.collect.ImmutableClassToInstanceMap;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableSet;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import java.util.function.BiFunction;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  22 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  23 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  24 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  25 import org.opendaylight.yangtools.concepts.Registration;
  26 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.binding.Rpc;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  30
  31 @VisibleForTesting
  32 public class BindingDOMRpcProviderServiceAdapter extends AbstractBindingAdapter<DOMRpcProviderService>
  33         implements RpcProviderService {
  34     private static final ImmutableSet<YangInstanceIdentifier> GLOBAL = ImmutableSet.of(YangInstanceIdentifier.of());
  35
  36     public BindingDOMRpcProviderServiceAdapter(final AdapterContext adapterContext,
  37             final DOMRpcProviderService domRpcRegistry) {
  38         super(adapterContext, domRpcRegistry);
  39     }
  40
  41     @Override
  42     public Registration registerRpcImplementation(final Rpc<?, ?> implementation) {
  43         return register(currentSerializer(), implementation, GLOBAL);
  44     }
  45
  46     @Override
  47     public Registration registerRpcImplementation(final Rpc<?, ?> implementation,
  48             final Set<InstanceIdentifier<?>> paths) {
  49         final var serializer = currentSerializer();
  50         return register(serializer, implementation, toYangInstanceIdentifiers(serializer, paths));
  51     }
  52
  53     @Override
  54     public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations) {
  55         return register(currentSerializer(), implementations, GLOBAL);
  56     }
  57
  58     @Override
  59     public Registration registerRpcImplementations(final ClassToInstanceMap<Rpc<?, ?>> implementations,
  60             final Set<InstanceIdentifier<?>> paths) {
  61         final var serializer = currentSerializer();
  62         return register(serializer, implementations, toYangInstanceIdentifiers(serializer, paths));
  63     }
  64
  65     private <T extends Rpc<?, ?>> Registration register(final CurrentAdapterSerializer serializer,
  66             final T implementation, final Collection<YangInstanceIdentifier> rpcContextPaths) {
  67         @SuppressWarnings("unchecked")
  68         final var type = (Class<T>) implementation.implementedInterface();
  69         return register(serializer, ImmutableClassToInstanceMap.of(type, implementation), rpcContextPaths);
  70     }
  71
  72     private Registration register(final CurrentAdapterSerializer serializer,
  73             final ClassToInstanceMap<Rpc<?, ?>> implementations,
  74             // Note: unique items are implied
  75             final Collection<YangInstanceIdentifier> rpcContextPaths) {
  76         final var context = serializer.getRuntimeContext();
  77
  78         return register(implementations, rpcContextPaths, (type, impl) -> {
  79             final var def = context.getRpcDefinition(type);
  80             if (def == null) {
  81                 throw new IllegalArgumentException("Cannot resolve YANG definition of " + type);
  82             }
  83             final var rpcName = def.statement().argument();
  84             return new Impl(rpcName, new BindingDOMRpcImplementationAdapter(adapterContext(), rpcName, impl));
  85         });
  86     }
  87
  88     private <K, V> @NonNull Registration register(final Map<K, V> map, final Collection<YangInstanceIdentifier> paths,
  89             final BiFunction<K, V, Impl> implFactory) {
  90         final var builder = ImmutableMap.<DOMRpcIdentifier, DOMRpcImplementation>builderWithExpectedSize(map.size());
  91         for (var entry : map.entrySet()) {
  92             final var impl = implFactory.apply(entry.getKey(), entry.getValue());
  93             paths.forEach(path -> builder.put(DOMRpcIdentifier.create(impl.qname, path), impl.impl));
  94         }
  95         return getDelegate().registerRpcImplementations(builder.build());
  96     }
  97
  98     private static Collection<YangInstanceIdentifier> toYangInstanceIdentifiers(
  99             final CurrentAdapterSerializer serializer, final Set<InstanceIdentifier<?>> identifiers) {
 100         final var ret = new ArrayList<YangInstanceIdentifier>(identifiers.size());
 101         for (final InstanceIdentifier<?> binding : identifiers) {
 102             ret.add(serializer.toCachedYangInstanceIdentifier(binding));
 103         }
 104         return ret;
 105     }
 106
 107     private record Impl(@NonNull QName qname, @NonNull DOMRpcImplementation impl) {
 108         // Utility DTO for method return type
 109     }
 110 }