com.sshtools.ssh

Interface SshTunnel

All Superinterfaces:

SshChannel, SshIO, SshTransport

public interface SshTunnel
extends SshChannel, SshTransport

Interface defining the contract for SSH forwarding channels.

Forwarding channels can either be local or remote. Local forwarding transfers data from the local computer to the remote side where it is delivered to the specified host. Remote forwarding is when the remote computer forwards data to the local side.

Author:

Lee David Painter

Method Summary

Methods

Modifier and Type	Method and Description
String	getListeningAddress() The source ip address of the connection that is being forwarded.
int	getListeningPort() The source port of the connection being forwarded.
String	getOriginatingHost() The host that made the initial connection to the listening address.
int	getOriginatingPort() The port of the initial connection.
int	getPort() The port to which the data is being forwarded.
SshTransport	getTransport() The connection being forwarded (local forwarding) or the destination of the forwarding (remote forwarding).
boolean	isLocal() Determines the type of forwarding channel.
boolean	isLocalEOF()
boolean	isRemoteEOF()
boolean	isX11() Determine if this channel is an X11 forwarding channel.

Methods inherited from interface com.sshtools.ssh.SshChannel

addChannelEventListener, getChannelId, getMessageRouter, isClosed, setAutoConsumeInput

Methods inherited from interface com.sshtools.ssh.SshTransport

duplicate, getHost

Methods inherited from interface com.sshtools.ssh.SshIO

close, getInputStream, getOutputStream

Method Detail

getPort

int getPort()

The port to which the data is being forwarded.

Specified by:

getPort in interface SshTransport

Returns:

int

getListeningAddress

String getListeningAddress()

The source ip address of the connection that is being forwarded.

Returns:

String

getListeningPort

int getListeningPort()

The source port of the connection being forwarded.

Returns:

int

getOriginatingHost

String getOriginatingHost()

The host that made the initial connection to the listening address.

Returns:

String

getOriginatingPort

int getOriginatingPort()

The port of the initial connection.

Returns:

int

isLocal

boolean isLocal()

Determines the type of forwarding channel.

Returns:

true if the forwarding is local, otherwise false for remote forwarding.

isX11

boolean isX11()

Determine if this channel is an X11 forwarding channel.

Returns:

boolean

getTransport

SshTransport getTransport()

The connection being forwarded (local forwarding) or the destination of the forwarding (remote forwarding).

Returns:

SshTransport

isLocalEOF

boolean isLocalEOF()

isRemoteEOF

boolean isRemoteEOF()