org.apache.sshd.common

Interface TcpipForwarder

All Superinterfaces:

Closeable

All Known Implementing Classes:

DefaultTcpipForwarder

public interface TcpipForwarder
extends Closeable

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Deprecated.
SshdSocketAddress	getForwardedPort(int remotePort) Retrieve the local address that the remote port is forwarded to
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	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 interface org.apache.sshd.common.Closeable

close

Method Detail

startLocalPortForwarding

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

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

Throws:

java.io.IOException

stopLocalPortForwarding

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

Stop forwarding the given local address.

Throws:

java.io.IOException

startRemotePortForwarding

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

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

Throws:

java.io.IOException

stopRemotePortForwarding

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

Stop forwarding of the given remote address.

Throws:

java.io.IOException

getForwardedPort

SshdSocketAddress getForwardedPort(int remotePort)

Retrieve the local address that the remote port is forwarded to

Parameters:

remotePort -

Returns:

localPortForwardingRequested

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

Called when the other side requested a remote port forward.

Parameters:

local -

Returns:

the list of bound local addresses

Throws:

java.lang.Exception

java.io.IOException

localPortForwardingCancelled

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

Called when the other side cancelled a remote port forward.

Parameters:

local -

Throws:

java.lang.Exception

java.io.IOException

close

@Deprecated
void close()

Deprecated.

Close the forwarder