org.apache.sshd.common.forward

Class DefaultTcpipForwarder

java.lang.Object

org.apache.sshd.common.forward.DefaultTcpipForwarder

All Implemented Interfaces:

Closeable, IoHandler, TcpipForwarder

public class DefaultTcpipForwarder
extends java.lang.Object
implements TcpipForwarder, IoHandler

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected IoAcceptor	acceptor

Constructor Summary

Constructors

Constructor and Description
DefaultTcpipForwarder(ConnectionService service)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the forwarder
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
void	exceptionCaught(IoSession session, java.lang.Throwable cause)
SshdSocketAddress	getForwardedPort(int remotePort) Retrieve the local address that the remote port is forwarded to
void	initialize()
void	localPortForwardingCancelled(SshdSocketAddress local) Called when the other side cancelled a remote port forward.
SshdSocketAddress	localPortForwardingRequested(SshdSocketAddress local) Called when the other side requested a remote port forward.
void	messageReceived(IoSession session, Readable message)
void	sessionClosed(IoSession session)
void	sessionCreated(IoSession session)
SshdSocketAddress	startLocalPortForwarding(SshdSocketAddress local, SshdSocketAddress remote) Start forwarding the given local address on the client to the given address on the server.
SshdSocketAddress	startRemotePortForwarding(SshdSocketAddress remote, SshdSocketAddress local) Start forwarding tcpip from the given remote address to the given local address.
void	stopLocalPortForwarding(SshdSocketAddress local) Stop forwarding the given local address.
void	stopRemotePortForwarding(SshdSocketAddress remote) Stop forwarding of the given remote address.

Methods inherited from class java.lang.Object

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

Field Detail

acceptor

protected IoAcceptor acceptor

Constructor Detail

DefaultTcpipForwarder

public DefaultTcpipForwarder(ConnectionService service)

Method Detail

startLocalPortForwarding

public SshdSocketAddress startLocalPortForwarding(SshdSocketAddress local,
                                         SshdSocketAddress remote)
                                           throws java.io.IOException

Description copied from interface: TcpipForwarder

Start forwarding the given local address on the client to the given address on the server.

Specified by:

startLocalPortForwarding in interface TcpipForwarder

Throws:

java.io.IOException

stopLocalPortForwarding

public void stopLocalPortForwarding(SshdSocketAddress local)
                             throws java.io.IOException

Description copied from interface: TcpipForwarder

Stop forwarding the given local address.

Specified by:

stopLocalPortForwarding in interface TcpipForwarder

Throws:

java.io.IOException

startRemotePortForwarding

public SshdSocketAddress startRemotePortForwarding(SshdSocketAddress remote,
                                          SshdSocketAddress local)
                                            throws java.io.IOException

Description copied from interface: TcpipForwarder

Start forwarding tcpip from the given remote address to the given local address. The remote host name is the address to bind to on the server:

• "" means that connections are to be accepted on all protocol families supported by the SSH implementation
• "0.0.0.0" means to listen on all IPv4 addresses
• "::" means to listen on all IPv6 addresses
• "localhost" means to listen on all protocol families supported by the SSH implementation on loopback addresses only, [RFC3330] and RFC3513]
• "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6 respectively

Specified by:

startRemotePortForwarding in interface TcpipForwarder

Throws:

java.io.IOException

stopRemotePortForwarding

public void stopRemotePortForwarding(SshdSocketAddress remote)
                              throws java.io.IOException

Description copied from interface: TcpipForwarder

Stop forwarding of the given remote address.

Specified by:

stopRemotePortForwarding in interface TcpipForwarder

Throws:

java.io.IOException

getForwardedPort

public SshdSocketAddress getForwardedPort(int remotePort)

Description copied from interface: TcpipForwarder

Retrieve the local address that the remote port is forwarded to

Specified by:

getForwardedPort in interface TcpipForwarder

Returns:

localPortForwardingRequested

public SshdSocketAddress localPortForwardingRequested(SshdSocketAddress local)
                                               throws java.io.IOException

Description copied from interface: TcpipForwarder

Called when the other side requested a remote port forward.

Specified by:

localPortForwardingRequested in interface TcpipForwarder

Returns:

the list of bound local addresses

Throws:

java.io.IOException

localPortForwardingCancelled

public void localPortForwardingCancelled(SshdSocketAddress local)
                                  throws java.io.IOException

Description copied from interface: TcpipForwarder

Called when the other side cancelled a remote port forward.

Specified by:

localPortForwardingCancelled in interface TcpipForwarder

Throws:

java.io.IOException

initialize

public void initialize()

close

public void close()

Description copied from interface: TcpipForwarder

Close the forwarder

Specified by:

close in interface TcpipForwarder

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

sessionCreated

public void sessionCreated(IoSession session)
                    throws java.lang.Exception

Specified by:

sessionCreated in interface IoHandler

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws java.lang.Exception

Specified by:

sessionClosed in interface IoHandler

Throws:

java.lang.Exception

messageReceived

public void messageReceived(IoSession session,
                   Readable message)
                     throws java.lang.Exception

Specified by:

messageReceived in interface IoHandler

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(IoSession session,
                   java.lang.Throwable cause)
                     throws java.lang.Exception

Specified by:

exceptionCaught in interface IoHandler

Throws:

java.lang.Exception