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.Timer;
15 import io.netty.util.concurrent.Promise;
16 import java.util.Optional;
18 import org.checkerframework.checker.index.qual.NonNegative;
19 import org.opendaylight.netconf.api.CapabilityURN;
20 import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
21 import org.opendaylight.netconf.api.messages.HelloMessage;
22 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
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;
33 public class NetconfClientSessionNegotiatorFactory
34 implements NetconfSessionNegotiatorFactory<NetconfClientSession, NetconfClientSessionListener> {
36 public static final Set<String> EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
38 CapabilityURN.BASE_1_1,
41 public static final Set<String> LEGACY_EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
45 public static final Set<String> DEFAULT_CLIENT_CAPABILITIES = ImmutableSet.of(
47 CapabilityURN.BASE_1_1);
49 public static final Set<String> LEGACY_FRAMING_CLIENT_CAPABILITIES = ImmutableSet.of(CapabilityURN.BASE);
51 private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiatorFactory.class);
52 private static final String START_EXI_MESSAGE_ID = "default-start-exi";
53 private static final EXIParameters DEFAULT_OPTIONS;
56 final FidelityOptions fidelity = FidelityOptions.createDefault();
58 fidelity.setFidelity(FidelityOptions.FEATURE_DTD, true);
59 fidelity.setFidelity(FidelityOptions.FEATURE_LEXICAL_VALUE, true);
60 fidelity.setFidelity(FidelityOptions.FEATURE_PREFIX, true);
61 } catch (UnsupportedOption e) {
62 LOG.warn("Failed to set fidelity options, continuing", e);
65 DEFAULT_OPTIONS = new EXIParameters(CodingMode.BYTE_PACKED, fidelity);
68 private final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader;
69 private final @NonNegative int maximumIncomingChunkSize;
70 private final Set<String> clientCapabilities;
71 private final long connectionTimeoutMillis;
72 private final Timer timer;
73 private final EXIParameters options;
75 public NetconfClientSessionNegotiatorFactory(final Timer timer,
76 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
77 final long connectionTimeoutMillis) {
78 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS);
81 public NetconfClientSessionNegotiatorFactory(final Timer timer,
82 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
83 final long connectionTimeoutMillis,
84 final @NonNegative int maximumIncomingChunkSize) {
85 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, EXI_CLIENT_CAPABILITIES,
86 maximumIncomingChunkSize);
89 public NetconfClientSessionNegotiatorFactory(final Timer timer,
90 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
91 final long connectionTimeoutMillis, final Set<String> capabilities) {
92 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, capabilities);
96 public NetconfClientSessionNegotiatorFactory(final Timer timer,
97 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
98 final long connectionTimeoutMillis, final EXIParameters exiOptions) {
99 this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, EXI_CLIENT_CAPABILITIES);
102 public NetconfClientSessionNegotiatorFactory(final Timer timer,
103 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
104 final long connectionTimeoutMillis, final EXIParameters exiOptions,
105 final Set<String> capabilities) {
106 this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, capabilities,
107 AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
110 public NetconfClientSessionNegotiatorFactory(final Timer timer,
111 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
112 final long connectionTimeoutMillis, final EXIParameters exiOptions,
113 final Set<String> capabilities,
114 final @NonNegative int maximumIncomingChunkSize) {
115 this.timer = requireNonNull(timer);
116 this.additionalHeader = additionalHeader;
117 this.connectionTimeoutMillis = connectionTimeoutMillis;
118 options = exiOptions;
119 clientCapabilities = capabilities;
120 this.maximumIncomingChunkSize = maximumIncomingChunkSize;
123 public long getConnectionTimeoutMillis() {
124 return connectionTimeoutMillis;
128 public NetconfClientSessionNegotiator getSessionNegotiator(
129 final NetconfSessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
130 final Channel channel, final Promise<NetconfClientSession> promise) {
131 return new NetconfClientSessionNegotiator(
132 HelloMessage.createClientHello(clientCapabilities, additionalHeader),
133 NetconfStartExiMessage.create(options, START_EXI_MESSAGE_ID), promise, channel, timer,
134 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis, maximumIncomingChunkSize);