oracle.jdeveloper.db.ssh

Class SSHTunnelConfiguration

java.lang.Object

oracle.jdeveloper.db.ssh.SSHTunnelConfiguration

public final class SSHTunnelConfiguration
extends java.lang.Object

Configuration for creating an SSH tunnel that a database connection can use to securely connect to a remote server.

Since:

12.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SSH_ENABLED Property used to identify whether SSH tunneling has been enabled for the given connection.
static java.lang.String	SSH_HOST The property name for the SSH hostname.
static java.lang.String	SSH_KEY_FILE The property name for the local ssh identity/key file to use for authentication.
static java.lang.String	SSH_PASSWORD The property name for the SSH password.
static java.lang.String	SSH_PORT The property name for the SSH port.
static java.lang.String	SSH_USE_PROXY Property used to identify whether a proxy should be used when creating the SSH tunnel.
static java.lang.String	SSH_USER The property name for the SSH username.

Constructor Summary

Constructors

Constructor and Description
SSHTunnelConfiguration(java.lang.String url, java.lang.String host, int[] hostOffsets, int port, int[] portOffsets) Creates a new tunnel configuration.

Method Summary

Modifier and Type	Method and Description
static SSHTunnelConfiguration	createFromMatcher(java.lang.String url, java.util.regex.Matcher m, int hostGroup, int portGroup) Creates a new SSHTunnelConfiguration from the given Matcher.
static SSHTunnelConfiguration	getConfiguration(DatabaseProvider pro) Gets the SSHTunnelConfiguration for the given DatabaseProvider.
java.lang.String	getLocalConnectionURL(SSHTunnel tunnel) Gets a local version of the URL given the local port/host information from the given tunnel.
java.lang.String	getRemoteHost() Gets the remote host (i.e.
int	getRemotePort() Gets the remote port (i.e.
static SSHTunnelConfiguration	parseAddressSyntax(java.lang.String url) Looks in the given URL for (host=...) and (port=...) and creates a tunnel config with the found host/port information.
static int	parsePort(java.lang.String port) Utility method to parses the given String as a port number.
static boolean	requiresTunnel(DatabaseProvider pro) Tests whether the connection details for the given database connection definition require an SSH tunnel to be open.

Methods inherited from class java.lang.Object

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

Field Detail

SSH_ENABLED

public static final java.lang.String SSH_ENABLED

Property used to identify whether SSH tunneling has been enabled for the given connection.

See Also:

Constant Field Values

SSH_USER

public static final java.lang.String SSH_USER

The property name for the SSH username.

See Also:

Constant Field Values

SSH_PASSWORD

public static final java.lang.String SSH_PASSWORD

The property name for the SSH password. If an identity key file is used this is used as the passphrase to that file, otherwise it is used for password authentication.

See Also:

Constant Field Values

SSH_HOST

public static final java.lang.String SSH_HOST

The property name for the SSH hostname.

See Also:

Constant Field Values

SSH_PORT

public static final java.lang.String SSH_PORT

The property name for the SSH port.

See Also:

Constant Field Values

SSH_KEY_FILE

public static final java.lang.String SSH_KEY_FILE

The property name for the local ssh identity/key file to use for authentication.

See Also:

Constant Field Values

SSH_USE_PROXY

public static final java.lang.String SSH_USE_PROXY

Property used to identify whether a proxy should be used when creating the SSH tunnel. The proxy settings are defined globally in the FCP preferences.

See Also:

Constant Field Values

Constructor Detail

SSHTunnelConfiguration

public SSHTunnelConfiguration(java.lang.String url,
                              java.lang.String host,
                              int[] hostOffsets,
                              int port,
                              int[] portOffsets)

Creates a new tunnel configuration.

Parameters:

url - the original JDBC url containing the remote hostname and port details (i.e. the host/port that the tunnel should forward to via the ssh host/port).

host - the remote hostname

hostOffsets - the start/end offset of the remote hostname in the url

port - the remote port

portOffsets - the start/end offset of the remote port in the url

Method Detail

getRemoteHost

public java.lang.String getRemoteHost()

Gets the remote host (i.e. the one in the original connection URL).

Returns:

the remote host.

getRemotePort

public int getRemotePort()

Gets the remote port (i.e. the one in the original connection URL).

Returns:

the remote port.

getLocalConnectionURL

public java.lang.String getLocalConnectionURL(SSHTunnel tunnel)

Gets a local version of the URL given the local port/host information from the given tunnel.

Parameters:

tunnel - the tunnel to get the url for

Returns:

a local version of the connection URL that will connect via the tunnel.

parsePort

public static int parsePort(java.lang.String port)
                     throws SSHTunnelException

Utility method to parses the given String as a port number.

Parameters:

port - the port as a String

Returns:

the port as an int

Throws:

SSHTunnelException - if the String doesn't contain a valid port number.

createFromMatcher

public static SSHTunnelConfiguration createFromMatcher(java.lang.String url,
                                                       java.util.regex.Matcher m,
                                                       int hostGroup,
                                                       int portGroup)
                                                throws SSHTunnelException

Creates a new SSHTunnelConfiguration from the given Matcher. Note the zeroth group is always the entire expression.

Parameters:

url - the base connection URL

m - the matcher that has matched the URL and has groups for the host and port

hostGroup - the host group

portGroup - the port group

Returns:

the new tunnel configration

Throws:

SSHTunnelException

parseAddressSyntax

public static SSHTunnelConfiguration parseAddressSyntax(java.lang.String url)
                                                 throws SSHTunnelException

Looks in the given URL for (host=...) and (port=...) and creates a tunnel config with the found host/port information. Is case insensitive and allows whitespace within the syntax.

Parameters:

url - the url to parse for description syntax

Returns:

a tunnel configuration with the found host/port information

Throws:

SSHTunnelException - if the URL doesn't match, or if multiple host/port information is found.

getConfiguration

public static SSHTunnelConfiguration getConfiguration(DatabaseProvider pro)
                                               throws java.sql.SQLException

Gets the SSHTunnelConfiguration for the given DatabaseProvider.

Parameters:

pro - the connection details to get the tunnel configuration for

Returns:

the configuration

Throws:

java.sql.SQLException

requiresTunnel

public static final boolean requiresTunnel(DatabaseProvider pro)

Tests whether the connection details for the given database connection definition require an SSH tunnel to be open.

Parameters:

pro - the database connection definition

Returns:

true if the connection is configured to use an SSH tunnel