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=9986b82bd8d6902a084e77a1a11a6421125ccb17;hpb=aeabf761ca043e41eeca6333bc9deb94b1de9ed0;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 9986b82bd8..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,19 +8,30 @@ package org.opendaylight.controller.netconf.util; -import java.util.concurrent.TimeUnit; - -import org.opendaylight.controller.netconf.api.AbstractNetconfSession; +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; +import io.netty.util.TimerTask; +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.GenericFutureListener; +import io.netty.util.concurrent.Promise; +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.messages.NetconfHelloMessage; -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.messages.NetconfHelloMessage; import org.opendaylight.controller.netconf.util.xml.XmlUtil; import org.opendaylight.protocol.framework.AbstractSessionNegotiator; import org.slf4j.Logger; @@ -28,26 +39,14 @@ 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 io.netty.channel.Channel; -import io.netty.channel.ChannelHandler; -import io.netty.channel.ChannelHandlerContext; -import io.netty.handler.ssl.SslHandler; -import io.netty.util.Timeout; -import io.netty.util.Timer; -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; public abstract class AbstractNetconfSessionNegotiator

, L extends NetconfSessionListener> extends AbstractSessionNegotiator { private static final Logger logger = LoggerFactory.getLogger(AbstractNetconfSessionNegotiator.class); + public static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler"; - public static final String CHUNK_DECODER_CHANNEL_HANDLER_KEY = "chunkDecoder"; protected final P sessionPreferences; @@ -57,7 +56,7 @@ extends AbstractSessionNegotiator { /** * Possible states for Finite State Machine */ - private enum State { + protected enum State { IDLE, OPEN_WAIT, FAILED, ESTABLISHED } @@ -65,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); @@ -75,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) { @@ -96,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); @@ -135,42 +124,30 @@ 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(NetconfHelloMessage netconfMessage) { final Document doc = netconfMessage.getDocument(); - // Only Hello message should arrive during negotiation - if (netconfMessage instanceof NetconfHelloMessage) { - - replaceHelloMessageHandlers(); - - if (shouldUseChunkFraming(doc)) { - insertChunkFramingToPipeline(); - } - - changeState(State.ESTABLISHED); - S session = getSession(sessionListener, channel, (NetconfHelloMessage)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); } /** @@ -180,9 +157,7 @@ extends AbstractSessionNegotiator { replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER, FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK)); replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR, - new NetconfMessageAggregator(FramingMechanism.CHUNK)); - channel.pipeline().addAfter(AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR, - CHUNK_DECODER_CHANNEL_HANDLER_KEY, new NetconfMessageChunkDecoder()); + new NetconfChunkAggregator()); } private boolean shouldUseChunkFraming(Document doc) { @@ -191,10 +166,31 @@ extends AbstractSessionNegotiator { } /** - * Remove special handlers for hello message. Insert regular netconf xml message (en|de)coders. + * 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 */ - private void replaceHelloMessageHandlers() { - replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_DECODER, new NetconfXMLToMessageDecoder()); + 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); + } + } + + /** + * 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()); } @@ -202,7 +198,7 @@ extends AbstractSessionNegotiator { return channel.pipeline().replace(handlerKey, handlerKey, decoder); } - protected abstract S getSession(L sessionListener, Channel channel, NetconfHelloMessage message); + 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); @@ -222,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); + } + } }