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.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  18 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  19 import org.opendaylight.netconf.client.SslHandlerFactory;
  20 import org.opendaylight.netconf.nettyutil.ReconnectStrategy;
  21 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
  22 import org.opendaylight.netconf.nettyutil.handler.ssh.client.NetconfSshClient;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 public class NetconfClientConfiguration {
  28
  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
  46     NetconfClientConfiguration(final NetconfClientProtocol protocol, final InetSocketAddress address,
  47                                final Long connectionTimeoutMillis,
  48                                final NetconfHelloMessageAdditionalHeader additionalHeader,
  49                                final NetconfClientSessionListener sessionListener,
  50                                final ReconnectStrategy reconnectStrategy, final AuthenticationHandler authHandler,
  51                                final SslHandlerFactory sslHandlerFactory, final NetconfSshClient sshClient,
  52                                final List<Uri> odlHelloCapabilities) {
  53         this.address = address;
  54         this.connectionTimeoutMillis = connectionTimeoutMillis;
  55         this.additionalHeader = additionalHeader;
  56         this.sessionListener = sessionListener;
  57         this.clientProtocol = protocol;
  58         this.reconnectStrategy = reconnectStrategy;
  59         this.authHandler = authHandler;
  60         this.sslHandlerFactory = sslHandlerFactory;
  61         this.sshClient = sshClient;
  62         this.odlHelloCapabilities = odlHelloCapabilities;
  63         validateConfiguration();
  64     }
  65
  66     public final InetSocketAddress getAddress() {
  67         return address;
  68     }
  69
  70     public final Long getConnectionTimeoutMillis() {
  71         return connectionTimeoutMillis;
  72     }
  73
  74     public final Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
  75         return Optional.ofNullable(additionalHeader);
  76     }
  77
  78     public final NetconfClientSessionListener getSessionListener() {
  79         return sessionListener;
  80     }
  81
  82     public final ReconnectStrategy getReconnectStrategy() {
  83         return reconnectStrategy;
  84     }
  85
  86     public final AuthenticationHandler getAuthHandler() {
  87         return authHandler;
  88     }
  89
  90     public NetconfClientProtocol getProtocol() {
  91         return clientProtocol;
  92     }
  93
  94     public SslHandlerFactory getSslHandlerFactory() {
  95         return sslHandlerFactory;
  96     }
  97
  98     public NetconfSshClient getSshClient() {
  99         return sshClient;
 100     }
 101
 102     public List<Uri> getOdlHelloCapabilities() {
 103         return odlHelloCapabilities;
 104     }
 105
 106     private void validateConfiguration() {
 107         switch (requireNonNull(clientProtocol)) {
 108             case TLS:
 109                 validateTlsConfiguration();
 110                 validateTcpConfiguration();
 111                 break;
 112             case SSH:
 113                 validateSshConfiguration();
 114                 validateTcpConfiguration();
 115                 break;
 116             case TCP:
 117                 validateTcpConfiguration();
 118                 break;
 119             default:
 120                 LOG.warn("Unexpected protocol: {} in netconf client configuration.", clientProtocol);
 121         }
 122     }
 123
 124     protected void validateTlsConfiguration() {
 125         requireNonNull(sslHandlerFactory, "sslHandlerFactory");
 126     }
 127
 128     protected void validateSshConfiguration() {
 129         requireNonNull(authHandler, "authHandler");
 130     }
 131
 132     protected void validateTcpConfiguration() {
 133         requireNonNull(address, "address");
 134         requireNonNull(clientProtocol, "clientProtocol");
 135         requireNonNull(connectionTimeoutMillis, "connectionTimeoutMillis");
 136         requireNonNull(sessionListener, "sessionListener");
 137         requireNonNull(reconnectStrategy, "reconnectStrategy");
 138     }
 139
 140     @Override
 141     public final String toString() {
 142         return buildToStringHelper().toString();
 143     }
 144
 145     protected ToStringHelper buildToStringHelper() {
 146         return MoreObjects.toStringHelper(this)
 147                 .add("address", address)
 148                 .add("connectionTimeoutMillis", connectionTimeoutMillis)
 149                 .add("additionalHeader", additionalHeader)
 150                 .add("sessionListener", sessionListener)
 151                 .add("reconnectStrategy", reconnectStrategy)
 152                 .add("clientProtocol", clientProtocol)
 153                 .add("authHandler", authHandler)
 154                 .add("sslHandlerFactory", sslHandlerFactory);
 155     }
 156
 157     public enum NetconfClientProtocol {
 158         TCP, SSH, TLS
 159     }
 160 }