net.sf.sshapi.forwarding

Interface SshPortForwardTunnel

All Superinterfaces:

SshDataProducingComponent, SshLifecycleComponent

public interface SshPortForwardTunnel
extends SshDataProducingComponent

Represents a single tunneled connection that is spawned as the result of a client making a connection to the listening socket of a configured port forward.

For example, if a single port forward to a web server address has been configured, upon using entering the tunneled URL the browser will make multiple concurrent connections. For each connection that browser makes, all registered SshPortForwardListener will be notified via SshPortForwardListener#channelOpened(int, SshLifecycleComponent).

The browser will eventually time-out, and start closing all the connections it made. When this happens, SshPortForwardListener#channelClosed(int, SshLifecycleComponent) will be fired.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBindAddress() Get the address that the tunnel will listen on.
int	getBindPort() Get the port that the tunnel will listen on.
java.lang.String	getOriginatingAddress() Get the address the tunnel connection originated from
int	getOriginatingPort() Get the port the tunnel connection originated from

Methods inherited from interface net.sf.sshapi.SshDataProducingComponent

addDataListener, removeDataListener

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Method Detail

getOriginatingAddress

java.lang.String getOriginatingAddress()

Get the address the tunnel connection originated from

Returns:

target address

See Also:

getOriginatingPort()

getOriginatingPort

int getOriginatingPort()

Get the port the tunnel connection originated from

Returns:

port

See Also:

getOriginatingAddress()

getBindAddress

java.lang.String getBindAddress()

Get the address that the tunnel will listen on. Depending on the type of tunnel, this will either be an interface address on the the local machine, or an interface address on the remote SSH server.

Returns:

address to listen on

See Also:

getBindPort()

getBindPort

int getBindPort()

Get the port that the tunnel will listen on. Depending on the type of tunnel, this will either be on an interface address on the the local machine, or on an interface address on the remote SSH server.

Returns:

port to listen on

See Also:

getBindAddress()