protocol/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientDispatcherImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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
  12 import io.netty.channel.EventLoopGroup;
  13 import io.netty.util.Timer;
  14 import io.netty.util.concurrent.Future;
  15 import java.util.LinkedHashSet;
  16 import java.util.List;
  17 import java.util.Set;
  18 import javax.inject.Inject;
  19 import javax.inject.Singleton;
  20 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  21 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
  22 import org.opendaylight.netconf.nettyutil.AbstractNetconfDispatcher;
  23 import org.opendaylight.netconf.nettyutil.ReconnectFuture;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  25 import org.osgi.service.component.annotations.Activate;
  26 import org.osgi.service.component.annotations.Component;
  27 import org.osgi.service.component.annotations.Reference;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 @Singleton
  32 @Component(immediate = true, service = NetconfClientDispatcher.class, property = "type=netconf-client-dispatcher")
  33 public class NetconfClientDispatcherImpl
  34         extends AbstractNetconfDispatcher<NetconfClientSession, NetconfClientSessionListener>
  35         implements NetconfClientDispatcher {
  36     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientDispatcherImpl.class);
  37
  38     private final Timer timer;
  39
  40     @Inject
  41     @Activate
  42     public NetconfClientDispatcherImpl(@Reference(target = "(type=global-boss-group)") final EventLoopGroup bossGroup,
  43             @Reference(target = "(type=global-worker-group)") final EventLoopGroup workerGroup,
  44             @Reference(target = "(type=global-timer)") final Timer timer) {
  45         super(bossGroup, workerGroup);
  46         this.timer = requireNonNull(timer);
  47     }
  48
  49     protected final Timer getTimer() {
  50         return timer;
  51     }
  52
  53     @Override
  54     public Future<NetconfClientSession> createClient(final NetconfClientConfiguration clientConfiguration) {
  55         return switch (clientConfiguration.getProtocol()) {
  56             case TCP -> createTcpClient(clientConfiguration);
  57             case SSH -> createSshClient(clientConfiguration);
  58             case TLS -> createTlsClient(clientConfiguration);
  59         };
  60     }
  61
  62     @Override
  63     public ReconnectFuture createReconnectingClient(final NetconfReconnectingClientConfiguration clientConfiguration) {
  64         return switch (clientConfiguration.getProtocol()) {
  65             case TCP -> createReconnectingTcpClient(clientConfiguration);
  66             case SSH -> createReconnectingSshClient(clientConfiguration);
  67             case TLS -> createReconnectingTlsClient(clientConfiguration);
  68         };
  69     }
  70
  71     private Future<NetconfClientSession> createTcpClient(final NetconfClientConfiguration currentConfiguration) {
  72         LOG.debug("Creating TCP client with configuration: {}", currentConfiguration);
  73         return super.createClient(currentConfiguration.getAddress(), currentConfiguration.getReconnectStrategy(),
  74             (ch, promise) -> new TcpClientChannelInitializer(getNegotiatorFactory(currentConfiguration),
  75                         currentConfiguration.getSessionListener()).initialize(ch, promise));
  76     }
  77
  78     private ReconnectFuture createReconnectingTcpClient(
  79             final NetconfReconnectingClientConfiguration currentConfiguration) {
  80         LOG.debug("Creating reconnecting TCP client with configuration: {}", currentConfiguration);
  81         final TcpClientChannelInitializer init =
  82                 new TcpClientChannelInitializer(getNegotiatorFactory(currentConfiguration),
  83                 currentConfiguration.getSessionListener());
  84
  85         return super.createReconnectingClient(currentConfiguration.getAddress(),
  86                 currentConfiguration.getConnectStrategyFactory(), init::initialize);
  87     }
  88
  89     private Future<NetconfClientSession> createSshClient(final NetconfClientConfiguration currentConfiguration) {
  90         LOG.debug("Creating SSH client with configuration: {}", currentConfiguration);
  91         return super.createClient(currentConfiguration.getAddress(), currentConfiguration.getReconnectStrategy(),
  92             (ch, sessionPromise) -> new SshClientChannelInitializer(currentConfiguration.getAuthHandler(),
  93                         getNegotiatorFactory(currentConfiguration), currentConfiguration.getSessionListener(),
  94                         currentConfiguration.getSshClient(), currentConfiguration.getName())
  95                     .initialize(ch, sessionPromise));
  96     }
  97
  98     private ReconnectFuture createReconnectingSshClient(
  99             final NetconfReconnectingClientConfiguration currentConfiguration) {
 100         LOG.debug("Creating reconnecting SSH client with configuration: {}", currentConfiguration);
 101         final SshClientChannelInitializer init = new SshClientChannelInitializer(currentConfiguration.getAuthHandler(),
 102                 getNegotiatorFactory(currentConfiguration), currentConfiguration.getSessionListener(),
 103                 currentConfiguration.getSshClient(), currentConfiguration.getName());
 104
 105         return super.createReconnectingClient(currentConfiguration.getAddress(),
 106                 currentConfiguration.getConnectStrategyFactory(), init::initialize);
 107     }
 108
 109     private Future<NetconfClientSession> createTlsClient(final NetconfClientConfiguration currentConfiguration) {
 110         LOG.debug("Creating TLS client with configuration: {}", currentConfiguration);
 111         return super.createClient(currentConfiguration.getAddress(), currentConfiguration.getReconnectStrategy(),
 112             (ch, sessionPromise) -> new TlsClientChannelInitializer(currentConfiguration.getSslHandlerFactory(),
 113                     getNegotiatorFactory(currentConfiguration), currentConfiguration.getSessionListener())
 114                     .initialize(ch, sessionPromise));
 115     }
 116
 117     private ReconnectFuture createReconnectingTlsClient(
 118             final NetconfReconnectingClientConfiguration currentConfiguration) {
 119         LOG.debug("Creating reconnecting TLS client with configuration: {}", currentConfiguration);
 120         final TlsClientChannelInitializer init = new TlsClientChannelInitializer(
 121                 currentConfiguration.getSslHandlerFactory(), getNegotiatorFactory(currentConfiguration),
 122                 currentConfiguration.getSessionListener());
 123
 124         return super.createReconnectingClient(currentConfiguration.getAddress(),
 125                 currentConfiguration.getConnectStrategyFactory(), init::initialize);
 126     }
 127
 128     protected NetconfClientSessionNegotiatorFactory getNegotiatorFactory(final NetconfClientConfiguration cfg) {
 129         final List<Uri> odlHelloCapabilities = cfg.getOdlHelloCapabilities();
 130         if (odlHelloCapabilities == null || odlHelloCapabilities.isEmpty()) {
 131             return new NetconfClientSessionNegotiatorFactory(timer, cfg.getAdditionalHeader(),
 132                     cfg.getConnectionTimeoutMillis(), cfg.getMaximumIncomingChunkSize());
 133         }
 134
 135         // LinkedHashSet since perhaps the device cares about order of hello message capabilities.
 136         // This allows user control of the order while complying with the existing interface.
 137         final Set<String> stringCapabilities = new LinkedHashSet<>();
 138         for (final Uri uri : odlHelloCapabilities) {
 139             stringCapabilities.add(uri.getValue());
 140         }
 141         return new NetconfClientSessionNegotiatorFactory(timer, cfg.getAdditionalHeader(),
 142             cfg.getConnectionTimeoutMillis(), stringCapabilities);
 143     }
 144 }