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         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     @Deprecated(forRemoval = true)
  83     public final ReconnectStrategy getReconnectStrategy() {
  84         return reconnectStrategy;
  85     }
  86
  87     public final AuthenticationHandler getAuthHandler() {
  88         return authHandler;
  89     }
  90
  91     public NetconfClientProtocol getProtocol() {
  92         return clientProtocol;
  93     }
  94
  95     public SslHandlerFactory getSslHandlerFactory() {
  96         return sslHandlerFactory;
  97     }
  98
  99     public NetconfSshClient getSshClient() {
 100         return sshClient;
 101     }
 102
 103     public List<Uri> getOdlHelloCapabilities() {
 104         return odlHelloCapabilities;
 105     }
 106
 107     private void validateConfiguration() {
 108         switch (requireNonNull(clientProtocol)) {
 109             case TLS:
 110                 validateTlsConfiguration();
 111                 validateTcpConfiguration();
 112                 break;
 113             case SSH:
 114                 validateSshConfiguration();
 115                 validateTcpConfiguration();
 116                 break;
 117             case TCP:
 118                 validateTcpConfiguration();
 119                 break;
 120             default:
 121                 LOG.warn("Unexpected protocol: {} in netconf client configuration.", clientProtocol);
 122         }
 123     }
 124
 125     protected final void validateTlsConfiguration() {
 126         requireNonNull(sslHandlerFactory, "sslHandlerFactory");
 127     }
 128
 129     protected final void validateSshConfiguration() {
 130         requireNonNull(authHandler, "authHandler");
 131     }
 132
 133     protected final void validateTcpConfiguration() {
 134         requireNonNull(address, "address");
 135         requireNonNull(clientProtocol, "clientProtocol");
 136         requireNonNull(connectionTimeoutMillis, "connectionTimeoutMillis");
 137         requireNonNull(sessionListener, "sessionListener");
 138         requireNonNull(reconnectStrategy, "reconnectStrategy");
 139     }
 140
 141     @Override
 142     public final String toString() {
 143         return buildToStringHelper().toString();
 144     }
 145
 146     protected ToStringHelper buildToStringHelper() {
 147         return MoreObjects.toStringHelper(this)
 148                 .add("address", address)
 149                 .add("connectionTimeoutMillis", connectionTimeoutMillis)
 150                 .add("additionalHeader", additionalHeader)
 151                 .add("sessionListener", sessionListener)
 152                 .add("reconnectStrategy", reconnectStrategy)
 153                 .add("clientProtocol", clientProtocol)
 154                 .add("authHandler", authHandler)
 155                 .add("sslHandlerFactory", sslHandlerFactory);
 156     }
 157
 158     public enum NetconfClientProtocol {
 159         TCP, SSH, TLS
 160     }
 161 }