import java.net.SocketAddress;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
import org.opendaylight.netconf.shaded.sshd.client.channel.ClientChannel;
private final Future<?> negotiationFuture;
private final NetconfSshClient sshClient;
- private AsyncSshHandlerWriter sshWriteAsyncHandler;
+ // Initialized by connect()
+ @GuardedBy("this")
+ private ChannelPromise connectPromise;
+ private AsyncSshHandlerWriter sshWriteAsyncHandler;
private NettyAwareChannelSubsystem channel;
private ClientSession session;
- private ChannelPromise connectPromise;
private FutureListener<Object> negotiationFutureListener;
public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final NetconfSshClient sshClient,
negotiationFuture);
}
- private synchronized void handleSshChanelOpened(final ChannelHandlerContext ctx) {
- LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel());
-
- if (negotiationFuture == null) {
- connectPromise.setSuccess();
- }
-
- sshWriteAsyncHandler = new AsyncSshHandlerWriter(channel.getAsyncIn());
- ctx.fireChannelActive();
- channel.onClose(() -> disconnect(ctx, ctx.newPromise()));
- }
-
- private synchronized void handleSshSetupFailure(final ChannelHandlerContext ctx, final Throwable error) {
- LOG.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), error);
-
- // If the promise is not yet done, we have failed with initial connect and set connectPromise to failure
- if (!connectPromise.isDone()) {
- connectPromise.setFailure(error);
- }
-
- disconnect(ctx, ctx.newPromise());
- }
-
@Override
public synchronized void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) {
sshWriteAsyncHandler.write(ctx, msg, promise);
.addListener(future -> onConnectComplete(future, ctx));
}
- private void onConnectComplete(final ConnectFuture future, final ChannelHandlerContext ctx) {
- final var cause = future.getException();
+ private synchronized void onConnectComplete(final ConnectFuture connectFuture, final ChannelHandlerContext ctx) {
+ final var cause = connectFuture.getException();
if (cause != null) {
- handleSshSetupFailure(ctx, cause);
+ onOpenFailure(ctx, cause);
return;
}
- final var clientSession = future.getSession();
+ final var clientSession = connectFuture.getSession();
LOG.trace("SSH session {} created on channel: {}", clientSession, ctx.channel());
verify(clientSession instanceof NettyAwareClientSession, "Unexpected session %s", clientSession);
- onConnectComplete((NettyAwareClientSession) clientSession, ctx);
- }
- private synchronized void onConnectComplete(final NettyAwareClientSession clientSession,
- final ChannelHandlerContext ctx) {
- session = clientSession;
+ final var localSession = (NettyAwareClientSession) clientSession;
+ session = localSession;
final AuthFuture authFuture;
try {
- authFuture = authenticationHandler.authenticate(clientSession);
+ authFuture = authenticationHandler.authenticate(localSession);
} catch (final IOException e) {
- handleSshSetupFailure(ctx, e);
+ onOpenFailure(ctx, e);
return;
}
- authFuture.addListener(future -> onAuthComplete(future, clientSession, ctx));
+ authFuture.addListener(future -> onAuthComplete(future, localSession, ctx));
}
- private void onAuthComplete(final AuthFuture future, final NettyAwareClientSession clientSession,
+ private synchronized void onAuthComplete(final AuthFuture authFuture, final NettyAwareClientSession clientSession,
final ChannelHandlerContext ctx) {
- final var cause = future.getException();
+ final var cause = authFuture.getException();
if (cause != null) {
- handleSshSetupFailure(ctx, new AuthenticationFailedException("Authentication failed", cause));
+ onOpenFailure(ctx, new AuthenticationFailedException("Authentication failed", cause));
return;
}
- onAuthComplete(clientSession, ctx);
- }
-
- private synchronized void onAuthComplete(final NettyAwareClientSession clientSession,
- final ChannelHandlerContext ctx) {
LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(),
clientSession.getServerVersion());
channel.setStreaming(ClientChannel.Streaming.Async);
openFuture = channel.open();
} catch (final IOException e) {
- handleSshSetupFailure(ctx, e);
+ onOpenFailure(ctx, e);
return;
}
openFuture.addListener(future -> onOpenComplete(future, ctx));
}
- private void onOpenComplete(final OpenFuture future, final ChannelHandlerContext ctx) {
- final var cause = future.getException();
+ private synchronized void onOpenComplete(final OpenFuture openFuture, final ChannelHandlerContext ctx) {
+ final var cause = openFuture.getException();
if (cause != null) {
- handleSshSetupFailure(ctx, cause);
+ onOpenFailure(ctx, cause);
return;
}
- handleSshChanelOpened(ctx);
+ LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel());
+ if (negotiationFuture == null) {
+ connectPromise.setSuccess();
+ }
+
+ sshWriteAsyncHandler = new AsyncSshHandlerWriter(channel.getAsyncIn());
+ ctx.fireChannelActive();
+ channel.onClose(() -> disconnect(ctx, ctx.newPromise()));
+ }
+
+ @Holding("this")
+ private void onOpenFailure(final ChannelHandlerContext ctx, final Throwable cause) {
+ LOG.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), cause);
+
+ // If the promise is not yet done, we have failed with initial connect and set connectPromise to failure
+ if (!connectPromise.isDone()) {
+ connectPromise.setFailure(cause);
+ }
+
+ disconnect(ctx, ctx.newPromise());
}
@Override
@Override
public void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
if (isDisconnected.compareAndSet(false, true)) {
- safelyDisconnect(ctx, promise);
+ ctx.executor().execute(() -> safelyDisconnect(ctx, promise));
}
}
+ // This method has the potential to interact with the channel pipeline, for example via fireChannelInactive(). These
+ // callbacks need to complete during execution of this method and therefore this method needs to be executing on
+ // the channel's executor.
@SuppressWarnings("checkstyle:IllegalCatch")
private synchronized void safelyDisconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
- LOG.trace("Closing SSH session on channel: {} with connect promise in state: {}",
- ctx.channel(), connectPromise);
+ LOG.trace("Closing SSH session on channel: {} with connect promise in state: {}", ctx.channel(),
+ connectPromise);
// If we have already succeeded and the session was dropped after,
// we need to fire inactive to notify reconnect logic
Code Review / netconf.git / blobdiff