X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2FAbstractNetconfSessionNegotiator.java;h=b0c8c6dc19e6b3b6c97f90b21fe0e1dc680e0ba3;hb=e159106bc148e76fc1e3e3c780bdd740d99e74ed;hp=9c35c7225f9adfae902667791f53854aa25a0246;hpb=ecdc733c2f5202f0bfeb014b990ccabfe3237d4d;p=controller.git diff --git a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/AbstractNetconfSessionNegotiator.java b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/AbstractNetconfSessionNegotiator.java index 9c35c7225f..b0c8c6dc19 100644 --- a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/AbstractNetconfSessionNegotiator.java +++ b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/AbstractNetconfSessionNegotiator.java @@ -8,9 +8,12 @@ package org.opendaylight.controller.netconf.util; +import com.google.common.base.Optional; +import com.google.common.base.Preconditions; import io.netty.channel.Channel; import io.netty.channel.ChannelHandler; import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInboundHandlerAdapter; import io.netty.handler.ssl.SslHandler; import io.netty.util.Timeout; import io.netty.util.Timer; @@ -18,19 +21,17 @@ import io.netty.util.TimerTask; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.GenericFutureListener; import io.netty.util.concurrent.Promise; - -import java.util.concurrent.TimeUnit; - -import org.opendaylight.controller.netconf.api.AbstractNetconfSession; +import org.opendaylight.controller.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.api.NetconfMessage; import org.opendaylight.controller.netconf.api.NetconfSessionListener; import org.opendaylight.controller.netconf.api.NetconfSessionPreferences; import org.opendaylight.controller.netconf.util.handler.FramingMechanismHandlerFactory; -import org.opendaylight.controller.netconf.util.handler.NetconfMessageAggregator; -import org.opendaylight.controller.netconf.util.handler.NetconfMessageChunkDecoder; +import org.opendaylight.controller.netconf.util.handler.NetconfChunkAggregator; +import org.opendaylight.controller.netconf.util.handler.NetconfMessageToXMLEncoder; +import org.opendaylight.controller.netconf.util.handler.NetconfXMLToHelloMessageDecoder; +import org.opendaylight.controller.netconf.util.handler.NetconfXMLToMessageDecoder; import org.opendaylight.controller.netconf.util.messages.FramingMechanism; -import org.opendaylight.controller.netconf.util.xml.XmlElement; -import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants; +import org.opendaylight.controller.netconf.util.messages.NetconfHelloMessage; import org.opendaylight.controller.netconf.util.xml.XmlUtil; import org.opendaylight.protocol.framework.AbstractSessionNegotiator; import org.slf4j.Logger; @@ -38,13 +39,13 @@ import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.NodeList; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; +import java.util.concurrent.TimeUnit; public abstract class AbstractNetconfSessionNegotiator

