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