protocol/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientFactoryImpl.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.client;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol.SSH;
  12 import static org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol.TCP;
  13 import static org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol.TLS;
  14
  15 import com.google.common.collect.ImmutableSet;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.SettableFuture;
  18 import io.netty.util.HashedWheelTimer;
  19 import io.netty.util.Timer;
  20 import javax.inject.Singleton;
  21 import org.opendaylight.netconf.api.TransportConstants;
  22 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  23 import org.opendaylight.netconf.transport.api.TransportChannel;
  24 import org.opendaylight.netconf.transport.api.TransportChannelListener;
  25 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  26 import org.opendaylight.netconf.transport.ssh.SSHTransportStackFactory;
  27 import org.opendaylight.netconf.transport.tcp.TCPClient;
  28 import org.opendaylight.netconf.transport.tls.TLSClient;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  30 import org.osgi.service.component.annotations.Activate;
  31 import org.osgi.service.component.annotations.Component;
  32 import org.osgi.service.component.annotations.Deactivate;
  33
  34 @Singleton
  35 @Component(immediate = true, service = NetconfClientFactory.class, property = "type=netconf-client-factory")
  36 public class NetconfClientFactoryImpl implements NetconfClientFactory {
  37     private final Timer timer = new HashedWheelTimer();
  38     private final SSHTransportStackFactory factory;
  39
  40     @Activate
  41     public NetconfClientFactoryImpl() {
  42         // TODO make factory component configurable for osgi
  43         this(new SSHTransportStackFactory("odl-netconf-client", 0));
  44     }
  45
  46     public NetconfClientFactoryImpl(final SSHTransportStackFactory factory) {
  47         this.factory = requireNonNull(factory);
  48     }
  49
  50     @Deactivate
  51     @Override
  52     public void close() {
  53         timer.stop();
  54         factory.close();
  55     }
  56
  57     @Override
  58     public ListenableFuture<NetconfClientSession> createClient(final NetconfClientConfiguration configuration)
  59             throws UnsupportedConfigurationException {
  60         final var protocol = configuration.getProtocol();
  61         final var future = SettableFuture.<NetconfClientSession>create();
  62         final var channelInitializer = new ClientChannelInitializer(createNegotiatorFactory(configuration),
  63             () -> configuration.getSessionListener());
  64         final var bootstrap = factory.newBootstrap();
  65
  66         if (TCP.equals(protocol)) {
  67             TCPClient.connect(new ClientTransportChannelListener(future, channelInitializer), bootstrap,
  68                 configuration.getTcpParameters());
  69         } else if (TLS.equals(protocol)) {
  70             if (configuration.getTlsParameters() != null) {
  71                 TLSClient.connect(new ClientTransportChannelListener(future, channelInitializer), bootstrap,
  72                     configuration.getTcpParameters(), configuration.getTlsParameters());
  73             } else {
  74                 TLSClient.connect(new ClientTransportChannelListener(future, channelInitializer), bootstrap,
  75                     configuration.getTcpParameters(), configuration.getTransportSslHandlerFactory());
  76             }
  77         } else if (SSH.equals(protocol)) {
  78             factory.connectClient(TransportConstants.SSH_SUBSYSTEM,
  79                 new ClientTransportChannelListener(future, channelInitializer), configuration.getTcpParameters(),
  80                 configuration.getSshParameters());
  81         }
  82         return future;
  83     }
  84
  85     private NetconfClientSessionNegotiatorFactory createNegotiatorFactory(
  86             final NetconfClientConfiguration configuration) {
  87         final var capabilities = configuration.getOdlHelloCapabilities();
  88         if (capabilities == null || capabilities.isEmpty()) {
  89             return new NetconfClientSessionNegotiatorFactory(timer, configuration.getAdditionalHeader(),
  90                 configuration.getConnectionTimeoutMillis(), configuration.getMaximumIncomingChunkSize());
  91         }
  92         final var stringCapabilities = capabilities.stream().map(Uri::getValue)
  93             .collect(ImmutableSet.toImmutableSet());
  94         return new NetconfClientSessionNegotiatorFactory(timer, configuration.getAdditionalHeader(),
  95             configuration.getConnectionTimeoutMillis(), stringCapabilities);
  96     }
  97
  98     private record ClientTransportChannelListener(
  99             SettableFuture<NetconfClientSession> future,
 100             ClientChannelInitializer initializer) implements TransportChannelListener {
 101         ClientTransportChannelListener {
 102             requireNonNull(future);
 103             requireNonNull(initializer);
 104         }
 105
 106         @Override
 107         public void onTransportChannelEstablished(final TransportChannel channel) {
 108             final var nettyChannel = channel.channel();
 109             final var promise = nettyChannel.eventLoop().<NetconfClientSession>newPromise();
 110             initializer.initialize(nettyChannel, promise);
 111             promise.addListener(ignored -> {
 112                 final var cause = promise.cause();
 113                 if (cause != null) {
 114                     future.setException(cause);
 115                 } else {
 116                     future.set(promise.getNow());
 117                 }
 118             });
 119         }
 120
 121         @Override
 122         public void onTransportChannelFailed(final Throwable cause) {
 123             future.setException(cause);
 124         }
 125     }
 126 }