Package org.opendaylight.netconf.nettyutil.handler.ssh.client

Class AsyncSshHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

org.opendaylight.netconf.nettyutil.handler.ssh.client.AsyncSshHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

public class AsyncSshHandler
extends io.netty.channel.ChannelOutboundHandlerAdapter

Netty SSH handler class. Acts as interface between Netty and SSH library.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.sshd.client.SshClient	DEFAULT_CLIENT
static int	SSH_DEFAULT_NIO_WORKERS
static String	SUBSYSTEM

Constructor Summary

Constructors

Constructor	Description
AsyncSshHandler(AuthenticationHandler authenticationHandler, org.apache.sshd.client.SshClient sshClient)	Constructor of AsyncSshHandler.
AsyncSshHandler(AuthenticationHandler authenticationHandler, org.apache.sshd.client.SshClient sshClient, io.netty.util.concurrent.Future<?> negotiationFuture)

Method Summary

Modifier and Type	Method	Description
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
static AsyncSshHandler	createForNetconfSubsystem(AuthenticationHandler authenticationHandler)
static AsyncSshHandler	createForNetconfSubsystem(AuthenticationHandler authenticationHandler, io.netty.util.concurrent.Future<?> negotiationFuture, @Nullable org.apache.sshd.client.SshClient sshClient)	Create AsyncSshHandler for netconf subsystem.
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, deregister, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Field Detail

SUBSYSTEM

public static final String SUBSYSTEM

See Also:

Constant Field Values

SSH_DEFAULT_NIO_WORKERS

public static final int SSH_DEFAULT_NIO_WORKERS

See Also:

Constant Field Values

DEFAULT_CLIENT

public static final org.apache.sshd.client.SshClient DEFAULT_CLIENT

Constructor Detail

AsyncSshHandler

public AsyncSshHandler(AuthenticationHandler authenticationHandler,
                       org.apache.sshd.client.SshClient sshClient,
                       io.netty.util.concurrent.Future<?> negotiationFuture)

AsyncSshHandler

public AsyncSshHandler(AuthenticationHandler authenticationHandler,
                       org.apache.sshd.client.SshClient sshClient)

Constructor of AsyncSshHandler.

Parameters:

authenticationHandler - authentication handler

sshClient - started SshClient

Method Detail

createForNetconfSubsystem

public static AsyncSshHandler createForNetconfSubsystem(AuthenticationHandler authenticationHandler)

createForNetconfSubsystem

public static AsyncSshHandler createForNetconfSubsystem(AuthenticationHandler authenticationHandler,
                                                        io.netty.util.concurrent.Future<?> negotiationFuture,
                                                        @Nullable org.apache.sshd.client.SshClient sshClient)

Create AsyncSshHandler for netconf subsystem. Negotiation future has to be set to success after successful netconf negotiation.

Parameters:

authenticationHandler - authentication handler

negotiationFuture - negotiation future

Returns:

AsyncSshHandler

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelOutboundHandlerAdapter

connect

public void connect(io.netty.channel.ChannelHandlerContext ctx,
                    SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    io.netty.channel.ChannelPromise promise)
             throws Exception

Specified by:

connect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

connect in class io.netty.channel.ChannelOutboundHandlerAdapter

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
                  io.netty.channel.ChannelPromise promise)

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

Overrides:

close in class io.netty.channel.ChannelOutboundHandlerAdapter

disconnect

public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

disconnect in class io.netty.channel.ChannelOutboundHandlerAdapter