+++ /dev/null
-/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.netconf.nettyutil;
-
-import static com.google.common.base.Preconditions.checkArgument;
-import static com.google.common.base.Preconditions.checkState;
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.annotations.Beta;
-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.concurrent.Future;
-import io.netty.util.concurrent.Promise;
-import java.util.concurrent.TimeUnit;
-import org.checkerframework.checker.index.qual.NonNegative;
-import org.checkerframework.checker.lock.qual.GuardedBy;
-import org.checkerframework.checker.lock.qual.Holding;
-import org.eclipse.jdt.annotation.NonNull;
-import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.netconf.api.CapabilityURN;
-import org.opendaylight.netconf.api.NamespaceURN;
-import org.opendaylight.netconf.api.NetconfDocumentedException;
-import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.messages.HelloMessage;
-import org.opendaylight.netconf.api.messages.NetconfMessage;
-import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
-import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
-import org.opendaylight.netconf.nettyutil.handler.NetconfChunkAggregator;
-import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
-import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToHelloMessageDecoder;
-import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.w3c.dom.Document;
-import org.w3c.dom.NodeList;
-
-public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconfSession<S, L>,
- L extends NetconfSessionListener<S>>
- extends ChannelInboundHandlerAdapter implements NetconfSessionNegotiator<S> {
- /**
- * Possible states for Finite State Machine.
- */
- protected enum State {
- IDLE, OPEN_WAIT, FAILED, ESTABLISHED
- }
-
- private static final Logger LOG = LoggerFactory.getLogger(AbstractNetconfSessionNegotiator.class);
- private static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler";
- private static final String DEFAULT_MAXIMUM_CHUNK_SIZE_PROP = "org.opendaylight.netconf.default.maximum.chunk.size";
- private static final int DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT = 16 * 1024 * 1024;
-
- /**
- * Default upper bound on the size of an individual chunk. This value can be controlled through
- * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_PROP} system property and defaults to
- * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT} bytes.
- */
- @Beta
- public static final @NonNegative int DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
-
- static {
- final int propValue = Integer.getInteger(DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT);
- if (propValue <= 0) {
- LOG.warn("Ignoring invalid {} value {}", DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, propValue);
- DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT;
- } else {
- DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = propValue;
- }
- LOG.debug("Default maximum incoming NETCONF chunk size is {} bytes", DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
- }
-
- private final @NonNull HelloMessage localHello;
- protected final Channel channel;
-
- private final @NonNegative int maximumIncomingChunkSize;
- private final long connectionTimeoutMillis;
- private final Promise<S> promise;
- private final L sessionListener;
- private final Timer timer;
-
- @GuardedBy("this")
- private Timeout timeoutTask;
- @GuardedBy("this")
- private State state = State.IDLE;
-
- protected AbstractNetconfSessionNegotiator(final HelloMessage hello, final Promise<S> promise,
- final Channel channel, final Timer timer, final L sessionListener,
- final long connectionTimeoutMillis,
- final @NonNegative int maximumIncomingChunkSize) {
- localHello = requireNonNull(hello);
- this.promise = requireNonNull(promise);
- this.channel = requireNonNull(channel);
- this.timer = timer;
- this.sessionListener = sessionListener;
- this.connectionTimeoutMillis = connectionTimeoutMillis;
- this.maximumIncomingChunkSize = maximumIncomingChunkSize;
- checkArgument(maximumIncomingChunkSize > 0, "Invalid maximum incoming chunk size %s", maximumIncomingChunkSize);
- }
-
- protected final @NonNull HelloMessage localHello() {
- return localHello;
- }
-
- protected final void startNegotiation() {
- if (ifNegotiatedAlready()) {
- LOG.debug("Negotiation on channel {} already started", channel);
- } else {
- final var sslHandler = getSslHandler(channel);
- if (sslHandler != null) {
- sslHandler.handshakeFuture().addListener(future -> {
- checkState(future.isSuccess(), "Ssl handshake was not successful");
- LOG.debug("Ssl handshake complete");
- start();
- });
- } else {
- start();
- }
- }
- }
-
- protected final boolean ifNegotiatedAlready() {
- // Indicates whether negotiation already started
- return state() != State.IDLE;
- }
-
- private synchronized State state() {
- return state;
- }
-
- private static @Nullable SslHandler getSslHandler(final Channel channel) {
- return channel.pipeline().get(SslHandler.class);
- }
-
- private void start() {
- LOG.debug("Sending negotiation proposal {} on channel {}", localHello, channel);
-
- // Send the message out, but to not run listeners just yet, as we have some more state transitions to go through
- final var helloFuture = channel.writeAndFlush(localHello);
-
- // Quick check: if the future has already failed we call it quits before negotiation even started
- final var helloCause = helloFuture.cause();
- if (helloCause != null) {
- LOG.warn("Failed to send negotiation proposal on channel {}", channel, helloCause);
- failAndClose();
- return;
- }
-
- // Catch any exceptions from this point on. Use a named class to ease debugging.
- final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter {
- @Override
- public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
- LOG.warn("An exception occurred during negotiation with {} on channel {}",
- channel.remoteAddress(), channel, cause);
- // FIXME: this is quite suspect as it is competing with timeoutExpired() without synchronization
- cancelTimeout();
- negotiationFailed(cause);
- changeState(State.FAILED);
- }
- }
-
- channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ExceptionHandlingInboundChannelHandler());
-
- // Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders.
- replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER,
- new NetconfMessageToXMLEncoder());
-
- synchronized (this) {
- lockedChangeState(State.OPEN_WAIT);
-
- // Service the timeout on channel's eventloop, so that we do not get state transition problems
- timeoutTask = timer.newTimeout(unused -> channel.eventLoop().execute(this::timeoutExpired),
- connectionTimeoutMillis, TimeUnit.MILLISECONDS);
- }
-
- LOG.debug("Session negotiation started on channel {}", channel);
-
- // State transition completed, now run any additional processing
- helloFuture.addListener(this::onHelloWriteComplete);
- }
-
- private void onHelloWriteComplete(final Future<?> future) {
- final var cause = future.cause();
- if (cause != null) {
- LOG.info("Failed to send message {} on channel {}", localHello, channel, cause);
- negotiationFailed(cause);
- } else {
- LOG.trace("Message {} sent to socket on channel {}", localHello, channel);
- }
- }
-
- private synchronized void timeoutExpired() {
- if (timeoutTask == null) {
- // cancelTimeout() between expiry and execution on the loop
- return;
- }
- timeoutTask = null;
-
- if (state != State.ESTABLISHED) {
- LOG.debug("Connection timeout after {}ms, session backed by channel {} is in state {}",
- connectionTimeoutMillis, channel, state);
-
- // Do not fail negotiation if promise is done or canceled
- // It would result in setting result of the promise second time and that throws exception
- if (!promise.isDone() && !promise.isCancelled()) {
- LOG.warn("Netconf session backed by channel {} was not established after {}", channel,
- connectionTimeoutMillis);
- failAndClose();
- }
- } else if (channel.isOpen()) {
- channel.pipeline().remove(NAME_OF_EXCEPTION_HANDLER);
- }
- }
-
- private void failAndClose() {
- changeState(State.FAILED);
- channel.close().addListener(this::onChannelClosed);
- }
-
- private void onChannelClosed(final Future<?> future) {
- final var cause = future.cause();
- if (cause != null) {
- LOG.warn("Channel {} closed: fail", channel, cause);
- } else {
- LOG.debug("Channel {} closed: success", channel);
- }
- }
-
- private synchronized void cancelTimeout() {
- if (timeoutTask != null && !timeoutTask.cancel()) {
- // Late-coming cancel: make sure the task does not actually run
- timeoutTask = null;
- }
- }
-
- protected final S getSessionForHelloMessage(final HelloMessage netconfMessage)
- throws NetconfDocumentedException {
- final Document doc = netconfMessage.getDocument();
-
- if (shouldUseChunkFraming(doc)) {
- insertChunkFramingToPipeline();
- }
-
- changeState(State.ESTABLISHED);
- return getSession(sessionListener, channel, netconfMessage);
- }
-
- protected abstract S getSession(L sessionListener, Channel channel, HelloMessage message)
- throws NetconfDocumentedException;
-
- /**
- * Insert chunk framing handlers into the pipeline.
- */
- private void insertChunkFramingToPipeline() {
- replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER,
- new ChunkedFramingMechanismEncoder());
- replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR,
- new NetconfChunkAggregator(maximumIncomingChunkSize));
- }
-
- private boolean shouldUseChunkFraming(final Document doc) {
- return containsBase11Capability(doc) && containsBase11Capability(localHello.getDocument());
- }
-
- /**
- * Remove special inbound handler for hello message. Insert regular netconf xml message (en|de)coders.
- *
- * <p>
- * 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());
-
- checkState(helloMessageHandler instanceof NetconfXMLToHelloMessageDecoder,
- "Pipeline handlers misplaced on session: %s, pipeline: %s", session, channel.pipeline());
- Iterable<NetconfMessage> 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);
- }
- }
-
- private static ChannelHandler replaceChannelHandler(final Channel channel, final String handlerKey,
- final ChannelHandler decoder) {
- return channel.pipeline().replace(handlerKey, handlerKey, decoder);
- }
-
- private synchronized void changeState(final State newState) {
- lockedChangeState(newState);
- }
-
- @Holding("this")
- private void lockedChangeState(final State newState) {
- LOG.debug("Changing state from : {} to : {} for channel: {}", state, newState, channel);
- checkState(isStateChangePermitted(state, newState),
- "Cannot change state from %s to %s for channel %s", state, newState, channel);
- state = newState;
- }
-
- private static boolean containsBase11Capability(final Document doc) {
- final NodeList nList = doc.getElementsByTagNameNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITY);
- for (int i = 0; i < nList.getLength(); i++) {
- if (nList.item(i).getTextContent().contains(CapabilityURN.BASE_1_1)) {
- return true;
- }
- }
- return false;
- }
-
- private static boolean isStateChangePermitted(final State state, final State newState) {
- if (state == State.IDLE && (newState == State.OPEN_WAIT || newState == State.FAILED)) {
- return true;
- }
- if (state == State.OPEN_WAIT && (newState == State.ESTABLISHED || newState == State.FAILED)) {
- return true;
- }
- LOG.debug("Transition from {} to {} is not allowed", state, newState);
- return false;
- }
-
- protected final void negotiationSuccessful(final S session) {
- LOG.debug("Negotiation on channel {} successful with session {}", channel, session);
- channel.pipeline().replace(this, "session", session);
- promise.setSuccess(session);
- }
-
- protected void negotiationFailed(final Throwable cause) {
- LOG.debug("Negotiation on channel {} failed", channel, cause);
- channel.close();
- promise.setFailure(cause);
- }
-
- @Override
- @SuppressWarnings("checkstyle:illegalCatch")
- public final void channelActive(final ChannelHandlerContext ctx) {
- LOG.debug("Starting session negotiation on channel {}", channel);
- try {
- startNegotiation();
- } catch (final Exception e) {
- LOG.warn("Unexpected negotiation failure on channel {}", channel, e);
- negotiationFailed(e);
- }
- }
-
- @Override
- @SuppressWarnings("checkstyle:illegalCatch")
- public final void channelRead(final ChannelHandlerContext ctx, final Object msg) {
- if (state() == State.FAILED) {
- // We have already failed -- do not process any more messages
- return;
- }
-
- LOG.debug("Negotiation read invoked on channel {}", channel);
- try {
- handleMessage((HelloMessage) msg);
- } catch (final Exception e) {
- LOG.debug("Unexpected error while handling negotiation message {} on channel {}", msg, channel, e);
- negotiationFailed(e);
- }
- }
-
- @Override
- public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
- LOG.info("Unexpected error during negotiation on channel {}", channel, cause);
- negotiationFailed(cause);
- }
-
- protected abstract void handleMessage(HelloMessage msg) throws Exception;
-}
*/
package org.opendaylight.netconf.nettyutil;
-import io.netty.channel.ChannelInboundHandler;
-import org.opendaylight.netconf.api.NetconfSession;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+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.concurrent.Future;
+import io.netty.util.concurrent.Promise;
+import java.util.concurrent.TimeUnit;
+import org.checkerframework.checker.index.qual.NonNegative;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.netconf.api.CapabilityURN;
+import org.opendaylight.netconf.api.NamespaceURN;
+import org.opendaylight.netconf.api.NetconfDocumentedException;
+import org.opendaylight.netconf.api.NetconfSessionListener;
+import org.opendaylight.netconf.api.messages.HelloMessage;
+import org.opendaylight.netconf.api.messages.NetconfMessage;
+import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
+import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
+import org.opendaylight.netconf.nettyutil.handler.NetconfChunkAggregator;
+import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
+import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToHelloMessageDecoder;
+import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+import org.w3c.dom.NodeList;
/**
- * Session negotiator concepts. A negotiator is responsible for message
- * handling while the exact session parameters are not known. Once the
- * session parameters are finalized, the negotiator replaces itself in
- * the channel pipeline with the session.
+ * A negotiator of a NETCONF session. It is responsible for message handling while the exact session parameters are not
+ * known. Once the session parameters are finalized, the negotiator replaces itself in the channel pipeline with the
+ * session.
*
- * @param <T> Protocol session type.
+ * @param <S> Session type
+ * @param <L> Session listener type
*/
-@Deprecated
-public interface NetconfSessionNegotiator<T extends NetconfSession> extends ChannelInboundHandler {
+public abstract class NetconfSessionNegotiator<S extends AbstractNetconfSession<S, L>,
+ L extends NetconfSessionListener<S>> extends ChannelInboundHandlerAdapter {
+ /**
+ * Possible states for Finite State Machine.
+ */
+ protected enum State {
+ IDLE, OPEN_WAIT, FAILED, ESTABLISHED
+ }
+
+ private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionNegotiator.class);
+ private static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler";
+ private static final String DEFAULT_MAXIMUM_CHUNK_SIZE_PROP = "org.opendaylight.netconf.default.maximum.chunk.size";
+ private static final int DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT = 16 * 1024 * 1024;
+
+ /**
+ * Default upper bound on the size of an individual chunk. This value can be controlled through
+ * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_PROP} system property and defaults to
+ * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT} bytes.
+ */
+ @Beta
+ public static final @NonNegative int DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
+
+ static {
+ final int propValue = Integer.getInteger(DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT);
+ if (propValue <= 0) {
+ LOG.warn("Ignoring invalid {} value {}", DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, propValue);
+ DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT;
+ } else {
+ DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = propValue;
+ }
+ LOG.debug("Default maximum incoming NETCONF chunk size is {} bytes", DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
+ }
+
+ private final @NonNull HelloMessage localHello;
+ protected final Channel channel;
+
+ private final @NonNegative int maximumIncomingChunkSize;
+ private final long connectionTimeoutMillis;
+ private final Promise<S> promise;
+ private final L sessionListener;
+ private final Timer timer;
+
+ @GuardedBy("this")
+ private Timeout timeoutTask;
+ @GuardedBy("this")
+ private State state = State.IDLE;
+
+ protected NetconfSessionNegotiator(final HelloMessage hello, final Promise<S> promise, final Channel channel,
+ final Timer timer, final L sessionListener, final long connectionTimeoutMillis,
+ final @NonNegative int maximumIncomingChunkSize) {
+ localHello = requireNonNull(hello);
+ this.promise = requireNonNull(promise);
+ this.channel = requireNonNull(channel);
+ this.timer = timer;
+ this.sessionListener = sessionListener;
+ this.connectionTimeoutMillis = connectionTimeoutMillis;
+ this.maximumIncomingChunkSize = maximumIncomingChunkSize;
+ checkArgument(maximumIncomingChunkSize > 0, "Invalid maximum incoming chunk size %s", maximumIncomingChunkSize);
+ }
+
+ protected final @NonNull HelloMessage localHello() {
+ return localHello;
+ }
+
+ protected final void startNegotiation() {
+ if (ifNegotiatedAlready()) {
+ LOG.debug("Negotiation on channel {} already started", channel);
+ } else {
+ final var sslHandler = getSslHandler(channel);
+ if (sslHandler != null) {
+ sslHandler.handshakeFuture().addListener(future -> {
+ checkState(future.isSuccess(), "Ssl handshake was not successful");
+ LOG.debug("Ssl handshake complete");
+ start();
+ });
+ } else {
+ start();
+ }
+ }
+ }
+
+ protected final boolean ifNegotiatedAlready() {
+ // Indicates whether negotiation already started
+ return state() != State.IDLE;
+ }
+
+ private synchronized State state() {
+ return state;
+ }
+
+ private static @Nullable SslHandler getSslHandler(final Channel channel) {
+ return channel.pipeline().get(SslHandler.class);
+ }
+
+ private void start() {
+ LOG.debug("Sending negotiation proposal {} on channel {}", localHello, channel);
+
+ // Send the message out, but to not run listeners just yet, as we have some more state transitions to go through
+ final var helloFuture = channel.writeAndFlush(localHello);
+
+ // Quick check: if the future has already failed we call it quits before negotiation even started
+ final var helloCause = helloFuture.cause();
+ if (helloCause != null) {
+ LOG.warn("Failed to send negotiation proposal on channel {}", channel, helloCause);
+ failAndClose();
+ return;
+ }
+
+ // Catch any exceptions from this point on. Use a named class to ease debugging.
+ final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter {
+ @Override
+ public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
+ LOG.warn("An exception occurred during negotiation with {} on channel {}",
+ channel.remoteAddress(), channel, cause);
+ // FIXME: this is quite suspect as it is competing with timeoutExpired() without synchronization
+ cancelTimeout();
+ negotiationFailed(cause);
+ changeState(State.FAILED);
+ }
+ }
+
+ channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ExceptionHandlingInboundChannelHandler());
+
+ // Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders.
+ replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER,
+ new NetconfMessageToXMLEncoder());
+
+ synchronized (this) {
+ lockedChangeState(State.OPEN_WAIT);
+
+ // Service the timeout on channel's eventloop, so that we do not get state transition problems
+ timeoutTask = timer.newTimeout(unused -> channel.eventLoop().execute(this::timeoutExpired),
+ connectionTimeoutMillis, TimeUnit.MILLISECONDS);
+ }
+
+ LOG.debug("Session negotiation started on channel {}", channel);
+
+ // State transition completed, now run any additional processing
+ helloFuture.addListener(this::onHelloWriteComplete);
+ }
+
+ private void onHelloWriteComplete(final Future<?> future) {
+ final var cause = future.cause();
+ if (cause != null) {
+ LOG.info("Failed to send message {} on channel {}", localHello, channel, cause);
+ negotiationFailed(cause);
+ } else {
+ LOG.trace("Message {} sent to socket on channel {}", localHello, channel);
+ }
+ }
+
+ private synchronized void timeoutExpired() {
+ if (timeoutTask == null) {
+ // cancelTimeout() between expiry and execution on the loop
+ return;
+ }
+ timeoutTask = null;
+
+ if (state != State.ESTABLISHED) {
+ LOG.debug("Connection timeout after {}ms, session backed by channel {} is in state {}",
+ connectionTimeoutMillis, channel, state);
+
+ // Do not fail negotiation if promise is done or canceled
+ // It would result in setting result of the promise second time and that throws exception
+ if (!promise.isDone() && !promise.isCancelled()) {
+ LOG.warn("Netconf session backed by channel {} was not established after {}", channel,
+ connectionTimeoutMillis);
+ failAndClose();
+ }
+ } else if (channel.isOpen()) {
+ channel.pipeline().remove(NAME_OF_EXCEPTION_HANDLER);
+ }
+ }
+
+ private void failAndClose() {
+ changeState(State.FAILED);
+ channel.close().addListener(this::onChannelClosed);
+ }
+
+ private void onChannelClosed(final Future<?> future) {
+ final var cause = future.cause();
+ if (cause != null) {
+ LOG.warn("Channel {} closed: fail", channel, cause);
+ } else {
+ LOG.debug("Channel {} closed: success", channel);
+ }
+ }
+
+ private synchronized void cancelTimeout() {
+ if (timeoutTask != null && !timeoutTask.cancel()) {
+ // Late-coming cancel: make sure the task does not actually run
+ timeoutTask = null;
+ }
+ }
+
+ protected final S getSessionForHelloMessage(final HelloMessage netconfMessage)
+ throws NetconfDocumentedException {
+ final Document doc = netconfMessage.getDocument();
+
+ if (shouldUseChunkFraming(doc)) {
+ insertChunkFramingToPipeline();
+ }
+
+ changeState(State.ESTABLISHED);
+ return getSession(sessionListener, channel, netconfMessage);
+ }
+
+ protected abstract S getSession(L sessionListener, Channel channel, HelloMessage message)
+ throws NetconfDocumentedException;
+
+ /**
+ * Insert chunk framing handlers into the pipeline.
+ */
+ private void insertChunkFramingToPipeline() {
+ replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER,
+ new ChunkedFramingMechanismEncoder());
+ replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR,
+ new NetconfChunkAggregator(maximumIncomingChunkSize));
+ }
+
+ private boolean shouldUseChunkFraming(final Document doc) {
+ return containsBase11Capability(doc) && containsBase11Capability(localHello.getDocument());
+ }
+
+ /**
+ * Remove special inbound handler for hello message. Insert regular netconf xml message (en|de)coders.
+ *
+ * <p>
+ * 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());
+
+ checkState(helloMessageHandler instanceof NetconfXMLToHelloMessageDecoder,
+ "Pipeline handlers misplaced on session: %s, pipeline: %s", session, channel.pipeline());
+ Iterable<NetconfMessage> 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);
+ }
+ }
+
+ private static ChannelHandler replaceChannelHandler(final Channel channel, final String handlerKey,
+ final ChannelHandler decoder) {
+ return channel.pipeline().replace(handlerKey, handlerKey, decoder);
+ }
+
+ private synchronized void changeState(final State newState) {
+ lockedChangeState(newState);
+ }
+
+ @Holding("this")
+ private void lockedChangeState(final State newState) {
+ LOG.debug("Changing state from : {} to : {} for channel: {}", state, newState, channel);
+ checkState(isStateChangePermitted(state, newState),
+ "Cannot change state from %s to %s for channel %s", state, newState, channel);
+ state = newState;
+ }
+
+ private static boolean containsBase11Capability(final Document doc) {
+ final NodeList nList = doc.getElementsByTagNameNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITY);
+ for (int i = 0; i < nList.getLength(); i++) {
+ if (nList.item(i).getTextContent().contains(CapabilityURN.BASE_1_1)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private static boolean isStateChangePermitted(final State state, final State newState) {
+ if (state == State.IDLE && (newState == State.OPEN_WAIT || newState == State.FAILED)) {
+ return true;
+ }
+ if (state == State.OPEN_WAIT && (newState == State.ESTABLISHED || newState == State.FAILED)) {
+ return true;
+ }
+ LOG.debug("Transition from {} to {} is not allowed", state, newState);
+ return false;
+ }
+
+ protected final void negotiationSuccessful(final S session) {
+ LOG.debug("Negotiation on channel {} successful with session {}", channel, session);
+ channel.pipeline().replace(this, "session", session);
+ promise.setSuccess(session);
+ }
+
+ protected void negotiationFailed(final Throwable cause) {
+ LOG.debug("Negotiation on channel {} failed", channel, cause);
+ channel.close();
+ promise.setFailure(cause);
+ }
+
+ @Override
+ @SuppressWarnings("checkstyle:illegalCatch")
+ public final void channelActive(final ChannelHandlerContext ctx) {
+ LOG.debug("Starting session negotiation on channel {}", channel);
+ try {
+ startNegotiation();
+ } catch (final Exception e) {
+ LOG.warn("Unexpected negotiation failure on channel {}", channel, e);
+ negotiationFailed(e);
+ }
+ }
+
+ @Override
+ @SuppressWarnings("checkstyle:illegalCatch")
+ public final void channelRead(final ChannelHandlerContext ctx, final Object msg) {
+ if (state() == State.FAILED) {
+ // We have already failed -- do not process any more messages
+ return;
+ }
+
+ LOG.debug("Negotiation read invoked on channel {}", channel);
+ try {
+ handleMessage((HelloMessage) msg);
+ } catch (final Exception e) {
+ LOG.debug("Unexpected error while handling negotiation message {} on channel {}", msg, channel, e);
+ negotiationFailed(e);
+ }
+ }
+
+ @Override
+ public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
+ LOG.info("Unexpected error during negotiation on channel {}", channel, cause);
+ negotiationFailed(cause);
+ }
+ protected abstract void handleMessage(HelloMessage msg) throws Exception;
}
import org.opendaylight.yangtools.yang.common.Uint32;
final class TestSessionNegotiator
- extends AbstractNetconfSessionNegotiator<TestingNetconfSession, NetconfSessionListener<TestingNetconfSession>> {
+ extends NetconfSessionNegotiator<TestingNetconfSession, NetconfSessionListener<TestingNetconfSession>> {
TestSessionNegotiator(final HelloMessage hello, final Promise<TestingNetconfSession> promise,
final Channel channel, final Timer timer,
final NetconfSessionListener<TestingNetconfSession> sessionListener, final long connectionTimeoutMillis) {
import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
import org.opendaylight.netconf.api.xml.XmlUtil;
import org.opendaylight.netconf.nettyutil.AbstractChannelInitializer;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
import org.opendaylight.yangtools.yang.common.Uint32;
import org.slf4j.Logger;
// Non-final for mocking
class NetconfClientSessionNegotiator
- extends AbstractNetconfSessionNegotiator<NetconfClientSession, NetconfClientSessionListener> {
+ extends NetconfSessionNegotiator<NetconfClientSession, NetconfClientSessionListener> {
private static final Logger LOG = LoggerFactory.getLogger(NetconfClientSessionNegotiator.class);
private static final XPathExpression SESSION_ID_X_PATH = XMLNetconfUtil
import org.opendaylight.netconf.api.NetconfSessionListenerFactory;
import org.opendaylight.netconf.api.messages.HelloMessage;
import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
import org.opendaylight.netconf.nettyutil.handler.exi.NetconfStartExiMessageProvider;
import org.opendaylight.netconf.shaded.exificient.core.CodingMode;
final long connectionTimeoutMillis, final EXIParameters exiOptions,
final Set<String> capabilities) {
this(timer, additionalHeader, connectionTimeoutMillis, exiOptions, capabilities,
- AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
+ NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
}
public NetconfClientSessionNegotiatorFactory(final Timer timer,
import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
import org.opendaylight.netconf.client.NetconfClientSessionListener;
import org.opendaylight.netconf.client.SslHandlerFactory;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
import org.opendaylight.netconf.nettyutil.handler.ssh.client.NetconfSshClient;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
private NetconfSshClient sshClient;
private List<Uri> odlHelloCapabilities;
private @NonNegative int maximumIncomingChunkSize =
- AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
+ NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
private String name;
private TcpClientGrouping tcpParameters;
private TlsClientGrouping tlsParameters;
import org.opendaylight.netconf.api.NetconfDocumentedException;
import org.opendaylight.netconf.api.messages.HelloMessage;
import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public final class NetconfServerSessionNegotiator
- extends AbstractNetconfSessionNegotiator<NetconfServerSession, NetconfServerSessionListener> {
+ extends NetconfSessionNegotiator<NetconfServerSession, NetconfServerSessionListener> {
private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSessionNegotiator.class);
private static final String UNKNOWN = "unknown";
import org.checkerframework.checker.index.qual.NonNegative;
import org.opendaylight.netconf.api.CapabilityURN;
import org.opendaylight.netconf.api.messages.HelloMessage;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.netconf.server.api.SessionIdProvider;
import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
final long connectionTimeoutMillis, final NetconfMonitoringService monitoringService,
final Set<String> baseCapabilities) {
this(timer, netconfOperationProvider, idProvider, connectionTimeoutMillis, monitoringService, baseCapabilities,
- AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
+ NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
}
protected NetconfServerSessionNegotiatorFactory(final Timer timer,
import io.netty.util.Timer;
import java.util.Set;
import org.checkerframework.checker.index.qual.NonNegative;
-import org.opendaylight.netconf.nettyutil.AbstractNetconfSessionNegotiator;
+import org.opendaylight.netconf.nettyutil.NetconfSessionNegotiator;
import org.opendaylight.netconf.server.api.SessionIdProvider;
import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
private long connectionTimeoutMillis;
private NetconfMonitoringService monitoringService;
private Set<String> baseCapabilities;
- private @NonNegative int maximumIncomingChunkSize =
- AbstractNetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
+ private @NonNegative int maximumIncomingChunkSize = NetconfSessionNegotiator.DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
public NetconfServerSessionNegotiatorFactoryBuilder() {
}
Code Review / netconf.git / commitdiff