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