plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/api/RemoteDeviceServices.java

   1 /*
   2  * Copyright (c) 2022 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.netconf.client.mdsal.api;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.mdsal.dom.api.DOMActionService;
  16 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  17 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  20
  21 /**
  22  * Set of interfaces exposed by a {@link RemoteDevice}.
  23  */
  24 public record RemoteDeviceServices(@NonNull Rpcs rpcs, @Nullable Actions actions) {
  25     public RemoteDeviceServices {
  26         requireNonNull(rpcs);
  27     }
  28
  29     /**
  30      * Interface exposing NETCONF device RPC service. This interface is never implemented directly, but rather through
  31      * its {@code non-sealed} specializations.
  32      */
  33     public sealed interface Rpcs extends NetconfRpcService permits Rpcs.Normalized, Rpcs.Schemaless {
  34         /**
  35          * NETCONF device RPCs operating just as any other {@link DOMRpcService}.
  36          */
  37         non-sealed interface Normalized extends Rpcs {
  38             @Override
  39             default ListenableFuture<? extends DOMRpcResult> invokeNetconf(final QName type,
  40                     final ContainerNode input) {
  41                 return domRpcService().invokeRpc(type, input);
  42             }
  43
  44             @NonNull DOMRpcService domRpcService();
  45         }
  46
  47         /**
  48          * NETCONF device RPCs operating in terms of {@link SchemalessRpcService}.
  49          */
  50         non-sealed interface Schemaless extends Rpcs {
  51
  52             @NonNull SchemalessRpcService schemalessRpcService();
  53         }
  54     }
  55
  56     /**
  57      * Interface exposing NETCONF device Action service. This interface is never implemented directly, but rather
  58      * through its {@code non-sealed} specializations.
  59      */
  60     public sealed interface Actions permits Actions.Normalized {
  61         /**
  62          * NETCONF device RPCs operating just as any other {@link DOMActionService}.
  63          */
  64         non-sealed interface Normalized extends Actions, DOMActionService {
  65             // Just an interface combination
  66         }
  67     }
  68 }