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