com.helger.jsch.tunnel

Class TunnelConnectionManager

java.lang.Object

com.helger.jsch.tunnel.TunnelConnectionManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class TunnelConnectionManager
extends Object
implements Closeable

Manages a collection of tunnels. This implementation will:

• Ensure a minimum number of ssh connections are made
• Ensure all connections are open/closed at the same time
• Provide a convenient syntax for defining tunnels

Constructor Summary

Constructors

Constructor and Description
TunnelConnectionManager(ISessionFactory baseSessionFactory) Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections.
TunnelConnectionManager(ISessionFactory baseSessionFactory, Iterable<String> pathAndSpecList) Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.
TunnelConnectionManager(ISessionFactory baseSessionFactory, String... pathAndSpecList) Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all sessions and their associated tunnels.
void	ensureOpen() Will re-open any connections that are not still open.
Tunnel	getTunnel(String destinationHostname, int destinationPort) Returns the tunnel matching the supplied values, or null if there isn't one that matches.
void	open() Opens all the necessary sessions and connects all of the tunnels.
void	setTunnelConnections(Iterable<String> pathAndSpecList) Creates a set of tunnel connections based upon the pathAndTunnels.
void	setTunnelConnectionsFromFile(File tunnelsConfig, Charset aCharset) Creates a set of tunnel connections based upon the contents of tunnelsConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

TunnelConnectionManager

public TunnelConnectionManager(ISessionFactory baseSessionFactory)
                        throws com.jcraft.jsch.JSchException

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections. Because this constructor does not set the tunnel connections for you, you will need to call setTunnelConnections(Iterable).

Parameters:

baseSessionFactory - The session factory

Throws:

com.jcraft.jsch.JSchException - For connection failures

See Also:

setTunnelConnections(Iterable)

TunnelConnectionManager

public TunnelConnectionManager(ISessionFactory baseSessionFactory,
                               String... pathAndSpecList)
                        throws com.jcraft.jsch.JSchException

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.

Parameters:

baseSessionFactory - The session factory

pathAndSpecList - A list of path and spec strings

Throws:

com.jcraft.jsch.JSchException - For connection failures

See Also:

setTunnelConnections(Iterable)

TunnelConnectionManager

public TunnelConnectionManager(ISessionFactory baseSessionFactory,
                               Iterable<String> pathAndSpecList)
                        throws com.jcraft.jsch.JSchException

Creates a TunnelConnectionManager that will use the baseSessionFactory to obtain its session connections and provide the tunnels specified.

Parameters:

baseSessionFactory - The session factory

pathAndSpecList - A list of path and spec strings

Throws:

com.jcraft.jsch.JSchException - For connection failures

See Also:

setTunnelConnections(Iterable)

Method Detail

close

public void close()

Closes all sessions and their associated tunnels.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

See Also:

TunnelConnection.close()

ensureOpen

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

Will re-open any connections that are not still open.

Throws:

com.jcraft.jsch.JSchException - For connection failures

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

See Also:

TunnelConnection.getTunnel(String, int)

open

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

Opens all the necessary sessions and connects all of the tunnels.

Throws:

com.jcraft.jsch.JSchException - For connection failures

See Also:

TunnelConnection.open()

setTunnelConnectionsFromFile

public void setTunnelConnectionsFromFile(File tunnelsConfig,
                                         @Nonnull
                                         Charset aCharset)
                                  throws IOException,
                                         com.jcraft.jsch.JSchException

Creates a set of tunnel connections based upon the contents of tunnelsConfig. The format of this file is one path and tunnel per line. Comments and empty lines are allowed and are excluded using the pattern ^\s*(?:#.*)?$.

Parameters:

tunnelsConfig - A file containing tunnel configuration

aCharset - Charset to use. May not be null.

Throws:

IOException - If unable to read from tunnelsConfig

com.jcraft.jsch.JSchException - For connection failures

setTunnelConnections

public void setTunnelConnections(Iterable<String> pathAndSpecList)
                          throws com.jcraft.jsch.JSchException

Creates a set of tunnel connections based upon the pathAndTunnels. Each entry of pathAndTunnels must be of the form (in EBNF):

 path and tunnels = path and tunnel, {new line, path and tunnel}
 path and tunnel = path, "|", tunnel
 new line = "\n"
 path = path part, {"->", path part}
 path part = {user, "@"}, hostname
 tunnel = {local part}, ":", destination hostname, ":", destination port
 local part = {local alias, ":"}, local port
 local alias = hostname
 local port = port
 destination hostname = hostname
 destination port = port
 user = ? user name ?
 hostname = ? hostname ?
 port = ? port ?
 

For example:

jimhenson@admin.muppets.com->animal@drteethandtheelectricmahem.muppets.com|drteeth:8080:drteeth.muppets.com:80

Says open an ssh connection as user jimhenson to host admin.muppets.com. Then, through that connection, open a connection as user animal to host drteethandtheelectricmahem.muppets.com. Then map local port 8080 on the interface with alias drteeth through the two-hop tunnel to port 80 on drteeth.muppets.com.

Parameters:

pathAndSpecList - A list of path and spec entries

Throws:

com.jcraft.jsch.JSchException - For connection failures