netconf/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientSessionNegotiatorFactory.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 com.google.common.collect.ImmutableSet;
  13 import io.netty.channel.Channel;
  14 import io.netty.util.Timer;
  15 import io.netty.util.concurrent.Promise;
  16 import java.util.Optional;
  17 import java.util.Set;
  18 import org.checkerframework.checker.index.qual.NonNegative;
  19 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
  20 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
  21 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  22 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  23 import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
  24 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiatorFactory;
  25 import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
  26 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessage;
  27 import org.opendaylight.netconf.shaded.exificient.core.CodingMode;
  28 import org.opendaylight.netconf.shaded.exificient.core.FidelityOptions;
  29 import org.opendaylight.netconf.shaded.exificient.core.exceptions.UnsupportedOption;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public class NetconfClientSessionNegotiatorFactory
  34         implements NetconfSessionNegotiatorFactory<NetconfClientSession, NetconfClientSessionListener> {
  35
  36     public static final Set<String> EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
  37             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  38             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
  39             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
  40
  41     public static final Set<String> LEGACY_EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
  42             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  43             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
  44
  45     public static final Set<String> DEFAULT_CLIENT_CAPABILITIES = ImmutableSet.of(
  46             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  47             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
  48
  49     public static final Set<String> LEGACY_FRAMING_CLIENT_CAPABILITIES = ImmutableSet.of(
  50             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
  51
  52     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiatorFactory.class);
  53     private static final String START_EXI_MESSAGE_ID = "default-start-exi";
  54     private static final EXIParameters DEFAULT_OPTIONS;
  55
  56     static {
  57         final FidelityOptions fidelity = FidelityOptions.createDefault();
  58         try {
  59             fidelity.setFidelity(FidelityOptions.FEATURE_DTD, true);
  60             fidelity.setFidelity(FidelityOptions.FEATURE_LEXICAL_VALUE, true);
  61             fidelity.setFidelity(FidelityOptions.FEATURE_PREFIX, true);
  62         } catch (UnsupportedOption e) {
  63             LOG.warn("Failed to set fidelity options, continuing", e);
  64         }
  65
  66         DEFAULT_OPTIONS = new EXIParameters(CodingMode.BYTE_PACKED, fidelity);
  67     }
  68
  69     private final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader;
  70     private final @NonNegative int maximumIncomingChunkSize;
  71     private final Set<String> clientCapabilities;
  72     private final long connectionTimeoutMillis;
  73     private final Timer timer;
  74     private final EXIParameters options;
  75
  76     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  77                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  78                                                  final long connectionTimeoutMillis) {
  79         this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS);
  80     }
  81
  82     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  83                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  84                                                  final long connectionTimeoutMillis,
  85                                                  final @NonNegative int maximumIncomingChunkSize) {
  86         this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, EXI_CLIENT_CAPABILITIES,
  87             maximumIncomingChunkSize);
  88     }
  89
  90     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  91                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  92                                                  final long connectionTimeoutMillis, final Set<String> capabilities) {
  93         this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, capabilities);
  94
  95     }
  96
  97     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  98                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  99                                                  final long connectionTimeoutMillis, final EXIParameters exiOptions) {
 100         this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, EXI_CLIENT_CAPABILITIES);
 101     }
 102
 103     public NetconfClientSessionNegotiatorFactory(final Timer timer,
 104                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
 105                                                  final long connectionTimeoutMillis, final EXIParameters exiOptions,
 106                                                  final Set<String> capabilities) {
 107         this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, capabilities,
 108             AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
 109     }
 110
 111     public NetconfClientSessionNegotiatorFactory(final Timer timer,
 112                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
 113                                                  final long connectionTimeoutMillis, final EXIParameters exiOptions,
 114                                                  final Set<String> capabilities,
 115                                                  final @NonNegative int maximumIncomingChunkSize) {
 116         this.timer = requireNonNull(timer);
 117         this.additionalHeader = additionalHeader;
 118         this.connectionTimeoutMillis = connectionTimeoutMillis;
 119         options = exiOptions;
 120         clientCapabilities = capabilities;
 121         this.maximumIncomingChunkSize = maximumIncomingChunkSize;
 122     }
 123
 124     public long getConnectionTimeoutMillis() {
 125         return connectionTimeoutMillis;
 126     }
 127
 128     @Override
 129     public NetconfClientSessionNegotiator getSessionNegotiator(
 130             final NetconfSessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
 131             final Channel channel, final Promise<NetconfClientSession> promise) {
 132         return new NetconfClientSessionNegotiator(
 133             NetconfHelloMessage.createClientHello(clientCapabilities, additionalHeader),
 134             NetconfStartExiMessage.create(options, START_EXI_MESSAGE_ID), promise, channel, timer,
 135                 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis, maximumIncomingChunkSize);
 136     }
 137 }