netconf/netconf-client/src/main/java/org/opendaylight/netconf/client/conf/NetconfClientConfiguration.java

   1 /*
   2  * Copyright (c) 2014 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.conf;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import java.net.InetSocketAddress;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import org.checkerframework.checker.index.qual.NonNegative;
  18 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  19 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  20 import org.opendaylight.netconf.client.SslHandlerFactory;
  21 import org.opendaylight.netconf.nettyutil.ReconnectStrategy;
  22 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
  23 import org.opendaylight.netconf.nettyutil.handler.ssh.client.NetconfSshClient;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 public class NetconfClientConfiguration {
  29     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientConfiguration.class);
  30
  31     private final NetconfClientProtocol clientProtocol;
  32     private final InetSocketAddress address;
  33     private final Long connectionTimeoutMillis;
  34
  35     private final NetconfHelloMessageAdditionalHeader additionalHeader;
  36     private final NetconfClientSessionListener sessionListener;
  37
  38     private final ReconnectStrategy reconnectStrategy;
  39
  40     private final AuthenticationHandler authHandler;
  41     private final SslHandlerFactory sslHandlerFactory;
  42     private final NetconfSshClient sshClient;
  43
  44     private final List<Uri> odlHelloCapabilities;
  45     private final @NonNegative int maximumIncomingChunkSize;
  46
  47     NetconfClientConfiguration(final NetconfClientProtocol protocol, final InetSocketAddress address,
  48                                final Long connectionTimeoutMillis,
  49                                final NetconfHelloMessageAdditionalHeader additionalHeader,
  50                                final NetconfClientSessionListener sessionListener,
  51                                final ReconnectStrategy reconnectStrategy, final AuthenticationHandler authHandler,
  52                                final SslHandlerFactory sslHandlerFactory, final NetconfSshClient sshClient,
  53                                final List<Uri> odlHelloCapabilities, final @NonNegative int maximumIncomingChunkSize) {
  54         this.address = address;
  55         this.connectionTimeoutMillis = connectionTimeoutMillis;
  56         this.additionalHeader = additionalHeader;
  57         this.sessionListener = sessionListener;
  58         clientProtocol = protocol;
  59         this.reconnectStrategy = reconnectStrategy;
  60         this.authHandler = authHandler;
  61         this.sslHandlerFactory = sslHandlerFactory;
  62         this.sshClient = sshClient;
  63         this.odlHelloCapabilities = odlHelloCapabilities;
  64         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  65         validateConfiguration();
  66     }
  67
  68     public final InetSocketAddress getAddress() {
  69         return address;
  70     }
  71
  72     public final Long getConnectionTimeoutMillis() {
  73         return connectionTimeoutMillis;
  74     }
  75
  76     public final Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
  77         return Optional.ofNullable(additionalHeader);
  78     }
  79
  80     public final NetconfClientSessionListener getSessionListener() {
  81         return sessionListener;
  82     }
  83
  84     @Deprecated(forRemoval = true)
  85     public final ReconnectStrategy getReconnectStrategy() {
  86         return reconnectStrategy;
  87     }
  88
  89     public final AuthenticationHandler getAuthHandler() {
  90         return authHandler;
  91     }
  92
  93     public NetconfClientProtocol getProtocol() {
  94         return clientProtocol;
  95     }
  96
  97     public SslHandlerFactory getSslHandlerFactory() {
  98         return sslHandlerFactory;
  99     }
 100
 101     public NetconfSshClient getSshClient() {
 102         return sshClient;
 103     }
 104
 105     public List<Uri> getOdlHelloCapabilities() {
 106         return odlHelloCapabilities;
 107     }
 108
 109     public @NonNegative int getMaximumIncomingChunkSize() {
 110         return maximumIncomingChunkSize;
 111     }
 112
 113     private void validateConfiguration() {
 114         switch (requireNonNull(clientProtocol)) {
 115             case TLS:
 116                 validateTlsConfiguration();
 117                 validateTcpConfiguration();
 118                 break;
 119             case SSH:
 120                 validateSshConfiguration();
 121                 validateTcpConfiguration();
 122                 break;
 123             case TCP:
 124                 validateTcpConfiguration();
 125                 break;
 126             default:
 127                 LOG.warn("Unexpected protocol: {} in netconf client configuration.", clientProtocol);
 128         }
 129     }
 130
 131     protected final void validateTlsConfiguration() {
 132         requireNonNull(sslHandlerFactory, "sslHandlerFactory");
 133     }
 134
 135     protected final void validateSshConfiguration() {
 136         requireNonNull(authHandler, "authHandler");
 137     }
 138
 139     protected final void validateTcpConfiguration() {
 140         requireNonNull(address, "address");
 141         requireNonNull(clientProtocol, "clientProtocol");
 142         requireNonNull(connectionTimeoutMillis, "connectionTimeoutMillis");
 143         requireNonNull(sessionListener, "sessionListener");
 144         requireNonNull(reconnectStrategy, "reconnectStrategy");
 145     }
 146
 147     @Override
 148     public final String toString() {
 149         return buildToStringHelper().toString();
 150     }
 151
 152     protected ToStringHelper buildToStringHelper() {
 153         return MoreObjects.toStringHelper(this)
 154                 .add("address", address)
 155                 .add("connectionTimeoutMillis", connectionTimeoutMillis)
 156                 .add("additionalHeader", additionalHeader)
 157                 .add("sessionListener", sessionListener)
 158                 .add("reconnectStrategy", reconnectStrategy)
 159                 .add("clientProtocol", clientProtocol)
 160                 .add("authHandler", authHandler)
 161                 .add("sslHandlerFactory", sslHandlerFactory);
 162     }
 163
 164     public enum NetconfClientProtocol {
 165         TCP, SSH, TLS
 166     }
 167 }