com.helger.jsch.tunnel

Class TunnelConnection

java.lang.Object

com.helger.jsch.tunnel.TunnelConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public class TunnelConnection
extends Object
implements Closeable

A TunnelConnection represents an ssh connection that opens one or more Tunnel's.

Constructor Summary

Constructors

Constructor and Description
TunnelConnection(ISessionFactory sessionFactory, int localPort, String destinationHostname, int destinationPort) Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a single tunnel defined by Tunnel(localPort, destinationHostname, destinationPort).
TunnelConnection(ISessionFactory sessionFactory, List<Tunnel> tunnels) Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.
TunnelConnection(ISessionFactory sessionFactory, Tunnel... tunnels) Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying ssh session causing all tunnels to be closed.
String	getAsString()
Tunnel	getTunnel(String destinationHostname, int destinationPort) Returns the tunnel matching the supplied values, or null if there isn't one that matches.
boolean	isOpen() Returns true if the underlying ssh session is open.
void	open() Opens a session and connects all of the tunnels.
void	reopen() Closes, and re-opens the session and all its tunnels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TunnelConnection

public TunnelConnection(ISessionFactory sessionFactory,
                        int localPort,
                        String destinationHostname,
                        int destinationPort)

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a single tunnel defined by Tunnel(localPort, destinationHostname, destinationPort).

Parameters:

sessionFactory - The sessionFactory

localPort - The local port to bind to

destinationHostname - The destination hostname to tunnel to

destinationPort - The destination port to tunnel to

TunnelConnection

public TunnelConnection(ISessionFactory sessionFactory,
                        Tunnel... tunnels)

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.

Parameters:

sessionFactory - The sessionFactory

tunnels - The tunnels

TunnelConnection

public TunnelConnection(ISessionFactory sessionFactory,
                        List<Tunnel> tunnels)

Creates a TunnelConnection using the the sessionFactory to obtain its ssh connection with a list of Tunnel's.

Parameters:

sessionFactory - The sessionFactory

tunnels - The tunnels

Method Detail

close

public void close()
           throws IOException

Closes the underlying ssh session causing all tunnels to be closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getTunnel

public Tunnel getTunnel(String destinationHostname,
                        int destinationPort)

Returns the tunnel matching the supplied values, or null if there isn't one that matches.

Parameters:

destinationHostname - The tunnels destination hostname

destinationPort - The tunnels destination port

Returns:

The tunnel matching the supplied values

isOpen

public boolean isOpen()

Returns true if the underlying ssh session is open.

Returns:

True if the underlying ssh session is open

open

public void open()
          throws com.jcraft.jsch.JSchException

Opens a session and connects all of the tunnels.

Throws:

com.jcraft.jsch.JSchException - If unable to connect

reopen

public void reopen()
            throws com.jcraft.jsch.JSchException

Closes, and re-opens the session and all its tunnels. Effectively calls close() followed by a call to open().

Throws:

com.jcraft.jsch.JSchException - If unable to connect

getAsString

@Nonnull
 @Nonempty
public String getAsString()