2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.client;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.collect.ImmutableSet;
13 import io.netty.channel.Channel;
14 import io.netty.util.concurrent.Promise;
15 import java.util.Optional;
17 import org.checkerframework.checker.index.qual.NonNegative;
18 import org.opendaylight.netconf.api.CapabilityURN;
19 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
20 import org.opendaylight.netconf.api.messages.HelloMessage;
21 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
22 import org.opendaylight.netconf.common.NetconfTimer;
23 import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
24 import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
25 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessageProvider;
26 import org.opendaylight.netconf.shaded.exificient.core.CodingMode;
27 import org.opendaylight.netconf.shaded.exificient.core.FidelityOptions;
28 import org.opendaylight.netconf.shaded.exificient.core.exceptions.UnsupportedOption;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
32 public final class NetconfClientSessionNegotiatorFactory {
33 public static final Set<String> EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
35 CapabilityURN.BASE_1_1,
38 public static final Set<String> LEGACY_EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
42 public static final Set<String> DEFAULT_CLIENT_CAPABILITIES = ImmutableSet.of(
44 CapabilityURN.BASE_1_1);
46 public static final Set<String> LEGACY_FRAMING_CLIENT_CAPABILITIES = ImmutableSet.of(CapabilityURN.BASE);
48 private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiatorFactory.class);
49 private static final String START_EXI_MESSAGE_ID = "default-start-exi";
50 private static final EXIParameters DEFAULT_OPTIONS;
53 final FidelityOptions fidelity = FidelityOptions.createDefault();
55 fidelity.setFidelity(FidelityOptions.FEATURE_DTD, true);
56 fidelity.setFidelity(FidelityOptions.FEATURE_LEXICAL_VALUE, true);
57 fidelity.setFidelity(FidelityOptions.FEATURE_PREFIX, true);
58 } catch (UnsupportedOption e) {
59 LOG.warn("Failed to set fidelity options, continuing", e);
62 DEFAULT_OPTIONS = new EXIParameters(CodingMode.BYTE_PACKED, fidelity);
65 private final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader;
66 private final @NonNegative int maximumIncomingChunkSize;
67 private final Set<String> clientCapabilities;
68 private final long connectionTimeoutMillis;
69 private final NetconfTimer timer;
70 private final EXIParameters options;
72 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
73 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
74 final long connectionTimeoutMillis) {
75 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS);
78 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
79 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
80 final long connectionTimeoutMillis,
81 final @NonNegative int maximumIncomingChunkSize) {
82 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, EXI_CLIENT_CAPABILITIES,
83 maximumIncomingChunkSize);
86 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
87 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
88 final long connectionTimeoutMillis, final Set<String> capabilities) {
89 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, capabilities);
93 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
94 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
95 final long connectionTimeoutMillis, final EXIParameters exiOptions) {
96 this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, EXI_CLIENT_CAPABILITIES);
99 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
100 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
101 final long connectionTimeoutMillis, final EXIParameters exiOptions,
102 final Set<String> capabilities) {
103 this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, capabilities,
104 NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
107 public NetconfClientSessionNegotiatorFactory(final NetconfTimer timer,
108 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
109 final long connectionTimeoutMillis, final EXIParameters exiOptions,
110 final Set<String> capabilities,
111 final @NonNegative int maximumIncomingChunkSize) {
112 this.timer = requireNonNull(timer);
113 this.additionalHeader = additionalHeader;
114 this.connectionTimeoutMillis = connectionTimeoutMillis;
115 options = exiOptions;
116 clientCapabilities = capabilities;
117 this.maximumIncomingChunkSize = maximumIncomingChunkSize;
120 public long getConnectionTimeoutMillis() {
121 return connectionTimeoutMillis;
125 * Create a new negotiator attached to a channel, which will notify
126 * a promise once the negotiation completes.
128 * @param channel Underlying channel
129 * @param promise Promise to be notified
130 * @return new negotiator instance
132 public NetconfClientSessionNegotiator getSessionNegotiator(
133 final NetconfSessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
134 final Channel channel, final Promise<NetconfClientSession> promise) {
135 return new NetconfClientSessionNegotiator(
136 HelloMessage.createClientHello(clientCapabilities, additionalHeader),
137 NetconfStartExiMessageProvider.create(options, START_EXI_MESSAGE_ID), promise, channel, timer,
138 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis, maximumIncomingChunkSize);