X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-client%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Fclient%2FNetconfClientSessionNegotiator.java;h=cbbee1f65508353b117bbd21db22b523b4244694;hp=3c2e814d899aea8c170795106b786e26063b6871;hb=3c2b9f44d59d735907ef541d36542443221c5c68;hpb=e7291930e152c05262b85f0acdf8c3907f89ec7e diff --git a/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/NetconfClientSessionNegotiator.java b/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/NetconfClientSessionNegotiator.java index 3c2e814d89..cbbee1f655 100644 --- a/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/NetconfClientSessionNegotiator.java +++ b/opendaylight/netconf/netconf-client/src/main/java/org/opendaylight/controller/netconf/client/NetconfClientSessionNegotiator.java @@ -8,60 +8,117 @@ package org.opendaylight.controller.netconf.client; +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; + import io.netty.channel.Channel; +import io.netty.channel.ChannelFuture; +import io.netty.channel.ChannelFutureListener; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInboundHandlerAdapter; import io.netty.util.Timer; import io.netty.util.concurrent.Promise; import java.util.Collection; -import java.util.List; -import javax.annotation.Nullable; import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathExpression; +import org.opendaylight.controller.netconf.api.NetconfClientSessionPreferences; +import org.opendaylight.controller.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.api.NetconfMessage; -import org.opendaylight.controller.netconf.api.NetconfSessionPreferences; -import org.opendaylight.controller.netconf.util.AbstractNetconfSessionNegotiator; +import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants; +import org.opendaylight.controller.netconf.nettyutil.AbstractChannelInitializer; +import org.opendaylight.controller.netconf.nettyutil.AbstractNetconfSessionNegotiator; +import org.opendaylight.controller.netconf.nettyutil.handler.exi.NetconfStartExiMessage; +import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage; +import org.opendaylight.controller.netconf.util.messages.NetconfMessageUtil; import org.opendaylight.controller.netconf.util.xml.XMLNetconfUtil; -import org.opendaylight.controller.netconf.util.xml.XmlElement; -import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants; import org.opendaylight.controller.netconf.util.xml.XmlUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Node; - -import com.google.common.base.Function; -import com.google.common.collect.Collections2; +import org.w3c.dom.NodeList; public class NetconfClientSessionNegotiator extends - AbstractNetconfSessionNegotiator { + AbstractNetconfSessionNegotiator +{ + private static final Logger logger = LoggerFactory.getLogger(NetconfClientSessionNegotiator.class); + + private static final XPathExpression sessionIdXPath = XMLNetconfUtil + .compileXPath("/netconf:hello/netconf:session-id"); - protected NetconfClientSessionNegotiator(NetconfSessionPreferences sessionPreferences, - Promise promise, Channel channel, Timer timer, NetconfClientSessionListener sessionListener, - long connectionTimeoutMillis) { + private static final String EXI_1_0_CAPABILITY_MARKER = "exi:1.0"; + + protected NetconfClientSessionNegotiator(final NetconfClientSessionPreferences sessionPreferences, + final Promise promise, + final Channel channel, + final Timer timer, + final NetconfClientSessionListener sessionListener, + final long connectionTimeoutMillis) { super(sessionPreferences, promise, channel, timer, sessionListener, connectionTimeoutMillis); } - private static Collection getCapabilities(Document doc) { - XmlElement responseElement = XmlElement.fromDomDocument(doc); - XmlElement capabilitiesElement = responseElement - .getOnlyChildElementWithSameNamespace(XmlNetconfConstants.CAPABILITIES); - List caps = capabilitiesElement.getChildElements(XmlNetconfConstants.CAPABILITY); - return Collections2.transform(caps, new Function() { + @Override + protected void handleMessage(final NetconfHelloMessage netconfMessage) throws NetconfDocumentedException { + final NetconfClientSession session = getSessionForHelloMessage(netconfMessage); + replaceHelloMessageInboundHandler(session); - @Nullable + // If exi should be used, try to initiate exi communication + // Call negotiationSuccessFul after exi negotiation is finished successfully or not + if (shouldUseExi(netconfMessage)) { + logger.debug("Netconf session {} should use exi.", session); + NetconfStartExiMessage startExiMessage = (NetconfStartExiMessage) sessionPreferences.getStartExiMessage(); + tryToInitiateExi(session, startExiMessage); + } else { + // Exi is not supported, release session immediately + logger.debug("Netconf session {} isn't capable of using exi.", session); + negotiationSuccessful(session); + } + } + + /** + * Initiates exi communication by sending start-exi message and waiting for positive/negative response. + * + * @param startExiMessage + */ + void tryToInitiateExi(final NetconfClientSession session, final NetconfStartExiMessage startExiMessage) { + channel.pipeline().addAfter(AbstractChannelInitializer.NETCONF_MESSAGE_DECODER, + ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER, + new ExiConfirmationInboundHandler(session, startExiMessage)); + + session.sendMessage(startExiMessage).addListener(new ChannelFutureListener() { @Override - public String apply(@Nullable XmlElement input) { - // Trim possible leading/tailing whitespace - return input.getTextContent().trim(); + public void operationComplete(final ChannelFuture f) { + if (!f.isSuccess()) { + logger.warn("Failed to send start-exi message {} on session {}", startExiMessage, this, f.cause()); + channel.pipeline().remove(ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER); + } else { + logger.trace("Start-exi message {} sent to socket on session {}", startExiMessage, this); + } } }); } - private static final XPathExpression sessionIdXPath = XMLNetconfUtil - .compileXPath("/netconf:hello/netconf:session-id"); + private boolean shouldUseExi(final NetconfHelloMessage helloMsg) { + return containsExi10Capability(helloMsg.getDocument()) + && containsExi10Capability(sessionPreferences.getHelloMessage().getDocument()); + } + + private boolean containsExi10Capability(final Document doc) { + final NodeList nList = doc.getElementsByTagName(XmlNetconfConstants.CAPABILITY); + for (int i = 0; i < nList.getLength(); i++) { + if (nList.item(i).getTextContent().contains(EXI_1_0_CAPABILITY_MARKER)) { + return true; + } + } + return false; + } - private long extractSessionId(Document doc) { + private long extractSessionId(final Document doc) { final Node sessionIdNode = (Node) XmlUtil.evaluateXPath(sessionIdXPath, doc, XPathConstants.NODE); + Preconditions.checkState(sessionIdNode != null, ""); String textContent = sessionIdNode.getTextContent(); if (textContent == null || textContent.equals("")) { throw new IllegalStateException("Session id not received from server"); @@ -71,8 +128,63 @@ public class NetconfClientSessionNegotiator extends } @Override - protected NetconfClientSession getSession(NetconfClientSessionListener sessionListener, Channel channel, NetconfMessage message) { - return new NetconfClientSession(sessionListener, channel, extractSessionId(message.getDocument()), - getCapabilities(message.getDocument())); + protected NetconfClientSession getSession(final NetconfClientSessionListener sessionListener, final Channel channel, + final NetconfHelloMessage message) throws NetconfDocumentedException { + long sessionId = extractSessionId(message.getDocument()); + + // Copy here is important: it disconnects the strings from the document + Collection capabilities = ImmutableList.copyOf(NetconfMessageUtil.extractCapabilitiesFromHello(message.getDocument())); + + // FIXME: scalability: we could instantiate a cache to share the same collections + return new NetconfClientSession(sessionListener, channel, sessionId, capabilities); } + + /** + * Handler to process response for start-exi message + */ + private final class ExiConfirmationInboundHandler extends ChannelInboundHandlerAdapter { + private static final String EXI_CONFIRMED_HANDLER = "exiConfirmedHandler"; + + private final NetconfClientSession session; + private final NetconfStartExiMessage startExiMessage; + + ExiConfirmationInboundHandler(final NetconfClientSession session, final NetconfStartExiMessage startExiMessage) { + this.session = session; + this.startExiMessage = startExiMessage; + } + + @Override + public void channelRead(final ChannelHandlerContext ctx, final Object msg) throws Exception { + ctx.pipeline().remove(ExiConfirmationInboundHandler.EXI_CONFIRMED_HANDLER); + + NetconfMessage netconfMessage = (NetconfMessage) msg; + + // Ok response to start-exi, try to add exi handlers + if (NetconfMessageUtil.isOKMessage(netconfMessage)) { + logger.trace("Positive response on start-exi call received on session {}", session); + try { + session.startExiCommunication(startExiMessage); + } catch (RuntimeException e) { + // Unable to add exi, continue without exi + logger.warn("Unable to start exi communication, Communication will continue without exi on session {}", session, e); + } + + // Error response + } else if(NetconfMessageUtil.isErrorMessage(netconfMessage)) { + logger.warn( + "Error response to start-exi message {}, Communication will continue without exi on session {}", + XmlUtil.toString(netconfMessage.getDocument()), session); + + // Unexpected response to start-exi, throwing message away, continue without exi + } else { + logger.warn( + "Unexpected response to start-exi message, should be ok, was {}, " + + "Communication will continue without exi and response message will be thrown away on session {}", + XmlUtil.toString(netconfMessage.getDocument()), session); + } + + negotiationSuccessful(session); + } + } + }