, L extends NetconfSessionListener> -extends AbstractSessionNegotiator { +extends AbstractSessionNegotiator { private static final Logger logger = LoggerFactory.getLogger(AbstractNetconfSessionNegotiator.class); + public static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler"; protected final P sessionPreferences; @@ -55,7 +56,7 @@ extends AbstractSessionNegotiator { /** * Possible states for Finite State Machine */ - private enum State { + protected enum State { IDLE, OPEN_WAIT, FAILED, ESTABLISHED } @@ -63,6 +64,7 @@ extends AbstractSessionNegotiator { private final Timer timer; private final long connectionTimeoutMillis; + // TODO shrink constructor protected AbstractNetconfSessionNegotiator(P sessionPreferences, Promise promise, Channel channel, Timer timer, L sessionListener, long connectionTimeoutMillis) { super(promise, channel); @@ -73,20 +75,21 @@ extends AbstractSessionNegotiator { } @Override - protected void startNegotiation() { + protected final void startNegotiation() { final Optional sslHandler = getSslHandler(channel); if (sslHandler.isPresent()) { Future future = sslHandler.get().handshakeFuture(); future.addListener(new GenericFutureListener>() { @Override - public void operationComplete(Future future) throws Exception { + public void operationComplete(Future future) { Preconditions.checkState(future.isSuccess(), "Ssl handshake was not successful"); logger.debug("Ssl handshake complete"); start(); } }); - } else + } else { start(); + } } private static Optional getSslHandler(Channel channel) { @@ -94,31 +97,19 @@ extends AbstractSessionNegotiator { return sslHandler == null ? Optional. absent() : Optional.of(sslHandler); } + public P getSessionPreferences() { + return sessionPreferences; + } + private void start() { final NetconfMessage helloMessage = this.sessionPreferences.getHelloMessage(); logger.debug("Session negotiation started with hello message {}", XmlUtil.toString(helloMessage.getDocument())); - channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ChannelHandler() { - @Override - public void handlerAdded(ChannelHandlerContext ctx) throws Exception { - } - - @Override - public void handlerRemoved(ChannelHandlerContext ctx) throws Exception { - } - - @Override - public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { - logger.warn("An exception occurred during negotiation on channel {}", channel.localAddress(), cause); - cancelTimeout(); - negotiationFailed(cause); - changeState(State.FAILED); - } - }); + channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ExceptionHandlingInboundChannelHandler()); timeout = this.timer.newTimeout(new TimerTask() { @Override - public void run(final Timeout timeout) throws Exception { + public void run(final Timeout timeout) { synchronized (this) { if (state != State.ESTABLISHED) { logger.debug("Connection timeout after {}, session is in state {}", timeout, state); @@ -133,56 +124,82 @@ extends AbstractSessionNegotiator { } }, connectionTimeoutMillis, TimeUnit.MILLISECONDS); - sendMessage(helloMessage); + // FIXME, make sessionPreferences return HelloMessage, move NetconfHelloMessage to API + sendMessage((NetconfHelloMessage)helloMessage); + + replaceHelloMessageOutboundHandler(); changeState(State.OPEN_WAIT); } private void cancelTimeout() { - if(timeout!=null) + if(timeout!=null) { timeout.cancel(); + } } - private void sendMessage(NetconfMessage message) { - this.channel.writeAndFlush(message); - } + protected final S getSessionForHelloMessage(NetconfHelloMessage netconfMessage) throws NetconfDocumentedException { + Preconditions.checkNotNull(netconfMessage, "netconfMessage"); - @Override - protected void handleMessage(NetconfMessage netconfMessage) { final Document doc = netconfMessage.getDocument(); - if (isHelloMessage(doc)) { - if (containsBase11Capability(doc) - && containsBase11Capability(sessionPreferences.getHelloMessage().getDocument())) { - channel.pipeline().replace("frameEncoder", "frameEncoder", - FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK)); - channel.pipeline().replace("aggregator", "aggregator", - new NetconfMessageAggregator(FramingMechanism.CHUNK)); - channel.pipeline().addAfter("aggregator", "chunkDecoder", new NetconfMessageChunkDecoder()); - } - changeState(State.ESTABLISHED); - S session = getSession(sessionListener, channel, netconfMessage); - negotiationSuccessful(session); - } else { - final IllegalStateException cause = new IllegalStateException( - "Received message was not hello as expected, but was " + XmlUtil.toString(doc)); - logger.warn("Negotiation of netconf session failed", cause); - negotiationFailed(cause); + if (shouldUseChunkFraming(doc)) { + insertChunkFramingToPipeline(); } + + changeState(State.ESTABLISHED); + return getSession(sessionListener, channel, netconfMessage); } - protected abstract S getSession(L sessionListener, Channel channel, NetconfMessage message); + /** + * Insert chunk framing handlers into the pipeline + */ + private void insertChunkFramingToPipeline() { + replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER, + FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK)); + replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR, + new NetconfChunkAggregator()); + } - private boolean isHelloMessage(Document doc) { - try { - XmlElement.fromDomElementWithExpected(doc.getDocumentElement(), "hello", - XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0); + private boolean shouldUseChunkFraming(Document doc) { + return containsBase11Capability(doc) + && containsBase11Capability(sessionPreferences.getHelloMessage().getDocument()); + } - } catch (IllegalArgumentException | IllegalStateException e) { - return false; + /** + * Remove special inbound handler for hello message. Insert regular netconf xml message (en|de)coders. + * + * Inbound hello message handler should be kept until negotiation is successful + * It caches any non-hello messages while negotiation is still in progress + */ + protected final void replaceHelloMessageInboundHandler(final S session) { + ChannelHandler helloMessageHandler = replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_DECODER, new NetconfXMLToMessageDecoder()); + + Preconditions.checkState(helloMessageHandler instanceof NetconfXMLToHelloMessageDecoder, + "Pipeline handlers misplaced on session: %s, pipeline: %s", session, channel.pipeline()); + Iterable netconfMessagesFromNegotiation = + ((NetconfXMLToHelloMessageDecoder) helloMessageHandler).getPostHelloNetconfMessages(); + + // Process messages received during negotiation + // The hello message handler does not have to be synchronized, since it is always call from the same thread by netty + // It means, we are now using the thread now + for (NetconfMessage message : netconfMessagesFromNegotiation) { + session.handleMessage(message); } - return true; } + /** + * Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders. + */ + private void replaceHelloMessageOutboundHandler() { + replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER, new NetconfMessageToXMLEncoder()); + } + + private static ChannelHandler replaceChannelHandler(Channel channel, String handlerKey, ChannelHandler decoder) { + return channel.pipeline().replace(handlerKey, handlerKey, decoder); + } + + protected abstract S getSession(L sessionListener, Channel channel, NetconfHelloMessage message) throws NetconfDocumentedException; + private synchronized void changeState(final State newState) { logger.debug("Changing state from : {} to : {}", state, newState); Preconditions.checkState(isStateChangePermitted(state, newState), "Cannot change state from %s to %s", state, @@ -201,14 +218,29 @@ extends AbstractSessionNegotiator { } private static boolean isStateChangePermitted(State state, State newState) { - if (state == State.IDLE && newState == State.OPEN_WAIT) + if (state == State.IDLE && newState == State.OPEN_WAIT) { return true; - if (state == State.OPEN_WAIT && newState == State.ESTABLISHED) + } + if (state == State.OPEN_WAIT && newState == State.ESTABLISHED) { return true; - if (state == State.OPEN_WAIT && newState == State.FAILED) + } + if (state == State.OPEN_WAIT && newState == State.FAILED) { return true; - + } logger.debug("Transition from {} to {} is not allowed", state, newState); return false; } + + /** + * Handler to catch exceptions in pipeline during negotiation + */ + private final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter { + @Override + public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { + logger.warn("An exception occurred during negotiation on channel {}", channel.localAddress(), cause); + cancelTimeout(); + negotiationFailed(cause); + changeState(State.FAILED); + } + } }