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
   9 package org.opendaylight.netconf.client;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.siemens.ct.exi.CodingMode;
  15 import com.siemens.ct.exi.FidelityOptions;
  16 import com.siemens.ct.exi.exceptions.UnsupportedOption;
  17 import io.netty.channel.Channel;
  18 import io.netty.util.Timer;
  19 import io.netty.util.concurrent.Promise;
  20 import java.util.Set;
  21 import org.opendaylight.netconf.api.NetconfClientSessionPreferences;
  22 import org.opendaylight.netconf.api.NetconfDocumentedException;
  23 import org.opendaylight.netconf.api.NetconfMessage;
  24 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
  25 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  26 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  27 import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
  28 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessage;
  29 import org.opendaylight.protocol.framework.SessionListenerFactory;
  30 import org.opendaylight.protocol.framework.SessionNegotiator;
  31 import org.opendaylight.protocol.framework.SessionNegotiatorFactory;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 public class NetconfClientSessionNegotiatorFactory implements SessionNegotiatorFactory<NetconfMessage,
  36         NetconfClientSession, NetconfClientSessionListener> {
  37
  38     public static final Set<String> EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
  39             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  40             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1,
  41             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
  42
  43     public static final Set<String> LEGACY_EXI_CLIENT_CAPABILITIES = ImmutableSet.of(
  44             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  45             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_EXI_1_0);
  46
  47     public static final Set<String> DEFAULT_CLIENT_CAPABILITIES = ImmutableSet.of(
  48             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0,
  49             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1);
  50
  51     public static final Set<String> LEGACY_FRAMING_CLIENT_CAPABILITIES = ImmutableSet.of(
  52             XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_0);
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiatorFactory.class);
  55     private static final String START_EXI_MESSAGE_ID = "default-start-exi";
  56     private static final EXIParameters DEFAULT_OPTIONS;
  57
  58     private final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader;
  59     private final long connectionTimeoutMillis;
  60     private final Timer timer;
  61     private final EXIParameters options;
  62
  63     static {
  64         final FidelityOptions fidelity = FidelityOptions.createDefault();
  65         try {
  66             fidelity.setFidelity(FidelityOptions.FEATURE_DTD, true);
  67             fidelity.setFidelity(FidelityOptions.FEATURE_LEXICAL_VALUE, true);
  68             fidelity.setFidelity(FidelityOptions.FEATURE_PREFIX, true);
  69         } catch (UnsupportedOption e) {
  70             LOG.warn("Failed to set fidelity options, continuing", e);
  71         }
  72
  73         DEFAULT_OPTIONS = new EXIParameters(CodingMode.BYTE_PACKED, fidelity);
  74     }
  75
  76     private final Set<String> clientCapabilities;
  77
  78     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  79                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  80                                                  final long connectionTimeoutMillis) {
  81         this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS);
  82     }
  83
  84     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  85                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  86                                                  final long connectionTimeoutMillis, final Set<String> capabilities) {
  87         this(timer, additionalHeader, connectionTimeoutMillis, DEFAULT_OPTIONS, capabilities);
  88
  89     }
  90
  91     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  92                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  93                                                  final long connectionTimeoutMillis, final EXIParameters exiOptions) {
  94         this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, EXI_CLIENT_CAPABILITIES);
  95     }
  96
  97     public NetconfClientSessionNegotiatorFactory(final Timer timer,
  98                                                  final Optional<NetconfHelloMessageAdditionalHeader> additionalHeader,
  99                                                  final long connectionTimeoutMillis, final EXIParameters exiOptions,
 100                                                  final Set<String> capabilities) {
 101         this.timer = Preconditions.checkNotNull(timer);
 102         this.additionalHeader = additionalHeader;
 103         this.connectionTimeoutMillis = connectionTimeoutMillis;
 104         this.options = exiOptions;
 105         this.clientCapabilities = capabilities;
 106     }
 107
 108     @Override
 109     public SessionNegotiator<NetconfClientSession> getSessionNegotiator(
 110             final SessionListenerFactory<NetconfClientSessionListener> sessionListenerFactory,
 111             final Channel channel, final Promise<NetconfClientSession> promise) {
 112
 113         NetconfMessage startExiMessage = NetconfStartExiMessage.create(options, START_EXI_MESSAGE_ID);
 114         NetconfHelloMessage helloMessage = null;
 115         try {
 116             helloMessage = NetconfHelloMessage.createClientHello(clientCapabilities, additionalHeader);
 117         } catch (NetconfDocumentedException e) {
 118             LOG.error("Unable to create client hello message with capabilities {} and additional handler {}",
 119                     clientCapabilities, additionalHeader);
 120             throw new IllegalStateException(e);
 121         }
 122
 123         NetconfClientSessionPreferences proposal = new NetconfClientSessionPreferences(helloMessage, startExiMessage);
 124         return new NetconfClientSessionNegotiator(proposal, promise, channel, timer,
 125                 sessionListenerFactory.getSessionListener(), connectionTimeoutMillis);
 126     }
 127 }