org.apache.sshd.common.forward

Interface TcpipForwarder

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Implementing Classes:

DefaultTcpipForwarder

public interface TcpipForwarder
extends Closeable

Method Summary

Modifier and Type	Method and Description
SshdSocketAddress	getForwardedPort(int remotePort)
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.

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

close, isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

startLocalPortForwarding

SshdSocketAddress startLocalPortForwarding(SshdSocketAddress local,
                                           SshdSocketAddress remote)
                                    throws IOException

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

Parameters:

remote - The remote address

local - The local address

Returns:

The bound SshdSocketAddress

Throws:

IOException - If failed to handle request

stopLocalPortForwarding

void stopLocalPortForwarding(SshdSocketAddress local)
                      throws IOException

Stop forwarding the given local address.

Parameters:

local - The local address

Throws:

IOException - If failed to handle request

startRemotePortForwarding

SshdSocketAddress startRemotePortForwarding(SshdSocketAddress remote,
                                            SshdSocketAddress local)
                                     throws IOException

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

Parameters:

remote - The remote address

local - The local address

Returns:

The bound SshdSocketAddress

Throws:

IOException - If failed to handle request

stopRemotePortForwarding

void stopRemotePortForwarding(SshdSocketAddress remote)
                       throws IOException

Stop forwarding of the given remote address.

Parameters:

remote - The remote SshdSocketAddress

Throws:

IOException - If failed to handle request

getForwardedPort

SshdSocketAddress getForwardedPort(int remotePort)

Parameters:

remotePort - The remote port

Returns:

The local SshdSocketAddress that the remote port is forwarded to

localPortForwardingRequested

SshdSocketAddress localPortForwardingRequested(SshdSocketAddress local)
                                        throws IOException

Called when the other side requested a remote port forward.

Parameters:

local - The request address

Returns:

The bound local addresses

Throws:

IOException - If failed to handle request

localPortForwardingCancelled

void localPortForwardingCancelled(SshdSocketAddress local)
                           throws IOException

Called when the other side cancelled a remote port forward.

Parameters:

local - The local SshdSocketAddress

Throws:

IOException - If failed to handle request

startDynamicPortForwarding

SshdSocketAddress startDynamicPortForwarding(SshdSocketAddress local)
                                      throws IOException

Throws:

IOException

stopDynamicPortForwarding

void stopDynamicPortForwarding(SshdSocketAddress local)
                        throws IOException

Throws:

IOException