X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fnetconf-netty-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fnettyutil%2Fhandler%2Fssh%2Fclient%2FAsyncSshHandler.java;h=149ccf16f9910dfbf38a866f5c0d89fbda50c7b6;hb=0f45153d60a0fc71a08d011e21fdf5e83c174290;hp=cb642c1a9954cba715cbb381431f9467c3c731c3;hpb=5a68db96acc2e92c82cbaee71f09df1634b81d10;p=netconf.git diff --git a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java index cb642c1a99..149ccf16f9 100644 --- a/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java +++ b/netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/ssh/client/AsyncSshHandler.java @@ -9,7 +9,6 @@ package org.opendaylight.netconf.nettyutil.handler.ssh.client; import com.google.common.base.Preconditions; -import io.netty.buffer.ByteBuf; import io.netty.channel.ChannelHandlerContext; import io.netty.channel.ChannelOutboundHandlerAdapter; import io.netty.channel.ChannelPromise; @@ -17,16 +16,11 @@ import io.netty.util.concurrent.Future; import io.netty.util.concurrent.GenericFutureListener; import java.io.IOException; import java.net.SocketAddress; -import java.util.HashMap; -import java.util.Map; -import org.apache.sshd.ClientChannel; -import org.apache.sshd.ClientSession; -import org.apache.sshd.SshClient; +import org.apache.sshd.client.SshClient; +import org.apache.sshd.client.channel.ClientChannel; import org.apache.sshd.client.future.AuthFuture; import org.apache.sshd.client.future.ConnectFuture; -import org.apache.sshd.client.future.OpenFuture; -import org.apache.sshd.common.future.CloseFuture; -import org.apache.sshd.common.future.SshFutureListener; +import org.apache.sshd.client.session.ClientSession; import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -44,14 +38,12 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { private static final long DEFAULT_TIMEOUT = -1L; public static final SshClient DEFAULT_CLIENT; - static { - final Map props = new HashMap<>(); - props.put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); - props.put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); + static { final SshClient c = SshClient.setUpDefaultClient(); + c.getProperties().put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); + c.getProperties().put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT)); - c.setProperties(props); // TODO make configurable, or somehow reuse netty threadpool c.setNioWorkers(SSH_DEFAULT_NIO_WORKERS); c.start(); @@ -71,53 +63,49 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { private GenericFutureListener negotiationFutureListener; public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final SshClient sshClient, - final Future negotiationFuture) throws IOException { + final Future negotiationFuture) { this(authenticationHandler, sshClient); this.negotiationFuture = negotiationFuture; } /** + * Constructor of {@code AsyncSshHandler}. * - * @param authenticationHandler - * @param sshClient started SshClient - * @throws IOException + * @param authenticationHandler authentication handler + * @param sshClient started SshClient */ - public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final SshClient sshClient) throws IOException { + public AsyncSshHandler(final AuthenticationHandler authenticationHandler, + final SshClient sshClient) { this.authenticationHandler = Preconditions.checkNotNull(authenticationHandler); this.sshClient = Preconditions.checkNotNull(sshClient); } - public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) throws IOException { + public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) { return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT); } /** + * Create AsyncSshHandler for netconf subsystem. Negotiation future has to be set to success after successful + * netconf negotiation. * - * Create AsyncSshHandler for netconf subsystem. Negotiation future has to be set to success after successful netconf - * negotiation. - * - * @param authenticationHandler - * @param negotiationFuture - * @return - * @throws IOException + * @param authenticationHandler authentication handler + * @param negotiationFuture negotiation future + * @return {@code AsyncSshHandler} */ public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler, - final Future negotiationFuture) throws IOException { + final Future negotiationFuture) { return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT, negotiationFuture); } - private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) { + private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) throws IOException { LOG.debug("Starting SSH to {} on channel: {}", address, ctx.channel()); final ConnectFuture sshConnectionFuture = sshClient.connect(authenticationHandler.getUsername(), address); - sshConnectionFuture.addListener(new SshFutureListener() { - @Override - public void operationComplete(final ConnectFuture future) { - if (future.isConnected()) { - handleSshSessionCreated(future, ctx); - } else { - handleSshSetupFailure(ctx, future.getException()); - } + sshConnectionFuture.addListener(future -> { + if (future.isConnected()) { + handleSshSessionCreated(future, ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); } }); } @@ -128,18 +116,15 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { session = future.getSession(); final AuthFuture authenticateFuture = authenticationHandler.authenticate(session); - authenticateFuture.addListener(new SshFutureListener() { - @Override - public void operationComplete(final AuthFuture future) { - if (future.isSuccess()) { - handleSshAuthenticated(session, ctx); - } else { - // Exception does not have to be set in the future, add simple exception in such case - final Throwable exception = future.getException() == null ? - new IllegalStateException("Authentication failed") : - future.getException(); - handleSshSetupFailure(ctx, exception); - } + final ClientSession localSession = session; + authenticateFuture.addListener(future1 -> { + if (future1.isSuccess()) { + handleSshAuthenticated(localSession, ctx); + } else { + // Exception does not have to be set in the future, add simple exception in such case + final Throwable exception = future1.getException() == null + ? new IllegalStateException("Authentication failed") : future1.getException(); + handleSshSetupFailure(ctx, exception); } }); } catch (final IOException e) { @@ -147,20 +132,18 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } } - private synchronized void handleSshAuthenticated(final ClientSession session, final ChannelHandlerContext ctx) { + private synchronized void handleSshAuthenticated(final ClientSession newSession, final ChannelHandlerContext ctx) { try { - LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), session.getServerVersion()); + LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(), + newSession.getServerVersion()); - channel = session.createSubsystemChannel(SUBSYSTEM); + channel = newSession.createSubsystemChannel(SUBSYSTEM); channel.setStreaming(ClientChannel.Streaming.Async); - channel.open().addListener(new SshFutureListener() { - @Override - public void operationComplete(final OpenFuture future) { - if(future.isOpened()) { - handleSshChanelOpened(ctx); - } else { - handleSshSetupFailure(ctx, future.getException()); - } + channel.open().addListener(future -> { + if (future.isOpened()) { + handleSshChanelOpened(ctx); + } else { + handleSshSetupFailure(ctx, future.getException()); } }); @@ -173,37 +156,30 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { private synchronized void handleSshChanelOpened(final ChannelHandlerContext ctx) { LOG.trace("SSH subsystem channel opened successfully on channel: {}", ctx.channel()); - if(negotiationFuture == null) { + if (negotiationFuture == null) { connectPromise.setSuccess(); } // TODO we should also read from error stream and at least log from that - sshReadAsyncListener = new AsyncSshHandlerReader(new AutoCloseable() { - @Override - public void close() throws Exception { - AsyncSshHandler.this.disconnect(ctx, ctx.newPromise()); - } - }, new AsyncSshHandlerReader.ReadMsgHandler() { - @Override - public void onMessageRead(final ByteBuf msg) { - ctx.fireChannelRead(msg); - } - }, channel.toString(), channel.getAsyncOut()); + ClientChannel localChannel = channel; + sshReadAsyncListener = new AsyncSshHandlerReader(() -> AsyncSshHandler.this.disconnect(ctx, ctx.newPromise()), + ctx::fireChannelRead, localChannel.toString(), localChannel.getAsyncOut()); - // if readAsyncListener receives immediate close, it will close this handler and closing this handler sets channel variable to null - if(channel != null) { + // if readAsyncListener receives immediate close, + // it will close this handler and closing this handler sets channel variable to null + if (channel != null) { sshWriteAsyncHandler = new AsyncSshHandlerWriter(channel.getAsyncIn()); ctx.fireChannelActive(); } } - private synchronized void handleSshSetupFailure(final ChannelHandlerContext ctx, final Throwable e) { - LOG.warn("Unable to setup SSH connection on channel: {}", ctx.channel(), e); + 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(e); + if (!connectPromise.isDone()) { + connectPromise.setFailure(error); } disconnect(ctx, ctx.newPromise()); @@ -215,18 +191,15 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } @Override - public synchronized void connect(final ChannelHandlerContext ctx, final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) throws Exception { + public synchronized void connect(final ChannelHandlerContext ctx, final SocketAddress remoteAddress, + final SocketAddress localAddress, final ChannelPromise promise) throws Exception { LOG.debug("SSH session connecting on channel {}. promise: {} ", ctx.channel(), connectPromise); this.connectPromise = promise; - if(negotiationFuture != null) { - - negotiationFutureListener = new GenericFutureListener>() { - @Override - public void operationComplete(final Future future) { - if (future.isSuccess()) { - connectPromise.setSuccess(); - } + if (negotiationFuture != null) { + negotiationFutureListener = future -> { + if (future.isSuccess()) { + promise.setSuccess(); } }; //complete connection promise with netconf negotiation future @@ -236,44 +209,46 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { } @Override - public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception { + public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) { disconnect(ctx, promise); } + @SuppressWarnings("checkstyle:IllegalCatch") @Override public synchronized void disconnect(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 - if(connectPromise.isSuccess()) { + // If we have already succeeded and the session was dropped after, + // we need to fire inactive to notify reconnect logic + if (connectPromise.isSuccess()) { ctx.fireChannelInactive(); } - if(sshWriteAsyncHandler != null) { + if (sshWriteAsyncHandler != null) { sshWriteAsyncHandler.close(); } - if(sshReadAsyncListener != null) { + if (sshReadAsyncListener != null) { sshReadAsyncListener.close(); } //If connection promise is not already set, it means negotiation failed //we must set connection promise to failure - if(!connectPromise.isDone()) { + if (!connectPromise.isDone()) { connectPromise.setFailure(new IllegalStateException("Negotiation failed")); } //Remove listener from negotiation future, we don't want notifications //from negotiation anymore - if(negotiationFuture != null) { + if (negotiationFuture != null) { negotiationFuture.removeListener(negotiationFutureListener); } - if(session!= null && !session.isClosed() && !session.isClosing()) { - session.close(false).addListener(new SshFutureListener() { - @Override - public void operationComplete(final CloseFuture future) { - if (future.isClosed() == false) { + if (session != null && !session.isClosed() && !session.isClosing()) { + session.close(false).addListener(future -> { + synchronized (this) { + if (!future.isClosed()) { session.close(true); } session = null; @@ -281,9 +256,11 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter { }); } - // Super disconnect is necessary in this case since we are using NioSocketChannel and it needs to cleanup its resources - // e.g. Socket that it tries to open in its constructor (https://bugs.opendaylight.org/show_bug.cgi?id=2430) - // TODO better solution would be to implement custom ChannelFactory + Channel that will use mina SSH lib internally: port this to custom channel implementation + // Super disconnect is necessary in this case since we are using NioSocketChannel and it needs + // to cleanup its resources e.g. Socket that it tries to open in its constructor + // (https://bugs.opendaylight.org/show_bug.cgi?id=2430) + // TODO better solution would be to implement custom ChannelFactory + Channel + // that will use mina SSH lib internally: port this to custom channel implementation try { // Disconnect has to be closed after inactive channel event was fired, because it interferes with it super.disconnect(ctx, ctx.newPromise());