oracle.jdeveloper.db.ssh

Class SSHTunnelManager

java.lang.Object

oracle.jdeveloper.db.ssh.SSHTunnelManager

public abstract class SSHTunnelManager
extends java.lang.Object

Manager of SSH tunnels for database connections. Used to open/close tunnels for a given configuration. A manager may not be available in a given product or environment.

Since:

12.2.1

Constructor Summary

Constructors

Constructor and Description
SSHTunnelManager()

Method Summary

Modifier and Type	Method and Description
static SSHTunnelManager	getInstance() Gets the SSHTunnelManager instance, if it is available.
boolean	isAvailable() Tests whether the SSHManager is available (i.e.
abstract SSHTunnel	openTunnel(DatabaseProvider pro) Ensures that a tunnel with the given configuration is open and returns the local port the tunnel is listening on.
static void	setInstance(SSHTunnelManager mgr) Sets the SSHTunnelManager instance that should be used for all database connections that require an ssh tunnel to connect via.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHTunnelManager

public SSHTunnelManager()

Method Detail

openTunnel

public abstract SSHTunnel openTunnel(DatabaseProvider pro)
                              throws java.sql.SQLException

Ensures that a tunnel with the given configuration is open and returns the local port the tunnel is listening on.

Parameters:

config - the tunnel configuration

Returns:

the local port that the tunnel is listening on

Throws:

SSHTunnelException - if the tunnel could not be found (or opened)

java.sql.SQLException

isAvailable

public boolean isAvailable()

Tests whether the SSHManager is available (i.e. that it can open tunnels). If this returns false for the active SSHTunnelManager then getInstance() will return null.

Returns:

true if ssh tunnels are available.

getInstance

public static SSHTunnelManager getInstance()

Gets the SSHTunnelManager instance, if it is available.

Returns:

the tunnel manager, or null if no tunnel manager is available.

setInstance

public static void setInstance(SSHTunnelManager mgr)

Sets the SSHTunnelManager instance that should be used for all database connections that require an ssh tunnel to connect via.

Parameters:

the - tunnel manager