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 org.eclipse.jdt.annotation.NonNull;
  13 import org.eclipse.jdt.annotation.Nullable;
  14 import org.opendaylight.mdsal.dom.api.DOMActionService;
  15 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  16
  17 /**
  18  * Set of interfaces exposed by a {@link RemoteDevice}.
  19  */
  20 public record RemoteDeviceServices(@NonNull Rpcs rpcs, @Nullable Actions actions) {
  21     public RemoteDeviceServices {
  22         requireNonNull(rpcs);
  23     }
  24
  25     /**
  26      * Interface exposing NETCONF device RPC service. This interface is never implemented directly, but rather through
  27      * its {@code non-sealed} specializations.
  28      */
  29     public sealed interface Rpcs extends NetconfRpcService permits Rpcs.Normalized, Rpcs.Schemaless {
  30         /**
  31          * NETCONF device RPCs operating just as any other {@link DOMRpcService}.
  32          */
  33         non-sealed interface Normalized extends Rpcs {
  34
  35             @NonNull DOMRpcService domRpcService();
  36         }
  37
  38         /**
  39          * NETCONF device RPCs operating in terms of {@link SchemalessRpcService}.
  40          */
  41         non-sealed interface Schemaless extends Rpcs {
  42
  43             @NonNull SchemalessRpcService schemalessRpcService();
  44         }
  45     }
  46
  47     /**
  48      * Interface exposing NETCONF device Action service. This interface is never implemented directly, but rather
  49      * through its {@code non-sealed} specializations.
  50      */
  51     public sealed interface Actions permits Actions.Normalized {
  52         /**
  53          * NETCONF device RPCs operating just as any other {@link DOMActionService}.
  54          */
  55         non-sealed interface Normalized extends Actions, DOMActionService {
  56             // Just an interface combination
  57         }
  58     }
  59 }