com.helger.jsch.tunnel

Class Tunnel

java.lang.Object

com.helger.jsch.tunnel.Tunnel

public class Tunnel
extends Object

Tunnel stores all the information needed to define an ssh port-forwarding tunnel.

See Also:

rfc4254

Constructor Summary

Constructors

Constructor and Description
Tunnel(int localPort, String destinationHostname, int destinationPort) Creates a Tunnel to destinationPort on destinationHostname from localPort on localhost.
Tunnel(String sSpec) Creates a Tunnel from a spec string.
Tunnel(String destinationHostname, int destinationPort) Creates a Tunnel to destinationPort on destinationHostname from a dynamically assigned port on localhost.
Tunnel(String localAlias, int localPort, String destinationHostname, int destinationPort) Creates a Tunnel to destinationPort on destinationHostname from localPort on localAlias.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getAssignedLocalPort() Returns the local port currently bound to.
String	getAsString()
String	getDestinationHostname() Returns the hostname of the destination.
int	getDestinationPort() Returns the port of the destination.
String	getLocalAlias() Returns the local alias bound to.
int	getLocalPort() Returns the port this tunnel was configured with.
String	getSpec() Returns the spec string (either calculated or specified) for this tunnel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tunnel

public Tunnel(@Nonnull @Nonempty
              String sSpec)

Creates a Tunnel from a spec string. For details on this string, see getSpec().

Both localAlias and localPort are optional, in which case they default to localhost and 0 respectively.

Examples:

 // Equivalaent to new Tunnel("localhost", 0, "foobar", 1234);
 new Tunnel ("foobar:1234");
 // Equivalaent to new Tunnel("localhost", 1234, "foobar", 1234);
 new Tunnel ("1234:foobar:1234");
 // Equivalaent to new Tunnel("local_foobar", 1234, "foobar", 1234);
 new Tunnel ("local_foobar:1234:foobar:1234");
 

Parameters:

sSpec - A tunnel spec string

See Also:

Tunnel(String, int, String, int), rfc4254

Tunnel

public Tunnel(String destinationHostname,
              int destinationPort)

Creates a Tunnel to destinationPort on destinationHostname from a dynamically assigned port on localhost. Simply calls

Parameters:

destinationHostname - The hostname to tunnel to

destinationPort - The port to tunnel to

See Also:

Tunnel(int, String, int), rfc4254

Tunnel

public Tunnel(int localPort,
              String destinationHostname,
              int destinationPort)

Creates a Tunnel to destinationPort on destinationHostname from localPort on localhost.

Parameters:

localPort - The local port to bind to

destinationHostname - The hostname to tunnel to

destinationPort - The port to tunnel to

See Also:

Tunnel(String, int, String, int), rfc4254

Tunnel

public Tunnel(String localAlias,
              int localPort,
              String destinationHostname,
              int destinationPort)

Creates a Tunnel to destinationPort on destinationHostname from localPort on localAlias.

This is similar in behavior to the -L option in ssh, with the exception that you can specify 0 for the local port in which case the port will be dynamically allocated and you can getAssignedLocalPort() after the tunnel has been started.

A common use case for localAlias might be to link your loopback interfaces to names via an entries in /etc/hosts which would allow you to use the same port number for more than one tunnel. For example:

 127.0.0.2 foo
 127.0.0.3 bar
 

Would allow you to have both of these open at the same time:

 new Tunnel ("foo", 1234, "remote_foo", 1234);
 new Tunnel ("bar", 1234, "remote_bar", 1234);
 

Parameters:

localAlias - The local interface to bind to

localPort - The local port to bind to

destinationHostname - The hostname to tunnel to

destinationPort - The port to tunnel to

See Also:

Session.setPortForwardingL(String, int, String, int), rfc4254

Method Detail

getAssignedLocalPort

public int getAssignedLocalPort()

Returns the local port currently bound to. If 0 was specified as the port to bind to, this will return the dynamically allocated port, otherwise it will return the port specified.

Returns:

The local port currently bound to

getDestinationHostname

public String getDestinationHostname()

Returns the hostname of the destination.

Returns:

The hostname of the destination

getDestinationPort

public int getDestinationPort()

Returns the port of the destination.

Returns:

The port of the destination

getLocalAlias

public String getLocalAlias()

Returns the local alias bound to. See rfc4254 for details on acceptible values.

Returns:

The local alias bound to

getLocalPort

public int getLocalPort()

Returns the port this tunnel was configured with. If you want to get the runtime port, use getAssignedLocalPort().

Returns:

The port this tunnel was configured with

getSpec

@Nonnull
public String getSpec()

Returns the spec string (either calculated or specified) for this tunnel.

A spec string is composed of 4 parts separated by a colon (: ):

1. localAlias (optional)
2. localPort (optional)
3. destinationHostname
4. destinationPort

Returns:

The spec string

getAsString

@Nonnull
public String getAsString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object