apps/netconf-topology/src/main/java/org/opendaylight/netconf/topology/spi/NetconfClientConfigurationBuilderFactory.java

   1 /*
   2  * Copyright (c) 2023 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.topology.spi;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.netconf.client.conf.NetconfClientConfigurationBuilder;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  13 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  14
  15 /**
  16  * Factory for creating {@link NetconfClientConfigurationBuilder}s.
  17  */
  18 public interface NetconfClientConfigurationBuilderFactory {
  19     /**
  20      * Create a new {@link NetconfClientConfigurationBuilder} initialized based on configuration {@link NetconfNode}.
  21      *
  22      * @param nodeId A topology node identifier
  23      * @param node A {@link NetconfNode}
  24      * @return An initialized {@link NetconfClientConfigurationBuilder}
  25      */
  26     @NonNull NetconfClientConfigurationBuilder createClientConfigurationBuilder(@NonNull NodeId nodeId,
  27         @NonNull NetconfNode node);
  28 }