netconf/netconf-client/src/main/java/org/opendaylight/netconf/client/NetconfClientSessionNegotiator.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.Strings;
  12 import com.google.common.collect.ImmutableSet;
  13 import com.google.common.collect.Interner;
  14 import com.google.common.collect.Interners;
  15 import io.netty.channel.Channel;
  16 import io.netty.channel.ChannelFuture;
  17 import io.netty.channel.ChannelFutureListener;
  18 import io.netty.channel.ChannelHandlerContext;
  19 import io.netty.channel.ChannelInboundHandlerAdapter;
  20 import io.netty.util.Timer;
  21 import io.netty.util.concurrent.Promise;
  22 import java.util.Set;
  23 import javax.xml.xpath.XPathConstants;
  24 import javax.xml.xpath.XPathExpression;
  25 import org.opendaylight.controller.config.util.xml.XmlUtil;
  26 import org.opendaylight.netconf.api.NetconfClientSessionPreferences;
  27 import org.opendaylight.netconf.api.NetconfDocumentedException;
  28 import org.opendaylight.netconf.api.NetconfMessage;
  29 import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
  30 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
  31 import org.opendaylight.netconf.nettyutil.AbstractChannelInitializer;
  32 import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
  33 import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessage;
  34 import org.opendaylight.netconf.util.messages.NetconfMessageUtil;
  35 import org.opendaylight.netconf.util.xml.XMLNetconfUtil;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38 import org.w3c.dom.Document;
  39 import org.w3c.dom.Node;
  40 import org.w3c.dom.NodeList;
  41
  42 public class NetconfClientSessionNegotiator extends
  43         AbstractNetconfSessionNegotiator<NetconfClientSessionPreferences, NetconfClientSession,
  44                 NetconfClientSessionListener> {
  45     private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiator.class);
  46
  47     private static final XPathExpression SESSION_ID_X_PATH = XMLNetconfUtil
  48             .compileXPath("/netconf:hello/netconf:session-id");
  49
  50     private static final XPathExpression SESSION_ID_X_PATH_NO_NAMESPACE = XMLNetconfUtil
  51             .compileXPath("/hello/session-id");
  52
  53     private static final String EXI_1_0_CAPABILITY_MARKER = "exi:1.0";
  54
  55     private static final Interner<Set<String>> INTERNER = Interners.newWeakInterner();
  56
  57     protected NetconfClientSessionNegotiator(final NetconfClientSessionPreferences sessionPreferences,
  58                                              final Promise<NetconfClientSession> promise,
  59                                              final Channel channel,
  60                                              final Timer timer,
  61                                              final NetconfClientSessionListener sessionListener,
  62                                              final long connectionTimeoutMillis) {
  63         super(sessionPreferences, promise, channel, timer, sessionListener, connectionTimeoutMillis);
  64     }
  65
  66     @Override
  67     protected void handleMessage(final NetconfHelloMessage netconfMessage) throws NetconfDocumentedException {
  68         final NetconfClientSession session = getSessionForHelloMessage(netconfMessage);
  69         replaceHelloMessageInboundHandler(session);
  70
  71         // If exi should be used, try to initiate exi communication
  72         // Call negotiationSuccessFul after exi negotiation is finished successfully or not
  73         if (shouldUseExi(netconfMessage)) {
  74             LOG.debug("Netconf session {} should use exi.", session);
  75             NetconfStartExiMessage startExiMessage = (NetconfStartExiMessage) sessionPreferences.getStartExiMessage();
  76             tryToInitiateExi(session, startExiMessage);
  77         } else {
  78             // Exi is not supported, release session immediately
  79             LOG.debug("Netconf session {} isn't capable of using exi.", session);
  80             negotiationSuccessful(session);
  81         }
  82     }
  83
  84     /**
  85      * Initiates exi communication by sending start-exi message and waiting for positive/negative response.
  86      *
  87      * @param startExiMessage Exi message for initilization of exi communication.
  88      */
  89     void tryToInitiateExi(final NetconfClientSession session, final NetconfStartExiMessage startExiMessage) {
  90         channel.pipeline().addAfter(AbstractChannelInitializer.NETCONF_MESSAGE_DECODER,
  91                 ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER,
  92                 new ExiConfirmationInboundHandler(session, startExiMessage));
  93
  94         session.sendMessage(startExiMessage).addListener(new ChannelFutureListener() {
  95             @Override
  96             public void operationComplete(final ChannelFuture channelFuture) {
  97                 if (!channelFuture.isSuccess()) {
  98                     LOG.warn("Failed to send start-exi message {} on session {}", startExiMessage, this,
  99                             channelFuture.cause());
 100                     channel.pipeline().remove(ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER);
 101                 } else {
 102                     LOG.trace("Start-exi message {} sent to socket on session {}", startExiMessage, this);
 103                 }
 104             }
 105         });
 106     }
 107
 108     private boolean shouldUseExi(final NetconfHelloMessage helloMsg) {
 109         return containsExi10Capability(helloMsg.getDocument())
 110                 && containsExi10Capability(sessionPreferences.getHelloMessage().getDocument());
 111     }
 112
 113     private static boolean containsExi10Capability(final Document doc) {
 114         final NodeList nList = doc.getElementsByTagName(XmlNetconfConstants.CAPABILITY);
 115         for (int i = 0; i < nList.getLength(); i++) {
 116             if (nList.item(i).getTextContent().contains(EXI_1_0_CAPABILITY_MARKER)) {
 117                 return true;
 118             }
 119         }
 120         return false;
 121     }
 122
 123     private static long extractSessionId(final Document doc) {
 124         String textContent = getSessionIdWithXPath(doc, SESSION_ID_X_PATH);
 125         if (Strings.isNullOrEmpty(textContent)) {
 126             textContent = getSessionIdWithXPath(doc, SESSION_ID_X_PATH_NO_NAMESPACE);
 127             if (Strings.isNullOrEmpty(textContent)) {
 128                 throw new IllegalStateException("Session id not received from server, hello message: " + XmlUtil
 129                         .toString(doc));
 130             }
 131         }
 132
 133         return Long.valueOf(textContent);
 134     }
 135
 136     private static String getSessionIdWithXPath(final Document doc, final XPathExpression sessionIdXPath) {
 137         final Node sessionIdNode = (Node) XmlUtil.evaluateXPath(sessionIdXPath, doc, XPathConstants.NODE);
 138         return sessionIdNode != null ? sessionIdNode.getTextContent() : null;
 139     }
 140
 141     @Override
 142     protected NetconfClientSession getSession(final NetconfClientSessionListener sessionListener, final Channel channel,
 143                                               final NetconfHelloMessage message) throws NetconfDocumentedException {
 144         final long sessionId = extractSessionId(message.getDocument());
 145
 146         // Copy here is important: it disconnects the strings from the document
 147         Set<String> capabilities = ImmutableSet.copyOf(NetconfMessageUtil.extractCapabilitiesFromHello(message
 148                 .getDocument()));
 149
 150         capabilities = INTERNER.intern(capabilities);
 151
 152         return new NetconfClientSession(sessionListener, channel, sessionId, capabilities);
 153     }
 154
 155     /**
 156      * Handler to process response for start-exi message.
 157      */
 158     private final class ExiConfirmationInboundHandler extends ChannelInboundHandlerAdapter {
 159         private static final String EXI_CONFIRMED_HANDLER = "exiConfirmedHandler";
 160
 161         private final NetconfClientSession session;
 162         private final NetconfStartExiMessage startExiMessage;
 163
 164         ExiConfirmationInboundHandler(final NetconfClientSession session,
 165                                       final NetconfStartExiMessage startExiMessage) {
 166             this.session = session;
 167             this.startExiMessage = startExiMessage;
 168         }
 169
 170         @SuppressWarnings("checkstyle:IllegalCatch")
 171         @Override
 172         public void channelRead(final ChannelHandlerContext ctx, final Object msg) throws Exception {
 173             ctx.pipeline().remove(ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER);
 174
 175             NetconfMessage netconfMessage = (NetconfMessage) msg;
 176
 177             // Ok response to start-exi, try to add exi handlers
 178             if (NetconfMessageUtil.isOKMessage(netconfMessage)) {
 179                 LOG.trace("Positive response on start-exi call received on session {}", session);
 180                 try {
 181                     session.startExiCommunication(startExiMessage);
 182                 } catch (RuntimeException e) {
 183                     // Unable to add exi, continue without exi
 184                     LOG.warn("Unable to start exi communication, Communication will continue without exi on session "
 185                             + "{}", session, e);
 186                 }
 187
 188                 // Error response
 189             } else if (NetconfMessageUtil.isErrorMessage(netconfMessage)) {
 190                 LOG.warn(
 191                         "Error response to start-exi message {}, Communication will continue without exi on session {}",
 192                         netconfMessage, session);
 193
 194                 // Unexpected response to start-exi, throwing message away, continue without exi
 195             } else {
 196                 LOG.warn("Unexpected response to start-exi message, should be ok, was {}, "
 197                         + "Communication will continue without exi "
 198                         + "and response message will be thrown away on session {}",
 199                         netconfMessage, session);
 200             }
 201
 202             negotiationSuccessful(session);
 203         }
 204     }
 205
 206 }