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.base.Optional;
13 import com.google.common.collect.ImmutableSet;
14 import com.siemens.ct.exi.core.CodingMode;
15 import com.siemens.ct.exi.core.FidelityOptions;
16 import com.siemens.ct.exi.core.exceptions.UnsupportedOption;
17 import io.netty.channel.Channel;
18 import io.netty.util.Timer;
19 import io.netty.util.concurrent.Promise;
21 import org.opendaylight.netconf.api.NetconfClientSessionPreferences;
22 import org.opendaylight.netconf.api.NetconfMessage;
23 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
24 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
25 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
26 import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
27 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessage;
28 import org.opendaylight.protocol.framework.SessionListenerFactory;
29 import org.opendaylight.protocol.framework.SessionNegotiator;
30 import org.opendaylight.protocol.framework.SessionNegotiatorFactory;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
34 public class NetconfClientSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfMessage,
35 NetconfClientSession, NetconfClientSessionListener> {
37 public static final Set<String> EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
38 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
39 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
40 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
42 public static final Set<String> LEGACY_EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
43 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
44 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
46 public static final Set<String> DEFAULT_CLIENT_CAPABILITIES = ImmutableSet.of(
47 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
48 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
50 public static final Set<String> LEGACY_FRAMING_CLIENT_CAPABILITIES = ImmutableSet.of(
51 XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
53 private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiatorFactory.class);
54 private static final String START_EXI_MESSAGE_ID = "default-start-exi";
55 private static final EXIParameters DEFAULT_OPTIONS;
58 final FidelityOptions fidelity = FidelityOptions.createDefault();
60 fidelity.setFidelity(FidelityOptions.FEATURE_DTD, true);
61 fidelity.setFidelity(FidelityOptions.FEATURE_LEXICAL_VALUE, true);
62 fidelity.setFidelity(FidelityOptions.FEATURE_PREFIX, true);
63 } catch (UnsupportedOption e) {
64 LOG.warn("Failed to set fidelity options, continuing", e);
67 DEFAULT_OPTIONS = new EXIParameters(CodingMode.BYTE_PACKED, fidelity);
70 private final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader;
71 private final Set<String> clientCapabilities;
72 private final long connectionTimeoutMillis;
73 private final Timer timer;
74 private final EXIParameters options;
76 public NetconfClientSessionNegotiatorFactory(final Timer timer,
77 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
78 final long connectionTimeoutMillis) {
79 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS);
82 public NetconfClientSessionNegotiatorFactory(final Timer timer,
83 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
84 final long connectionTimeoutMillis, final Set<String> capabilities) {
85 this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, capabilities);
89 public NetconfClientSessionNegotiatorFactory(final Timer timer,
90 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
91 final long connectionTimeoutMillis, final EXIParameters exiOptions) {
92 this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, EXI_CLIENT_CAPABILITIES);
95 public NetconfClientSessionNegotiatorFactory(final Timer timer,
96 final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
97 final long connectionTimeoutMillis, final EXIParameters exiOptions,
98 final Set<String> capabilities) {
99 this.timer = requireNonNull(timer);
100 this.additionalHeader = additionalHeader;
101 this.connectionTimeoutMillis = connectionTimeoutMillis;
102 this.options = exiOptions;
103 this.clientCapabilities = capabilities;
107 public SessionNegotiator<NetconfClientSession> getSessionNegotiator(
108 final SessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
109 final Channel channel, final Promise<NetconfClientSession> promise) {
111 NetconfMessage startExiMessage = NetconfStartExiMessage.create(options, START_EXI_MESSAGE_ID);
112 NetconfHelloMessage helloMessage = NetconfHelloMessage.createClientHello(clientCapabilities, additionalHeader);
114 NetconfClientSessionPreferences proposal = new NetconfClientSessionPreferences(helloMessage, startExiMessage);
115 return new NetconfClientSessionNegotiator(proposal, promise, channel, timer,
116 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis);