protocol/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.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     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientConfiguration.class);
  29
  30     private final NetconfClientProtocol clientProtocol;
  31     private final InetSocketAddress address;
  32     private final Long connectionTimeoutMillis;
  33
  34     private final NetconfHelloMessageAdditionalHeader additionalHeader;
  35     private final NetconfClientSessionListener sessionListener;
  36
  37     private final AuthenticationHandler authHandler;
  38     private final SslHandlerFactory sslHandlerFactory;
  39     private final NetconfSshClient sshClient;
  40
  41     private final List<Uri> odlHelloCapabilities;
  42     private final @NonNegative int maximumIncomingChunkSize;
  43     private final String name;
  44
  45     NetconfClientConfiguration(final NetconfClientProtocol protocol, final InetSocketAddress address,
  46                                final Long connectionTimeoutMillis,
  47                                final NetconfHelloMessageAdditionalHeader additionalHeader,
  48                                final NetconfClientSessionListener sessionListener,
  49                                final AuthenticationHandler authHandler,
  50                                final SslHandlerFactory sslHandlerFactory, final NetconfSshClient sshClient,
  51                                final List<Uri> odlHelloCapabilities, final @NonNegative int maximumIncomingChunkSize,
  52                                final String name) {
  53         this.address = address;
  54         this.connectionTimeoutMillis = connectionTimeoutMillis;
  55         this.additionalHeader = additionalHeader;
  56         this.sessionListener = sessionListener;
  57         clientProtocol = protocol;
  58         this.authHandler = authHandler;
  59         this.sslHandlerFactory = sslHandlerFactory;
  60         this.sshClient = sshClient;
  61         this.odlHelloCapabilities = odlHelloCapabilities;
  62         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
  63         this.name = name;
  64         validateConfiguration();
  65     }
  66
  67     public final String getName() {
  68         return name;
  69     }
  70
  71     public final InetSocketAddress getAddress() {
  72         return address;
  73     }
  74
  75     public final Long getConnectionTimeoutMillis() {
  76         return connectionTimeoutMillis;
  77     }
  78
  79     public final Optional<NetconfHelloMessageAdditionalHeader> getAdditionalHeader() {
  80         return Optional.ofNullable(additionalHeader);
  81     }
  82
  83     public final NetconfClientSessionListener getSessionListener() {
  84         return sessionListener;
  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     public @NonNegative int getMaximumIncomingChunkSize() {
 108         return maximumIncomingChunkSize;
 109     }
 110
 111     private void validateConfiguration() {
 112         switch (requireNonNull(clientProtocol)) {
 113             case TLS:
 114                 validateTlsConfiguration();
 115                 validateTcpConfiguration();
 116                 break;
 117             case SSH:
 118                 validateSshConfiguration();
 119                 validateTcpConfiguration();
 120                 break;
 121             case TCP:
 122                 validateTcpConfiguration();
 123                 break;
 124             default:
 125                 LOG.warn("Unexpected protocol: {} in netconf client configuration.", clientProtocol);
 126         }
 127     }
 128
 129     protected final void validateTlsConfiguration() {
 130         requireNonNull(sslHandlerFactory, "sslHandlerFactory");
 131     }
 132
 133     protected final void validateSshConfiguration() {
 134         requireNonNull(authHandler, "authHandler");
 135     }
 136
 137     protected final void validateTcpConfiguration() {
 138         requireNonNull(address, "address");
 139         requireNonNull(clientProtocol, "clientProtocol");
 140         requireNonNull(connectionTimeoutMillis, "connectionTimeoutMillis");
 141         requireNonNull(sessionListener, "sessionListener");
 142     }
 143
 144     @Override
 145     public final String toString() {
 146         return buildToStringHelper().toString();
 147     }
 148
 149     protected ToStringHelper buildToStringHelper() {
 150         return MoreObjects.toStringHelper(this)
 151                 .add("address", address)
 152                 .add("connectionTimeoutMillis", connectionTimeoutMillis)
 153                 .add("additionalHeader", additionalHeader)
 154                 .add("sessionListener", sessionListener)
 155                 .add("clientProtocol", clientProtocol)
 156                 .add("authHandler", authHandler)
 157                 .add("sslHandlerFactory", sslHandlerFactory);
 158     }
 159
 160     public enum NetconfClientProtocol {
 161         TCP, SSH, TLS
 162     }
 163 }