org.apache.sshd.common.forward

Class DefaultTcpipForwarder

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.forward.DefaultTcpipForwarder

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, TcpipForwarder

public class DefaultTcpipForwarder
extends CloseableUtils.AbstractInnerCloseable
implements TcpipForwarder

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

Field Summary

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
DefaultTcpipForwarder(ConnectionService service)

Method Summary

Modifier and Type	Method and Description
ConnectionService	getConnectionService()
SshdSocketAddress	getForwardedPort(int remotePort)
protected Closeable	getInnerCloseable()
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.
SshdSocketAddress	startDynamicPortForwarding(SshdSocketAddress local)
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 tcp/ip from the given remote address to the given local address.
void	stopDynamicPortForwarding(SshdSocketAddress local)
void	stopLocalPortForwarding(SshdSocketAddress local) Stop forwarding the given local address.
void	stopRemotePortForwarding(SshdSocketAddress remote) Stop forwarding of the given remote address.
String	toString()

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.Closeable

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Constructor Detail

DefaultTcpipForwarder

public DefaultTcpipForwarder(ConnectionService service)

Method Detail

getConnectionService

public final ConnectionService getConnectionService()

startLocalPortForwarding

public SshdSocketAddress startLocalPortForwarding(SshdSocketAddress local,
                                                  SshdSocketAddress remote)
                                           throws 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

Parameters:

local - The local address

remote - The remote address

Returns:

The bound SshdSocketAddress

Throws:

IOException - If failed to handle request

stopLocalPortForwarding

public void stopLocalPortForwarding(SshdSocketAddress local)
                             throws IOException

Description copied from interface: TcpipForwarder

Stop forwarding the given local address.

Specified by:

stopLocalPortForwarding in interface TcpipForwarder

Parameters:

local - The local address

Throws:

IOException - If failed to handle request

startRemotePortForwarding

public SshdSocketAddress startRemotePortForwarding(SshdSocketAddress remote,
                                                   SshdSocketAddress local)
                                            throws IOException

Description copied from interface: TcpipForwarder

Start forwarding tcp/ip 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

Parameters:

remote - The remote address

local - The local address

Returns:

The bound SshdSocketAddress

Throws:

IOException - If failed to handle request

stopRemotePortForwarding

public void stopRemotePortForwarding(SshdSocketAddress remote)
                              throws IOException

Description copied from interface: TcpipForwarder

Stop forwarding of the given remote address.

Specified by:

stopRemotePortForwarding in interface TcpipForwarder

Parameters:

remote - The remote SshdSocketAddress

Throws:

IOException - If failed to handle request

startDynamicPortForwarding

public SshdSocketAddress startDynamicPortForwarding(SshdSocketAddress local)
                                             throws IOException

Specified by:

startDynamicPortForwarding in interface TcpipForwarder

Throws:

IOException

stopDynamicPortForwarding

public void stopDynamicPortForwarding(SshdSocketAddress local)
                               throws IOException

Specified by:

stopDynamicPortForwarding in interface TcpipForwarder

Throws:

IOException

getForwardedPort

public SshdSocketAddress getForwardedPort(int remotePort)

Specified by:

getForwardedPort in interface TcpipForwarder

Parameters:

remotePort - The remote port

Returns:

The local SshdSocketAddress that the remote port is forwarded to

localPortForwardingRequested

public SshdSocketAddress localPortForwardingRequested(SshdSocketAddress local)
                                               throws IOException

Description copied from interface: TcpipForwarder

Called when the other side requested a remote port forward.

Specified by:

localPortForwardingRequested in interface TcpipForwarder

Parameters:

local - The request address

Returns:

The bound local addresses

Throws:

IOException - If failed to handle request

localPortForwardingCancelled

public void localPortForwardingCancelled(SshdSocketAddress local)
                                  throws IOException

Description copied from interface: TcpipForwarder

Called when the other side cancelled a remote port forward.

Specified by:

localPortForwardingCancelled in interface TcpipForwarder

Parameters:

local - The local SshdSocketAddress

Throws:

IOException - If failed to handle request

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class CloseableUtils.AbstractInnerCloseable

toString

public String toString()

Overrides:

toString in class Object